Holumbus.Data.PrefixTree

Facade for prefix tree implementation

Documentation

data PrefixTree v

Constructors

Empty

Val

Fields

value' :: v

tree :: !(PrefixTree v)

Branch

Fields

sym :: !Sym

child :: !(PrefixTree v)

next :: !(PrefixTree v)

Leaf

Fields

value' :: v

Last

Fields

sym :: !Sym

child :: !(PrefixTree v)

LsSeq

Fields

syms :: !Key1

child :: !(PrefixTree v)

BrSeq

Fields

syms :: !Key1

child :: !(PrefixTree v)

next :: !(PrefixTree v)

LsSeL

Fields

syms :: !Key1

value' :: v

BrSeL

Fields

syms :: !Key1

value' :: v

next :: !(PrefixTree v)

BrVal

Fields

sym :: !Sym

value' :: v

next :: !(PrefixTree v)

LsVal

Fields

sym :: !Sym

value' :: v

Instances

Functor PrefixTree

Foldable PrefixTree

Eq v => Eq (PrefixTree v)

Ord v => Ord (PrefixTree v)

Read a => Read (PrefixTree a)

Show v => Show (PrefixTree v)

Binary a => Binary (PrefixTree a)

NFData a => NFData (PrefixTree a)

type Key = [Sym]

(!) :: PrefixTree a -> Key -> a

O(min(n,L)) Find the value at a key. Calls error when the element can not be found.

value :: Monad m => PrefixTree a -> m a

O(1) Extract the value of a node (if there is one)

valueWithDefault :: a -> PrefixTree a -> a

O(1) Extract the value of a node or return a default value if no value exists.

null :: PrefixTree a -> Bool

O(1) Is the map empty?

size :: PrefixTree a -> Int

O(n) The number of elements.

member :: Key -> PrefixTree a -> Bool

O(min(n,L)) Is the key a member of the map?

lookup :: Monad m => Key -> PrefixTree a -> m a

O(min(n,L)) Find the value associated with a key. The function will return the result in the monad or fail in it if the key isn't in the map.

findWithDefault :: a -> Key -> PrefixTree a -> a

O(min(n,L)) Find the value associated with a key. The function will return the result in the monad or fail in it if the key isn't in the map.

prefixFind :: Key -> PrefixTree a -> [a]

O(max(L,R)) Find all values where the string is a prefix of the key.

prefixFindWithKey :: Key -> PrefixTree a -> [(Key, a)]

O(max(L,R)) Find all values where the string is a prefix of the key and include the keys in the result.

prefixFindWithKeyBF :: Key -> PrefixTree a -> [(Key, a)]

O(max(L,R)) Find all values where the string is a prefix of the key and include the keys in the result. The result list contains short words first

empty :: PrefixTree v

singleton :: Key -> a -> PrefixTree a

O(1) Create a map with a single element.

insert :: Key -> a -> PrefixTree a -> PrefixTree a

O(min(n,L)) Insert a new key and value into the map. If the key is already present in the map, the associated value will be replaced with the new value.

insertWith :: (a -> a -> a) -> Key -> a -> PrefixTree a -> PrefixTree a

O(min(n,L)) Insert with a combining function. If the key is already present in the map, the value of f new_value old_value will be inserted.

insertWithKey :: (Key -> a -> a -> a) -> Key -> a -> PrefixTree a -> PrefixTree a

O(min(n,L)) Insert with a combining function. If the key is already present in the map, the value of f key new_value old_value will be inserted.

delete :: Key -> PrefixTree a -> PrefixTree a

O(min(n,L)) Delete an element from the map. If no element exists for the key, the map remains unchanged.

update :: (a -> Maybe a) -> Key -> PrefixTree a -> PrefixTree a

O(min(n,L)) Updates a value at a given key (if that key is in the trie) or deletes the element if the result of the updating function is Nothing. If the key is not found, the trie is returned unchanged.

updateWithKey :: (Key -> a -> Maybe a) -> Key -> PrefixTree a -> PrefixTree a

O(min(n,L)) Updates a value at a given key (if that key is in the trie) or deletes the element if the result of the updating function is Nothing. If the key is not found, the trie is returned unchanged.

