Release: Initial benchmarks compared to other implementations in other languages (#13)

Author: PyDataBlog

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "simstring_rust"
-version = "0.1.1"
+version = "0.1.2"
 description = "A native Rust implementation of the SimString algorithm"
 license = "MIT"
 repository = "https://github.com/PyDataBlog/simstring_rs"

Cargo.toml

@@ -0,0 +1,18 @@
+FROM ubuntu:24.04
+
+WORKDIR /app
+
+RUN apt-get update && \
+  apt-get install -y software-properties-common && \
+  add-apt-repository universe && \
+  apt-get update && \
+  apt-get install -y build-essential simstring-bin time && \
+  rm -rf /var/lib/apt/lists/*
+
+COPY benches/data/company_names.txt /app/data/company_names.txt
+
+COPY benches/bench_cpp.sh /app/benchmark.sh
+
+RUN chmod +x /app/benchmark.sh
+
+ENTRYPOINT ["/app/benchmark.sh"]

Dockerfile

@@ -48,7 +48,35 @@ To revert to a stable version, ensure your Cargo.toml specifies a specific versi
 Here is a basic example of how to use simstring_rs in your Rust project:
 
 ```Rust
-
+use simstring_rust::database::HashDB;
+use simstring_rust::extractors::CharacterNGrams;
+use simstring_rust::measures::Cosine;
+
+fn main() {
+    let feature_extractor = CharacterNGrams {
+        n: 2,
+        padder: " ".to_string(),
+    };
+    let measure = Cosine::new();
+    let mut db = HashDB::new(feature_extractor, measure);
+
+    db.insert("hello".to_string());
+    db.insert("help".to_string());
+    db.insert("halo".to_string());
+    db.insert("world".to_string());
+
+    let threshold = 0.5;
+    let results = db.search("hell", threshold);
+
+    if results.is_empty() {
+        println!("No results found with threshold {}", threshold);
+    } else {
+        println!("Results with threshold {}:", threshold);
+        for result in results {
+            println!("Match: '{}' (score: {})", result.value, result.score);
+        }
+    }
+}
 ```
 
 ## Contributing