yuca

YUCA v0.1.1

YUCA: Uma biblioteca de mecanismo de pesquisa leve, de memória, rápida e simples de usar.

Se o seu aplicativo não puder lidar ou não precisar de instalar um mecanismo de pesquisa completo e pesado como Lucene, nem você deseja depender de um banco de dados SQL para indexação e fazer seqüências simples baseadas em pesquisa, você pode usar a YUCA para indexar documentos sob qualquer número de teclas arbitrárias que podem ser agrupadas sob tags.

Atualmente, a biblioteca compartilhada pesa ~ 170kb sem otimizações de embalagem, esperamos reduzir ainda mais o tamanho em um futuro próximo.

PRÉDIO

Requisitos:

• cmake 3.8, faça
• Compilador C ++ 11 (Clang recomendado)

Instruções:

Na primeira vez, crie seu makefile com cmake

 $ cmake .

Então, depois disso, basta construir

 $ make -j 8

As bibliotecas compartilhadas e estáticas estarão disponíveis na pasta raiz do projeto, bem como nos executáveis yuca_demo_shared e yuca_demo_static que você pode usar para testar que tudo foi compilado e vinculado corretamente com as bibliotecas compartilhadas e dinâmicas.

Há também um executável yuca_tests , caso você queira garantir que todos os testes de unidade estejam passando.

Building Java (Swig/JNI) invólucro

A pasta swig segura scripts SWIG e invólucros de alto nível para usar a YUCA de outras linguagens de programação, sendo o primeiro java .

A intenção atual é fazer com que o swig/build.sh seja um processo de construção de uma etapa para criar ligações para outros idiomas.

Por enquanto, é um script muito difícil que criará ligações Java, atualmente suporta ligações para Java no macOS, já que ainda estamos no início do desenvolvimento das ligações. A longo prazo, as opções serão passadas para construir.sh para vinculares de saída para o idioma e a arquitetura de sua escolha.

Para construir jni bingings, o FIST certifique -se de ter construído a biblioteca C ++, conforme explicado na seção de instruções de construção anterior e depois:

 $ cd swig
$ ./build.sh

Isso produzirá o código C ++ JNI criado programaticamente e o código Java para acessar os invólucros nativos do JNI dentro de uma pasta swig/java . Document , temos Indexer pacote Java SearchResult StringKey o programador SearchRequest Friendly com.guacal.yuca.*

Debug Build

Se você deseja construir bibliotecas com símbolos de depuração, edite CMakeLists.txt e descomment a configuração 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)

Você terá que executar cmake . Novamente, faça uma make clean e reconstrução com make -j 8

Feedback e patches bem -vindos

Por favor, abra um problema no rastreador de problemas do GitHub se você tiver algum problema, idéias. Se você tiver vontade de se estender ou corrigir, abra um problema primeiro para não perder seu tempo codificando algo que pode não ser aceito por um bom motivo.

Não suportado por agora

• Serialização do índice. Por enquanto, o índice deve ser usado apenas na memória. Terá que pensar profundamente em como fazer isso de maneira incremental/decremental, para que a serialização seja ideal e não precisamos salvar todo o índice sempre. Não é uma prioridade neste momento.

Metas de distribuição binária da biblioteca:

• Biblioteca estática: Yuca.lib (Windows X64), Yuca.A (Linux X64, Mac X64)
• Biblioteca compartilhada: yuca.dll (Windows x64), yuca.so (Linux X64, Android Arm, Android Arm64), Yuca.dylib (Mac X64)

Metas de compatibilidade de ligação à biblioteca:

• JNI/Java SE Bindings, Yuca.jar (Windows X64, Linux X64, Mac X64)
• Jni/Android Bindings, YUCA.JAR (ARM, ARM64)
• Javascript/NodeJS ligações
• Python Bindings
• Vá ligações
• PHP ligações

Este projeto está disponível sob a licença do MIT, divulgada publicamente, quarta -feira. 9 de maio de 2018