Data.Text.BoyerMoore.Searcher

Documentation

data Searcher v

A set of needles with associated values, and Boyer-Moore automata to efficiently find those needles.

INVARIANT: searcherAutomaton = BoyerMoore.buildAutomaton . 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 the 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.

Instances

Generic (Searcher v)

Defined in Data.Text.BoyerMoore.Searcher

Associated Types

type Rep (Searcher v) :: Type -> Type

Methods

from :: Searcher v -> Rep (Searcher v) x

to :: Rep (Searcher v) x -> Searcher v

Show (Searcher v)

Defined in Data.Text.BoyerMoore.Searcher

Methods

showsPrec :: Int -> Searcher v -> ShowS

show :: Searcher v -> String

showList :: [Searcher v] -> ShowS

NFData v => NFData (Searcher v)

Defined in Data.Text.BoyerMoore.Searcher

Methods

rnf :: Searcher v -> ()

Eq v => Eq (Searcher v)

Defined in Data.Text.BoyerMoore.Searcher

Methods

(==) :: Searcher v -> Searcher v -> Bool

(/=) :: Searcher v -> Searcher v -> Bool

Hashable v => Hashable (Searcher v)

Defined in Data.Text.BoyerMoore.Searcher

Methods

hashWithSalt :: Int -> Searcher v -> Int

hash :: Searcher v -> Int

type Rep (Searcher v)

Defined in Data.Text.BoyerMoore.Searcher

type Rep (Searcher v) = D1 ('MetaData "Searcher" "Data.Text.BoyerMoore.Searcher" "alfred-margaret-2.1.0.0-GaLGdvCW2mGJuL9TH52qO1" 'False) (C1 ('MetaCons "Searcher" 'PrefixI 'True) (S1 ('MetaSel ('Just "searcherNeedles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Hashed [(Text, v)])) :*: (S1 ('MetaSel ('Just "searcherNumNeedles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "searcherAutomata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Automaton, v)]))))

automata :: Searcher v -> [(Automaton, v)]

build :: [Text] -> Searcher ()

Builds the Searcher for a list of needles without values. This is useful for just checking whether the haystack contains the needles.

buildNeedleIdSearcher :: [Text] -> Searcher Int

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

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

Builds the Searcher for a list of needles.

containsAll :: Searcher Int -> Text -> Bool

Like containsAny, but checks whether all needles match instead. Use buildNeedleIdSearcher to get an appropriate Searcher.

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

Return whether the haystack contains any of the needles. This function is marked noinline as an inlining boundary. BoyerMoore.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.

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

numNeedles :: Searcher v -> Int