HNSW index: rename HnswDistanceType to VectorDistanceType, update docs

greenrobot-team · greenrobot-team · commit 11f1dae01c21 · 2024-05-14T16:54:29.000+02:00
diff --git a/objectbox-java-api/src/main/java/io/objectbox/annotation/HnswIndex.java b/objectbox-java-api/src/main/java/io/objectbox/annotation/HnswIndex.java
@@ -59,7 +59,7 @@
     /**
      * The distance type used for the HNSW index. Changing this value causes re-indexing.
      */
-    HnswDistanceType distanceType() default HnswDistanceType.DEFAULT;
+    VectorDistanceType distanceType() default VectorDistanceType.DEFAULT;
 
     /**
      * When repairing the graph after a node was removed, this gives the probability of adding backlinks to the repaired
diff --git a/objectbox-java-api/src/main/java/io/objectbox/annotation/VectorDistanceType.java b/objectbox-java-api/src/main/java/io/objectbox/annotation/VectorDistanceType.java
@@ -17,9 +17,9 @@
 package io.objectbox.annotation;
 
 /**
- * The distance algorithm used by an {@link HnswIndex} (vector search).
+ * The vector distance algorithm used by an {@link HnswIndex} (vector search).
  */
-public enum HnswDistanceType {
+public enum VectorDistanceType {
 
     /**
      * The default; currently {@link #EUCLIDEAN}.
