Skip to content

Fix long overflow in CosineSimilarity dot product #779

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
PHJ2000 wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Fix long overflow in CosineSimilarity dot product #779

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/main/java/org/apache/commons/text/similarity/CosineSimilarity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ public Double cosineSimilarity(final Map<CharSequence, Integer> leftVector, fina
* @return The dot product.
*/
private double dot(final Map<CharSequence, Integer> leftVector, final Map<CharSequence, Integer> rightVector, final Set<CharSequence> intersection) {
long dotProduct = 0;
double dotProduct = 0;
for (final CharSequence key : intersection) {
dotProduct += leftVector.get(key) * (long) rightVector.get(key);
}
Expand Down
12 changes: 12 additions & 0 deletions src/test/java/org/apache/commons/text/similarity/CosineSimilarityTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,21 @@
import java.util.Map;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;

class CosineSimilarityTest {

@ParameterizedTest
@ValueSource(ints = {1, Integer.MAX_VALUE, Integer.MIN_VALUE})
void testCosineSimilarityOfIdenticalVectors(final int value) {
final Map<CharSequence, Integer> vector = new HashMap<>();
vector.put("a", value);
vector.put("b", value);
vector.put("c", value);
assertEquals(1.0, CosineSimilarity.INSTANCE.cosineSimilarity(vector, vector), 1e-12);
}

@Test
void testCosineSimilarityReturningDoubleWhereByteValueIsZero() {
final Map<CharSequence, Integer> hashMap = new HashMap<>();
Expand Down