Modulealfred-margaret-2.1.1.1Haskell2010

Data.Text.AhoCorasick.Searcher

1 type
11 values

Packagealfred-margaret-2.1.1.1
Exports12
LanguageHaskell2010
LicenceBSD-3-Clause
SourceSearcher.hs

datadata Searcher v

A set of needles with associated values, and an Aho-Corasick automaton to efficiently find those needles.

INVARIANT: searcherAutomaton = Aho.build . searcherNeedles To enforce this invariant, the fields are not exposed from this module. There is a separate constructor function.

The purpose of this wrapper is to have a type that is Hashable and Eq, so we can derive those for types that embed the searcher, whithout requiring the automaton itself to be Hashable or Eq, which would be both wasteful and tedious. Because the automaton is fully determined by the needles and associated values, it is sufficient to implement Eq and Hashable in terms of the needles only.

We also use Hashed to cache the hash of the needles.

Instances9Eq, Show, Generic, Semigroup, NFData, Hashable, …

Eq v => Eq (Searcher v)Defined in alfred-margaret-2.1.1.1 · Data.Text.AhoCorasick.Searcher
Show (Searcher v)Defined in alfred-margaret-2.1.1.1 · Data.Text.AhoCorasick.Searcher
Generic (Searcher v)Defined in alfred-margaret-2.1.1.1 · Data.Text.AhoCorasick.Searcher
Semigroup (Searcher ())Defined in alfred-margaret-2.1.1.1 · Data.Text.AhoCorasick.Searcher
NFData v => NFData (Searcher v)Defined in alfred-margaret-2.1.1.1 · Data.Text.AhoCorasick.Searcher
Hashable v => Hashable (Searcher v)Defined in alfred-margaret-2.1.1.1 · Data.Text.AhoCorasick.Searcher
(Hashable v, FromJSON v) => FromJSON (Searcher v)Defined in alfred-margaret-2.1.1.1 · Data.Text.AhoCorasick.Searcher
ToJSON v => ToJSON (Searcher v)Defined in alfred-margaret-2.1.1.1 · Data.Text.AhoCorasick.Searcher
type Rep (Searcher v) = D1 ('MetaData "Searcher" "Data.Text.AhoCorasick.Searcher" "alfred-margaret-2.1.1.1-LmqCjvAcVEl7fSX12XT7qq" 'False) (C1 ('MetaCons "Searcher" 'PrefixI 'True) ((S1 ('MetaSel ('Just "searcherCaseSensitive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CaseSensitivity) :*: S1 ('MetaSel ('Just "searcherNeedles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Hashed [(Text, v)]))) :*: (S1 ('MetaSel ('Just "searcherNumNeedles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "searcherAutomaton") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (AcMachine v)))))Defined in alfred-margaret-2.1.1.1 · Data.Text.AhoCorasick.Searcher

valueautomaton :: Searcher v -> AcMachine v

valuebuild :: CaseSensitivity -> [Text] -> Searcher ()

Builds the Searcher for a list of needles The caller is responsible that the needles are lower case in case the IgnoreCase is used for case sensitivity

valuebuildNeedleIdSearcher :: CaseSensitivity -> [Text] -> Searcher Int

Build a Searcher that returns the needle's index in the needle list when it matches.

valuebuildWithValues

:: Hashable v
=> CaseSensitivity
-> [(Text, v)]
-> Searcher v

The caller is responsible that the needles are lower case in case the IgnoreCase is used for case sensitivity

valuecaseSensitivity :: Searcher v -> CaseSensitivity

valuecontainsAll :: Searcher Int -> Text -> Bool

Returns whether the haystack contains all of the needles. This function expects the passed Searcher to be constructed using buildNeedleIdAutomaton.

valuecontainsAny :: Searcher () -> Text -> Bool

Return whether the haystack contains any of the needles. Case sensitivity depends on the properties of the searcher This function is marked noinline as an inlining boundary. Aho.runText is marked inline, so this function will be optimized to report only whether there is a match, and not construct a list of matches. We don't want this function be inline, to make sure that the conditions of the caller don't affect how this function is optimized. There is little to gain from additional inlining. The pragma is not an optimization in itself, rather it is a defence against fragile optimizer decisions.

valuemapSearcher :: Hashable b => (a -> b) -> Searcher a -> Searcher b

Modify the values associated with the needles.

valueneedles :: Searcher v -> [(Text, v)]

valuenumNeedles :: Searcher v -> Int

valuesetCaseSensitivity :: CaseSensitivity -> Searcher v -> Searcher v

Updates the case sensitivity of the searcher. Does not change the capitilization of the needles. The caller should be certain that if IgnoreCase is passed, the needles are already lower case.