Hunt.Query.Fuzzy

Version : 0.2

The unique Holumbus mechanism for generating fuzzy sets.

Fuzzy types

type FuzzySet = Map Text FuzzyScore

A set of string which have been "fuzzed" with an associated score.

type Replacements = [Replacement]

Some replacements which can be applied to a string to generate a FuzzySet. The scores of the replacements will be normalized to a maximum of 1.0.

type Replacement = ((Text, Text), FuzzyScore)

A single replacements, where the first will be replaced by the second and vice versa in the target string. The score indicates the amount of fuzzines that one single application of this replacement in just one direction will cause on the target string.

type FuzzyScore = Float

The score indicating an amount of fuzziness.

data FuzzyConfig

The configuration of a fuzzy query.

Constructors

FuzzyConfig

Fields

applyReplacements :: Bool

Indicates whether the replacements should be applied.

applySwappings :: Bool

Indicates whether the swapping of adjacent characters should be applied.

maxFuzziness :: FuzzyScore

The maximum allowed fuzziness.

customReplacements :: Replacements

The replacements that should be applied.

Instances

Show FuzzyConfig

Binary FuzzyConfig

Default FuzzyConfig

Predefined replacements

englishReplacements :: Replacements

Some default replacements for the english language.

germanReplacements :: Replacements

Some default replacements for the german language.

Generation

fuzz :: FuzzyConfig -> Text -> FuzzySet

Continue fuzzing a string with the an explicitly specified list of replacements until a given score threshold is reached.

Conversion

toList :: FuzzySet -> [(Text, FuzzyScore)]

Transform a fuzzy set into a list (ordered by score).