text-metrics

Calculate various string metrics efficiently

LTS Haskell 21.22:	0.3.2@rev:3
Stackage Nightly 2023-12-03:	0.3.2@rev:3
Latest on Hackage:	0.3.2@rev:3

See all snapshots text-metrics appears in

BSD-3-Clause licensed and maintained by Mark Karpov

This version can be pinned in stack with:text-metrics-0.3.2@sha256:98bc097523232b855696bb52c50ab931132e00cac476168469a71b35e5d9bdc1,2668

Module documentation for 0.3.2

Data
- Data.Text
  - Data.Text.Metrics

Depends on 4 packages(full list with versions):

base, containers, text, vector

Used by 4 packages in nightly-2023-12-03(full list with versions):

fuzzyset, infer-license, mmark, pantry

Text Metrics

The library provides efficient implementations of various strings metric algorithms. It works with strict Text values.

The current version of the package implements:

Comparison with the `edit-distance` package

There is edit-distance package whose scope overlaps with the scope of this package. The differences are:

edit-distance allows to specify costs for every operation when calculating Levenshtein distance (insertion, deletion, substitution, and transposition). This is rarely needed though in real-world applications, IMO.
edit-distance only provides Levenshtein distance, text-metrics aims to provide implementations of most string metrics algorithms.
edit-distance works on Strings, while text-metrics works on strict Text values.

Implementation

Although we originally used C for speed, currently all functions are pure Haskell tuned for performance. See this blog post for more info.

Contribution

Issues, bugs, and questions may be reported in the GitHub issue tracker for this project.

Pull requests are also welcome.

License

Distributed under BSD 3 clause license.

Changes

Text Metrics 0.3.2

Works with text-2.0.

Text Metrics 0.3.1

Fixed a bug in the implementation of Jaro-Winkler distance when two strings share a long prefix. PR 21.
Dropped support for GHC 8.6 and older.

Text Metrics 0.3.0

All functions are now implemented in pure Haskell.
All functions return Int or Ratio Int instead of Natural and Ratio Natural.
Added overlap (returns overlap coefficient) and jaccard (returns Jaccard similarity coefficient).

Text Metrics 0.2.0

Made the levenshtein, levenshteinNorm, damerauLevenshtein, and demerauLevenshtein more efficient.
Added jaro and jaroWinkler functions.

Text Metrics 0.1.0

Initial release.