fix(strings): fix doctests

zama-ai · Oct 23, 2024 · ecd0212 · ecd0212
1 parent d17263c
commit ecd0212
Show file tree

Hide file tree

Showing 9 changed files with 136 additions and 136 deletions.
diff --git a/tfhe/src/high_level_api/strings/server_key/comp.rs b/tfhe/src/high_level_api/strings/server_key/comp.rs
@@ -55,14 +55,14 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::{FheString, GenericPattern};
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::{FheString, GenericPattern};
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let (s1, s2) = ("hello", "hello");
     ///
-    /// let enc_s1 = FheString::new(&ck, &s1, None);
-    /// let enc_s2 = GenericPattern::Enc(FheString::new(&ck, &s2, None));
+    /// let enc_s1 = FheString::new(&ck, s1, None);
+    /// let enc_s2 = GenericPattern::Enc(FheString::new(&ck, s2, None));
     ///
     /// let result = sk.eq(&enc_s1, &enc_s2);
     /// let are_equal = ck.key().decrypt_bool(&result);
@@ -109,14 +109,14 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::{FheString, GenericPattern};
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::{FheString, GenericPattern};
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let (s1, s2) = ("hello", "world");
     ///
-    /// let enc_s1 = FheString::new(&ck, &s1, None);
-    /// let enc_s2 = GenericPattern::Enc(FheString::new(&ck, &s2, None));
+    /// let enc_s1 = FheString::new(&ck, s1, None);
+    /// let enc_s2 = GenericPattern::Enc(FheString::new(&ck, s2, None));
     ///
     /// let result = sk.ne(&enc_s1, &enc_s2);
     /// let are_not_equal = ck.key().decrypt_bool(&result);
@@ -136,14 +136,14 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::FheString;
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::FheString;
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let (s1, s2) = ("apple", "banana");
     ///
-    /// let enc_s1 = FheString::new(&ck, &s1, None);
-    /// let enc_s2 = FheString::new(&ck, &s2, None);
+    /// let enc_s1 = FheString::new(&ck, s1, None);
+    /// let enc_s2 = FheString::new(&ck, s2, None);
     ///
     /// let result = sk.lt(&enc_s1, &enc_s2);
     /// let is_lt = ck.key().decrypt_bool(&result);
@@ -166,14 +166,14 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::FheString;
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::FheString;
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let (s1, s2) = ("banana", "apple");
     ///
-    /// let enc_s1 = FheString::new(&ck, &s1, None);
-    /// let enc_s2 = FheString::new(&ck, &s2, None);
+    /// let enc_s1 = FheString::new(&ck, s1, None);
+    /// let enc_s2 = FheString::new(&ck, s2, None);
     ///
     /// let result = sk.gt(&enc_s1, &enc_s2);
     /// let is_gt = ck.key().decrypt_bool(&result);
@@ -197,14 +197,14 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::FheString;
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::FheString;
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let (s1, s2) = ("apple", "banana");
     ///
-    /// let enc_s1 = FheString::new(&ck, &s1, None);
-    /// let enc_s2 = FheString::new(&ck, &s2, None);
+    /// let enc_s1 = FheString::new(&ck, s1, None);
+    /// let enc_s2 = FheString::new(&ck, s2, None);
     ///
     /// let result = sk.le(&enc_s1, &enc_s2);
     /// let is_le = ck.key().decrypt_bool(&result);
@@ -228,14 +228,14 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::FheString;
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::FheString;
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let (s1, s2) = ("banana", "apple");
     ///
-    /// let enc_s1 = FheString::new(&ck, &s1, None);
-    /// let enc_s2 = FheString::new(&ck, &s2, None);
+    /// let enc_s1 = FheString::new(&ck, s1, None);
+    /// let enc_s2 = FheString::new(&ck, s2, None);
     ///
     /// let result = sk.ge(&enc_s1, &enc_s2);
     /// let is_ge = ck.key().decrypt_bool(&result);

diff --git a/tfhe/src/high_level_api/strings/server_key/no_patterns.rs b/tfhe/src/high_level_api/strings/server_key/no_patterns.rs
@@ -13,15 +13,15 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::FheString;
-    /// use crate::high_level_api::strings::server_key::{gen_keys, FheStringLen};
+    /// use tfhe::strings::ciphertext::FheString;
+    /// use tfhe::strings::server_key::{gen_keys, FheStringLen};
     ///
     /// let (ck, sk) = gen_keys();
     /// let s = "hello";
     /// let number_of_nulls = 3;
     ///
