Merge 8fd30ac into 550d601

.gitignore

@@ -1,2 +1,3 @@
 /target
-Cargo.lock
+Cargo.lock
+*.bak

README.md

@@ -40,9 +40,8 @@ See [recipe search demo project](https://github.com/quantleaf/probly-search-demo
 ```rust
 use std::collections::HashSet;
 use probly_search::{
-    index::{add_document_to_index, create_index, remove_document_from_index, Index},
+    index::Index,
     query::{
-        query,
         score::default::{bm25, zero_to_one},
         QueryResult,
     },
@@ -70,9 +69,8 @@ fn filter(s: &str) -> &str {
    s
 }
 
-
 // Create index with 2 fields
-let mut index = create_index::<usize>(2);
+let mut index = Index::<usize>::new(2);
 
 // Create docs from a custom Doc struct
 let doc_1 = Doc {
@@ -88,17 +86,15 @@ let doc_2 = Doc {
 };
 
 // Add documents to index
-add_document_to_index(
-    &mut index,
+index.add_document(
     &[title_extract, description_extract],
     tokenizer,
     filter,
     doc_1.id,
     &doc_1,
 );
 
-add_document_to_index(
-    &mut index,
+index.add_document(
     &[title_extract, description_extract],
     tokenizer,
     filter,
@@ -107,8 +103,7 @@ add_document_to_index(
 );
 
 // Search, expected 2 results
-let mut result = query(
-    &mut index,
+let mut result = index.query(
     &"abc",
     &mut bm25::new(),
     tokenizer,
@@ -134,14 +129,13 @@ assert_eq!(
 
 // Remove documents from index
 let mut removed_docs = HashSet::new();
-remove_document_from_index(&mut index, &mut removed_docs, doc_1.id);
+index.remove_document(&mut removed_docs, doc_1.id);
 
 // Vacuum to remove completely
-vacuum_index(&mut index, &mut removed_docs);
+index.vacuum(&mut removed_docs);
 
 // Search, expect 1 result
-result = query(
-    &mut index,
+result = index.query(
     &"abc",
     &mut bm25::new(),
     tokenizer,

benches/test_benchmark.rs

@@ -1,5 +1,5 @@
 use criterion::{criterion_group, criterion_main, Criterion};
-use probly_search::index::{add_document_to_index, create_index_with_capacity, Index};
+use probly_search::Index;
 
 criterion_group!(benches, test_speed);
 criterion_main!(benches);
@@ -37,7 +37,7 @@ pub fn test_speed(c: &mut Criterion) {
     }
 
     c.bench_function("add_100k_docs", |b| {
-        let mut index = create_index_with_capacity(1, 100000, 100000);
+        let mut index = Index::<usize>::new_with_capacity(1, 100000, 100000);
         let mut random_strings: Vec<String> = Vec::new();
         for _ in 1..100000 {
             let mut new_rand = generate_string(0, 4);
@@ -51,7 +51,7 @@ pub fn test_speed(c: &mut Criterion) {
 }
 
 fn add_all_documents(
-    mut index: &mut Index<usize>,
+    index: &mut Index<usize>,
     extractor: &[fn(&DocX) -> Option<&str>],
     random_strings: &[String],
 ) {
@@ -60,6 +60,6 @@ fn add_all_documents(
             id: i,
             title: s.to_owned(),
         };
-        add_document_to_index(&mut index, extractor, tokenizer, filter, d.id, &d);
+        index.add_document(extractor, tokenizer, filter, d.id, &d);
     }
 }