diff options
author | Arne Juul <arnej@yahooinc.com> | 2023-04-27 21:19:24 +0000 |
---|---|---|
committer | Arne Juul <arnej@yahooinc.com> | 2023-04-27 21:19:24 +0000 |
commit | 40d65770f45b6d4a16d19668487291c02597fa29 (patch) | |
tree | 551938758444607115ea5fbe828b0642f0e849ec | |
parent | 7d1da87a9165e7d9aca41c546ea7b0a370a960b8 (diff) |
update some documentation comments
5 files changed, 10 insertions, 3 deletions
diff --git a/searchlib/src/vespa/searchlib/tensor/angular_distance.h b/searchlib/src/vespa/searchlib/tensor/angular_distance.h index 9cdc1c3a27f..50d3e617cf4 100644 --- a/searchlib/src/vespa/searchlib/tensor/angular_distance.h +++ b/searchlib/src/vespa/searchlib/tensor/angular_distance.h @@ -14,7 +14,7 @@ namespace search::tensor { /** * Calculates angular distance between vectors * Will use instruction optimal for the cpu it is running on - * after converting both vectors an expected cell type. + * after converting both vectors to an optimal cell type. */ template <typename FloatType> class AngularDistanceFunctionFactory : public DistanceFunctionFactory { diff --git a/searchlib/src/vespa/searchlib/tensor/euclidean_distance.h b/searchlib/src/vespa/searchlib/tensor/euclidean_distance.h index f87c31d55aa..fc663c50ccd 100644 --- a/searchlib/src/vespa/searchlib/tensor/euclidean_distance.h +++ b/searchlib/src/vespa/searchlib/tensor/euclidean_distance.h @@ -12,6 +12,8 @@ namespace search::tensor { /** * Calculates the square of the standard Euclidean distance. + * Will use instruction optimal for the cpu it is running on + * after converting both vectors to an optimal cell type. */ template <typename FloatType> class EuclideanDistanceFunctionFactory : public DistanceFunctionFactory { diff --git a/searchlib/src/vespa/searchlib/tensor/geo_degrees_distance.cpp b/searchlib/src/vespa/searchlib/tensor/geo_degrees_distance.cpp index 071771e4368..0212830efb6 100644 --- a/searchlib/src/vespa/searchlib/tensor/geo_degrees_distance.cpp +++ b/searchlib/src/vespa/searchlib/tensor/geo_degrees_distance.cpp @@ -10,7 +10,7 @@ namespace search::tensor { /** * Calculates great-circle distance between Latitude/Longitude pairs, - * measured in degrees. Output distance is measured in meters. + * measured in degrees. Output distance is measured in kilometers. * Uses the haversine formula directly from: * https://en.wikipedia.org/wiki/Haversine_formula **/ diff --git a/searchlib/src/vespa/searchlib/tensor/geo_degrees_distance.h b/searchlib/src/vespa/searchlib/tensor/geo_degrees_distance.h index 20171e7a305..801ee56aacf 100644 --- a/searchlib/src/vespa/searchlib/tensor/geo_degrees_distance.h +++ b/searchlib/src/vespa/searchlib/tensor/geo_degrees_distance.h @@ -11,6 +11,11 @@ namespace search::tensor { +/** + * Calculates great-circle distance between Latitude/Longitude pairs, + * where input is given as degrees. + * Output distance is measured in kilometers. + **/ class GeoDistanceFunctionFactory : public DistanceFunctionFactory { public: GeoDistanceFunctionFactory() = default; diff --git a/searchlib/src/vespa/searchlib/tensor/prenormalized_angular_distance.h b/searchlib/src/vespa/searchlib/tensor/prenormalized_angular_distance.h index be1699c36ad..b91efbddb3e 100644 --- a/searchlib/src/vespa/searchlib/tensor/prenormalized_angular_distance.h +++ b/searchlib/src/vespa/searchlib/tensor/prenormalized_angular_distance.h @@ -11,7 +11,7 @@ namespace search::tensor { /** - * Calculates inner-product "distance" between vectors with assumed norm 1. + * Calculates inner-product "distance" between vectors assuming a common norm. * Should give same ordering as Angular distance, but is less expensive. */ template <typename FloatType> |