-    /// let enc_s_no_padding = FheString::new(&ck, &s, None);
-    /// let enc_s_with_padding = FheString::new(&ck, &s, Some(number_of_nulls));
+    /// let enc_s_no_padding = FheString::new(&ck, s, None);
+    /// let enc_s_with_padding = FheString::new(&ck, s, Some(number_of_nulls));
     ///
     /// let result_no_padding = sk.len(&enc_s_no_padding);
     /// let result_with_padding = sk.len(&enc_s_with_padding);
@@ -72,15 +72,15 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::FheString;
-    /// use crate::high_level_api::strings::server_key::{gen_keys, FheStringIsEmpty};
+    /// use tfhe::strings::ciphertext::FheString;
+    /// use tfhe::strings::server_key::{gen_keys, FheStringIsEmpty};
     ///
     /// let (ck, sk) = gen_keys();
     /// let s = "";
     /// let number_of_nulls = 2;
     ///
-    /// let enc_s_no_padding = FheString::new(&ck, &s, None);
-    /// let enc_s_with_padding = FheString::new(&ck, &s, Some(number_of_nulls));
+    /// let enc_s_no_padding = FheString::new(&ck, s, None);
+    /// let enc_s_with_padding = FheString::new(&ck, s, Some(number_of_nulls));
     ///
     /// let result_no_padding = sk.is_empty(&enc_s_no_padding);
     /// let result_with_padding = sk.is_empty(&enc_s_with_padding);
@@ -119,13 +119,13 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::FheString;
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::FheString;
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let s = "Hello World";
     ///
-    /// let enc_s = FheString::new(&ck, &s, None);
+    /// let enc_s = FheString::new(&ck, s, None);
     ///
     /// let result = sk.to_uppercase(&enc_s);
     /// let uppercased = ck.decrypt_ascii(&result);
@@ -172,13 +172,13 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::FheString;
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::FheString;
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let s = "Hello World";
     ///
-    /// let enc_s = FheString::new(&ck, &s, None);
+    /// let enc_s = FheString::new(&ck, s, None);
     ///
     /// let result = sk.to_lowercase(&enc_s);
     /// let lowercased = ck.decrypt_ascii(&result);
@@ -231,14 +231,14 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::{FheString, GenericPattern};
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::{FheString, GenericPattern};
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let (s1, s2) = ("Hello", "hello");
     ///
-    /// let enc_s1 = FheString::new(&ck, &s1, None);
-    /// let enc_s2 = GenericPattern::Enc(FheString::new(&ck, &s2, None));
+    /// let enc_s1 = FheString::new(&ck, s1, None);
+    /// let enc_s2 = GenericPattern::Enc(FheString::new(&ck, s2, None));
     ///
     /// let result = sk.eq_ignore_case(&enc_s1, &enc_s2);
     /// let are_equal = ck.key().decrypt_bool(&result);
@@ -266,14 +266,14 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::FheString;
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::FheString;
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let (lhs, rhs) = ("Hello, ", "world!");
     ///
-    /// let enc_lhs = FheString::new(&ck, &lhs, None);
-    /// let enc_rhs = FheString::new(&ck, &rhs, None);
+    /// let enc_lhs = FheString::new(&ck, lhs, None);
+    /// let enc_rhs = FheString::new(&ck, rhs, None);
     ///
     /// let result = sk.concat(&enc_lhs, &enc_rhs);
     /// let concatenated = ck.decrypt_ascii(&result);
@@ -317,13 +317,13 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::{FheString, UIntArg};
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::{FheString, UIntArg};
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let s = "hi";
     ///
-    /// let enc_s = FheString::new(&ck, &s, None);
+    /// let enc_s = FheString::new(&ck, s, None);
     ///
     /// // Using Clear count
     /// let clear_count = UIntArg::Clear(3);

diff --git a/tfhe/src/high_level_api/strings/server_key/pattern/contains.rs b/tfhe/src/high_level_api/strings/server_key/pattern/contains.rs
@@ -84,14 +84,14 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::{ClearString, FheString, GenericPattern};
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::{ClearString, FheString, GenericPattern};
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let (bananas, nana, apples) = ("bananas", "nana", "apples");
     ///
-    /// let enc_bananas = FheString::new(&ck, &bananas, None);
-    /// let enc_nana = GenericPattern::Enc(FheString::new(&ck, &nana, None));
+    /// let enc_bananas = FheString::new(&ck, bananas, None);
+    /// let enc_nana = GenericPattern::Enc(FheString::new(&ck, nana, None));
     /// let clear_apples = GenericPattern::Clear(ClearString::new(apples.to_string()));
     ///
     /// let result1 = sk.contains(&enc_bananas, &enc_nana);
@@ -143,14 +143,14 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::{ClearString, FheString, GenericPattern};
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::{ClearString, FheString, GenericPattern};
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let (bananas, ba, nan) = ("bananas", "ba", "nan");
     ///
