Hide WordSimilarityResult fields

Among other things, this avoids breaking the API when we update
ordered_float.

Author: danieldk

src/compat/fasttext/io.rs

@@ -621,24 +621,24 @@ mod tests {
     fn test_read_fasttext() {
         let embeddings = read_fasttext();
         let results = embeddings.word_similarity("über", 3).unwrap();
-        assert_eq!(results[0].word, "auf");
-        assert_abs_diff_eq!(*results[0].similarity, 0.568513, epsilon = 1e-6);
-        assert_eq!(results[1].word, "vor");
-        assert_abs_diff_eq!(*results[1].similarity, 0.551551, epsilon = 1e-6);
-        assert_eq!(results[2].word, "durch");
-        assert_abs_diff_eq!(*results[2].similarity, 0.547349, epsilon = 1e-6);
+        assert_eq!(results[0].word(), "auf");
+        assert_abs_diff_eq!(results[0].cosine_similarity(), 0.568513, epsilon = 1e-6);
+        assert_eq!(results[1].word(), "vor");
+        assert_abs_diff_eq!(results[1].cosine_similarity(), 0.551551, epsilon = 1e-6);
+        assert_eq!(results[2].word(), "durch");
+        assert_abs_diff_eq!(results[2].cosine_similarity(), 0.547349, epsilon = 1e-6);
     }
 
     #[test]
     fn test_read_fasttext_unknown() {
         let embeddings = read_fasttext();
         let results = embeddings.word_similarity("unknown", 3).unwrap();
-        assert_eq!(results[0].word, "einer");
-        assert_abs_diff_eq!(*results[0].similarity, 0.691177, epsilon = 1e-6);
-        assert_eq!(results[1].word, "und");
-        assert_abs_diff_eq!(*results[1].similarity, 0.576449, epsilon = 1e-6);
-        assert_eq!(results[2].word, "des");
-        assert_abs_diff_eq!(*results[2].similarity, 0.570398, epsilon = 1e-6);
+        assert_eq!(results[0].word(), "einer");
+        assert_abs_diff_eq!(results[0].cosine_similarity(), 0.691177, epsilon = 1e-6);
+        assert_eq!(results[1].word(), "und");
+        assert_abs_diff_eq!(results[1].cosine_similarity(), 0.576449, epsilon = 1e-6);
+        assert_eq!(results[2].word(), "des");
+        assert_abs_diff_eq!(results[2].cosine_similarity(), 0.570398, epsilon = 1e-6);
     }
 
     #[test]

src/similarity.rs

@@ -18,8 +18,8 @@ use crate::util::l2_normalize;
 /// its similarity to a query word.
 #[derive(Debug, Eq, PartialEq)]
 pub struct WordSimilarityResult<'a> {
-    pub similarity: NotNan<f32>,
-    pub word: &'a str,
+    similarity: NotNan<f32>,
+    word: &'a str,
 }
 
 impl<'a> WordSimilarityResult<'a> {
@@ -48,6 +48,10 @@ impl<'a> WordSimilarityResult<'a> {
     pub fn euclidean_similarity(&self) -> f32 {
         1f32 - (self.euclidean_distance() / 2f32)
     }
+
+    pub fn word(&self) -> &str {
+        self.word
+    }
 }
 
 impl<'a> Ord for WordSimilarityResult<'a> {