Skip to content

Commit e4f3043

Browse files
committed
Clarified intent of HammingDistanceScript in the README
1 parent 6f5f4be commit e4f3043

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This repository contains native scoring scripts for use with elasticsearch.
44
**Disclaimer:** They have only been tested with elasticsearch v1.7.3, and even then against a very strict document set.
55

66
## Hamming Distance
7-
This script will calculate the hamming distance between two hashes (or strings), one hash being passed in as a parameter: `param_hash`, and the other being stored in a field also identified by a parameter: `param_field`.
7+
This script will calculate the hamming distance between two hex-encoded bit-strings (ie: strings made up of 1’s and 0’s and then hexidecimally encoded), one hash being passed in as a parameter: `param_hash`, and the other being stored in a field also identified by a parameter: `param_field`.
88

99
It will then return your search results scored accordingly, where the smallest distance (ie: most similar strings) appear nearer the top of the results list.
1010

0 commit comments

Comments
 (0)