-    /// let enc_bananas = FheString::new(&ck, &bananas, None);
-    /// let enc_ba = GenericPattern::Enc(FheString::new(&ck, &ba, None));
+    /// let enc_bananas = FheString::new(&ck, bananas, None);
+    /// let enc_ba = GenericPattern::Enc(FheString::new(&ck, ba, None));
     /// let clear_nan = GenericPattern::Clear(ClearString::new(nan.to_string()));
     ///
     /// let result1 = sk.starts_with(&enc_bananas, &enc_ba);
@@ -215,14 +215,14 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::{ClearString, FheString, GenericPattern};
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::{ClearString, FheString, GenericPattern};
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let (bananas, anas, nana) = ("bananas", "anas", "nana");
     ///
-    /// let enc_bananas = FheString::new(&ck, &bananas, None);
-    /// let enc_anas = GenericPattern::Enc(FheString::new(&ck, &anas, None));
+    /// let enc_bananas = FheString::new(&ck, bananas, None);
+    /// let enc_anas = GenericPattern::Enc(FheString::new(&ck, anas, None));
     /// let clear_nana = GenericPattern::Clear(ClearString::new(nana.to_string()));
     ///
     /// let result1 = sk.ends_with(&enc_bananas, &enc_anas);

diff --git a/tfhe/src/high_level_api/strings/server_key/pattern/find.rs b/tfhe/src/high_level_api/strings/server_key/pattern/find.rs
@@ -108,14 +108,14 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::{FheString, GenericPattern};
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::{FheString, GenericPattern};
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let (haystack, needle) = ("hello world", "world");
     ///
-    /// let enc_haystack = FheString::new(&ck, &haystack, None);
-    /// let enc_needle = GenericPattern::Enc(FheString::new(&ck, &needle, None));
+    /// let enc_haystack = FheString::new(&ck, haystack, None);
+    /// let enc_needle = GenericPattern::Enc(FheString::new(&ck, needle, None));
     ///
     /// let (index, found) = sk.find(&enc_haystack, &enc_needle);
     ///
@@ -176,14 +176,14 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::{FheString, GenericPattern};
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::{FheString, GenericPattern};
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let (haystack, needle) = ("hello world world", "world");
     ///
-    /// let enc_haystack = FheString::new(&ck, &haystack, None);
-    /// let enc_needle = GenericPattern::Enc(FheString::new(&ck, &needle, None));
+    /// let enc_haystack = FheString::new(&ck, haystack, None);
+    /// let enc_needle = GenericPattern::Enc(FheString::new(&ck, needle, None));
     ///
     /// let (index, found) = sk.rfind(&enc_haystack, &enc_needle);
     ///

diff --git a/tfhe/src/high_level_api/strings/server_key/pattern/replace.rs b/tfhe/src/high_level_api/strings/server_key/pattern/replace.rs
@@ -214,15 +214,15 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::{FheString, GenericPattern, UIntArg};
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::{FheString, GenericPattern, UIntArg};
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let (s, from, to) = ("hello", "l", "r");
     ///
-    /// let enc_s = FheString::new(&ck, &s, None);
-    /// let enc_from = GenericPattern::Enc(FheString::new(&ck, &from, None));
-    /// let enc_to = FheString::new(&ck, &to, None);
+    /// let enc_s = FheString::new(&ck, s, None);
+    /// let enc_from = GenericPattern::Enc(FheString::new(&ck, from, None));
+    /// let enc_to = FheString::new(&ck, to, None);
     ///
     /// // Using Clear count
     /// let clear_count = UIntArg::Clear(1);
@@ -339,15 +339,15 @@ impl ServerKey {
     /// # Examples
     ///
     /// ```rust
-    /// use crate::high_level_api::strings::ciphertext::{ClearString, FheString, GenericPattern};
-    /// use crate::high_level_api::strings::server_key::gen_keys;
+    /// use tfhe::strings::ciphertext::{ClearString, FheString, GenericPattern};
+    /// use tfhe::strings::server_key::gen_keys;
     ///
     /// let (ck, sk) = gen_keys();
     /// let (s, from, to) = ("hi", "i", "o");
     ///
-    /// let enc_s = FheString::new(&ck, &s, None);
-    /// let enc_from = GenericPattern::Enc(FheString::new(&ck, &from, None));
-    /// let enc_to = FheString::new(&ck, &to, None);
+    /// let enc_s = FheString::new(&ck, s, None);
+    /// let enc_from = GenericPattern::Enc(FheString::new(&ck, from, None));
+    /// let enc_to = FheString::new(&ck, to, None);
     ///
     /// let result = sk.replace(&enc_s, &enc_from, &enc_to);
     /// let replaced = ck.decrypt_ascii(&result);