This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-text.git
commit 2f50c4f412612865494ba91cfa42008d3084022e Author: Gary D. Gregory <[email protected]> AuthorDate: Sun Jul 20 10:01:31 2025 -0400 Javadoc --- .../commons/text/similarity/CosineSimilarity.java | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/src/main/java/org/apache/commons/text/similarity/CosineSimilarity.java b/src/main/java/org/apache/commons/text/similarity/CosineSimilarity.java index d1adbf25..dfbfe25b 100644 --- a/src/main/java/org/apache/commons/text/similarity/CosineSimilarity.java +++ b/src/main/java/org/apache/commons/text/similarity/CosineSimilarity.java @@ -48,9 +48,9 @@ public class CosineSimilarity { /** * Calculates the cosine similarity for two given vectors. * - * @param leftVector left vector - * @param rightVector right vector - * @return cosine similarity between the two vectors + * @param leftVector left vector. + * @param rightVector right vector. + * @return cosine similarity between the two vectors. */ public Double cosineSimilarity(final Map<CharSequence, Integer> leftVector, final Map<CharSequence, Integer> rightVector) { @@ -83,10 +83,10 @@ public class CosineSimilarity { * that if a vector is longer than other, then a smaller part of it will be used to compute * the dot product. * - * @param leftVector left vector - * @param rightVector right vector - * @param intersection common elements - * @return The dot product + * @param leftVector left vector. + * @param rightVector right vector. + * @param intersection common elements. + * @return The dot product. */ private double dot(final Map<CharSequence, Integer> leftVector, final Map<CharSequence, Integer> rightVector, final Set<CharSequence> intersection) { @@ -100,9 +100,9 @@ public class CosineSimilarity { /** * Returns a set with keys common to the two given maps. * - * @param leftVector left vector map - * @param rightVector right vector map - * @return common strings + * @param leftVector left vector map. + * @param rightVector right vector map. + * @return common strings. */ private Set<CharSequence> getIntersection(final Map<CharSequence, Integer> leftVector, final Map<CharSequence, Integer> rightVector) {