map :: (a -> b) -> PrefixTree a -> PrefixTree b

O(n) Map a function over all values in the prefix tree.

mapWithKey :: (Key -> a -> b) -> PrefixTree a -> PrefixTree b

mapM :: Monad m => (a -> m b) -> PrefixTree a -> m (PrefixTree b)

Monadic map

mapWithKeyM :: Monad m => (Key -> a -> m b) -> PrefixTree a -> m (PrefixTree b)

Monadic mapWithKey

fold :: (a -> b -> b) -> b -> PrefixTree a -> b

O(n) Fold over all values in the map.

foldWithKey :: (Key -> a -> b -> b) -> b -> PrefixTree a -> b

O(n) Fold over all key/value pairs in the map.

union :: PrefixTree a -> PrefixTree a -> PrefixTree a

O(n+m) Left-biased union of two maps. It prefers the first map when duplicate keys are encountered, i.e. (union == unionWith const).

unionWith :: (a -> a -> a) -> PrefixTree a -> PrefixTree a -> PrefixTree a

O(n+m) Union with a combining function.

unionWithKey :: (Key -> a -> a -> a) -> PrefixTree a -> PrefixTree a -> PrefixTree a

O(n+m) Union with a combining function, including the key.

difference :: PrefixTree a -> PrefixTree b -> PrefixTree a

(O(min(n,m)) Difference between two tries (based on keys).

differenceWith :: (a -> b -> Maybe a) -> PrefixTree a -> PrefixTree b -> PrefixTree a

(O(min(n,m)) Difference with a combining function. If the combining function always returns Nothing, this is equal to proper set difference.

differenceWithKey :: (Key -> a -> b -> Maybe a) -> PrefixTree a -> PrefixTree b -> PrefixTree a

O(min(n,m)) Difference with a combining function, including the key. If two equal keys are encountered, the combining function is applied to the key and both values. If it returns Nothing, the element is discarded, if it returns Just a value, the element is updated with the new value.

keys :: PrefixTree a -> [Key]

O(n) Returns all values.

elems :: PrefixTree a -> [a]

O(n) Returns all values.

toList :: PrefixTree a -> [(Key, a)]

O(n) Returns all elements as list of key value pairs,

fromList :: [(Key, a)] -> PrefixTree a

O(n) Creates a trie from a list of key/value pairs.

toListBF :: PrefixTree v -> [(Key, v)]

returns all key-value pairs in breadth first order (short words first) this enables prefix search with upper bounds on the size of the result set e.g. search ... >>> toListBF >>> take 1000 will give the 1000 shortest words found in the result set and will ignore all long words

toList is derived from the following code found in the net when searching haskell breadth first search

Haskell Standard Libraray Implementation

 br :: Tree a -> [a]
 br t = map rootLabel $
        concat $
        takeWhile (not . null) $                
        iterate (concatMap subForest) [t]

toMap :: PrefixTree a -> Map Key a

O(n) Convert into an ordinary map.

fromMap :: Map Key a -> PrefixTree a

O(n) Convert an ordinary map into a Prefix tree

space :: PrefixTree a -> Int

space required by a prefix tree (logically)

Singletons are counted as 0, all other n-ary constructors are counted as n+1 (1 for the constructor and 1 for every field) cons nodes of char lists are counted 2, 1 for the cons, 1 for the char for values only the ref to the value is counted, not the space for the value itself key chars are assumed to be unboxed

keyChars :: PrefixTree a -> Int

prefixFindCaseWithKey :: Key -> PrefixTree a -> [(Key, a)]

O(max(L,R)) Find all values where the string is a prefix of the key.

prefixFindNoCaseWithKey :: Key -> PrefixTree a -> [(Key, a)]

prefixFindNoCase :: Key -> PrefixTree a -> [a]

lookupNoCase :: Key -> PrefixTree a -> [(Key, a)]

prefixFindCaseWithKeyBF :: Key -> PrefixTree a -> [(Key, a)]

O(max(L,R)) Find all values where the string is a prefix of the key. Breadth first variant, short words first in the result list

prefixFindNoCaseWithKeyBF :: Key -> PrefixTree a -> [(Key, a)]

lookupNoCaseBF :: Key -> PrefixTree a -> [(Key, a)]