1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

//! Perlin is a free and open source information retrieval library.
//!
//! Version 0.1.0
//!
//! # Features
//! * boolean retrieval on arbitrary types
//! * minimal dependencies
//! * lazy and zero-allocation query evaluation
//! 
//! # Basic Usage
//!
//! Add Perlin to Cargo.toml
//!
//! ```toml
//! [dependencies]
//! perlin = "0.1"
//! ```
//!
//! and import it in your crate root:
//!
//! ```rust
//! extern crate perlin;
//! ```
//!
//!
//! ## Build index and run queries
//! ```rust
//! use perlin::index::Index;
//! use perlin::storage::RamStorage;
//! use perlin::index::boolean_index::{QueryBuilder, IndexBuilder};
//!
//! //Use `IndexBuilder` to construct a new Index and add documents to it.
//! //Perlin does not dictate what "documents" are.
//! //Rather it expects iterators over iterators over terms.
//! //In our case a "document" consists of a series of `usize` values:
//! let index = IndexBuilder::<_, RamStorage<_>>::new().create(vec![(0..10),
//! (0..15), (10..34)].into_iter()).unwrap();
//!
//! //Now use the `QueryBuilder` to construct a query
//! //Simple query for the number 4
//! let simple_query = QueryBuilder::atom(4).build();
//!
//! //When executing queries the index does not evaluate return all results at once.
//! //Rather it runs lazily and returns an iterator over the resulting document ids.
//! for id in index.execute_query(&simple_query) {
//!    println!("{}", id); //Will print 0 and 1
//! }
//!
//! ```
//!
//! Have a look in the [examples folder](https://github.com/JDemler/perlin/tree/master/examples) for more
//! elaborate examples!
//! 
//!
#![deny(missing_docs, warnings)]

#[macro_use]
mod utils;
pub mod language;
pub mod index;
pub mod storage;