feat: add string/base/distances/hamming
#1166
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Beginning of addition of this feature
fix minor bug
Adding test.js
use of wrong term corrected
add README.md
add explanation of returning sentinel value of -1 if strings differ in length
Strings outside the Basic Multilingual Plane are warned against
add package.json
add the standard file examples/index/js
add standard file benchmark.js
…at/hamming2 Commit necessary per advice of Mr. Reines.
add standard file repl.txt
add standard file index.d.ts
add standard file test.ts
add standard file lib/index.js
revise README.md, correcting and rephrasing
revised repl.txt to add equal-length and sentinel value
further minor revisions for clarity and to be more informative
revise index.d.ts to state equal length requirement and sentinel value of -1
changed 'throws' to 'returns'
delete code relating to testing Unicode values
added example illustrating -1 returned for different length strings
kgryte
reviewed
Dec 15, 2023
lib/node_modules/@stdlib/string/base/distances/hamming/lib/index.js
Outdated
Show resolved
Hide resolved
Signed-off-by: Athan <kgryte@gmail.com>
kgryte
approved these changes
Dec 15, 2023
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request adds an API for computing the Hamming distance between two strings by comparing UTF-16 code units.
Related Issues
Questions
No.
Other
Yes. The feature is named hamming2 in order to distinguish it from an earlier effort that was discontinued. The better name would be, of course, hamming.
Checklist
@stdlib-js/reviewers