yuca

Yuca V0.1.1

YUCA: Perpustakaan ringan, dalam memori, cepat dan mudah digunakan untuk menggunakan pustaka mesin pencari.

Jika aplikasi Anda tidak dapat menangani atau tidak benar -benar perlu menginstal mesin pencari unggulan dan berat seperti Lucene, atau Anda ingin bergantung pada database SQL untuk pengindeksan dan melakukan string berbasis pencarian sederhana, Anda dapat menggunakan YUCA untuk mengindeks dokumen di bawah sejumlah kunci sewenang -wenang yang dapat dikelompokkan di bawah tag.

Perpustakaan bersama saat ini memiliki berat ~ 170kb tanpa optimasi pengemasan, kami berharap dapat mengurangi ukuran lebih jauh dalam waktu dekat.

BANGUNAN

Persyaratan:

• cmake 3.8, buat
• C ++ 11 Compiler (Dikan Dorong Direkomendasikan)

Instruksi:

Pertama kali, buat makefile Anda dengan cmake

 $ cmake .

Kemudian setelah itu hanya membangun

 $ make -j 8

Perpustakaan yang dibagikan dan statis akan tersedia di folder root proyek, serta yuca_demo_shared dan yuca_demo_static Executable yang dapat Anda gunakan untuk menguji bahwa semuanya telah disusun dan ditautkan dengan benar dengan perpustakaan yang dibagikan dan dinamis.

Ada juga yuca_tests yang dapat dieksekusi jika Anda ingin memastikan semua tes unit lulus.

Membangun Java (Swig/JNI) Pembungkus

Folder swig memegang skrip Swig dan pembungkus tingkat tinggi untuk menggunakan Yuca dari bahasa pemrograman lainnya, yang pertama adalah java .

Niat saat ini adalah untuk memiliki swig/build.sh menjadi proses pembangunan satu langkah untuk membuat binding untuk bahasa lain.

Untuk saat ini ini adalah skrip yang sangat kasar yang akan membuat binding java, saat ini mendukung binding untuk Java di macOS karena kita masih di awal pengembangan binding. Dalam jangka panjang, opsi akan diteruskan ke build.sh ke output binding untuk bahasa dan arsitektur pilihan Anda.

Untuk membangun JNI Bingings, FIST pastikan untuk membangun perpustakaan C ++ seperti yang dijelaskan di bagian instruksi build sebelumnya dan kemudian:

 $ cd swig
$ ./build.sh

Ini akan menghasilkan kode C ++ JNI dan kode JAVA untuk mengakses pembungkus asli JNI di dalam folder swig/java . Di sana kami memiliki paket Java yang merupakan Java Programmer Friendly com.guacal.yuca.* Di sana Anda akan menemukan kelas utama untuk menggunakan Yuca di Indexer aplikasi Java/Android Anda, Document , StringKey , SearchRequest , SearchResult .

Debug Build

Jika Anda ingin membangun perpustakaan dengan simbol debug Edit CMakeLists.txt dan uncomment pengaturan CMAKE_BUILD_TYPE ,

 # If you need step by step debugging, uncomment below,
# or invoke `cmake -DCMAKE_BUILD_TYPE=Debug .` in the command line
#set(CMAKE_BUILD_TYPE Debug)

Anda harus menjalankan cmake . Sekali lagi, lakukan make clean dan rebuild dengan make -j 8

Umpan Balik dan Patch Selamat Datang

Harap buka masalah pada pelacak masalah GitHub jika Anda memiliki masalah, ide. Jika Anda merasa ingin memperluas atau menambal, buka masalah terlebih dahulu sehingga Anda tidak membuang waktu untuk mengkodekan sesuatu yang mungkin tidak diterima karena alasan yang baik.

Tidak didukung untuk saat ini

• Serialisasi Indeks. Untuk saat ini indeks hanya dimaksudkan untuk digunakan dalam memori. Harus sangat memikirkan bagaimana melakukan hal ini secara bertahap/penurunan sehingga serialisasi optimal dan kita tidak harus menyimpan seluruh indeks setiap saat. Bukan prioritas saat ini.

Tujuan Distribusi Biner Perpustakaan:

• Perpustakaan Statis: Yuca.lib (Windows X64), Yuca.A (Linux X64, Mac X64)
• Perpustakaan Bersama: Yuca.dll (Windows X64), Yuca.so (Linux X64, Android Arm, Android ARM64), yuca.dylib (Mac x64)

Tujuan Kompatibilitas Perpustakaan Mengikat:

• JNI/Java SE Bindings, Yuca.jar (Windows X64, Linux X64, Mac X64)
• Binding JNI/Android, Yuca.jar (ARM, ARM64)
• Binding JavaScript/NodeJS
• Binding Python
• Pergi binding
• Binding PHP

Proyek ini tersedia di bawah lisensi MIT, dirilis secara publik Rabu. 9 Mei 2018