| Safe Haskell | Safe |
|---|---|
| Language | Haskell98 |
UHC.Util.TreeTrie
Description
A TreeTrie is a search structure where the key actually consists of a tree of keys, represented as a list of layers in the tree, 1 for every depth, starting at the top, which are iteratively used for searching. The search structure for common path/prefixes is shared, the trie branches to multiple corresponding to available children, length equality of children is used in searching (should match)
The TreeTrie structure implemented in this module deviates from the usual TreeTrie implementations in that it allows wildcard matches besides the normal full match. The objective is to also be able to retrieve values for which (at insertion time) it has been indicated that part does not need full matching. This intentionally is similar to unification, where matching on a variable will succeed for arbitrary values. Unification is not the job of this TreeTrie implementation, but by returning partial matches as well, a list of possible match candidates is returned.
- data TreeTrie1Key k
- data TreeTrieMp1Key k
- = TTM1K [TreeTrie1Key k]
- | TTM1K_Any
- type TreeTrieMpKey k = [TreeTrieMp1Key k]
- type TreeTrieKey k = [TreeTrieMpKey k]
- type family TrTrKey x :: *
- ppTreeTrieKey :: PP k => TreeTrieKey k -> PP_Doc
- ttkSingleton :: TreeTrie1Key k -> TreeTrieKey k
- ttkAdd' :: TreeTrie1Key k -> TreeTrieKey k -> TreeTrieKey k
- ttkAdd :: TreeTrie1Key k -> [TreeTrieKey k] -> TreeTrieKey k
- ttkChildren :: [TreeTrieKey k] -> TreeTrieKey k
- ttkFixate :: TreeTrieKey k -> TreeTrieKey k
- ttkParentChildren :: TreeTrieKey k -> (TreeTrie1Key k, TreeTrieKey k)
- class TreeTrieKeyable x where
- data TreeTrie k v
- emptyTreeTrie :: TreeTrie k v
- empty :: TreeTrie k v
- toListByKey :: TreeTrie k v -> [(TreeTrieKey k, v)]
- toList :: TreeTrie k v -> [(TreeTrieKey k, v)]
- fromListByKeyWith :: Ord k => (v -> v -> v) -> [(TreeTrieKey k, v)] -> TreeTrie k v
- fromList :: Ord k => [(TreeTrieKey k, v)] -> TreeTrie k v
- data TreeTrieLookup
- lookupPartialByKey :: (PP k, Ord k) => TreeTrieLookup -> TreeTrieKey k -> TreeTrie k v -> ([v], Maybe v)
- lookupPartialByKey' :: forall k v v'. (PP k, Ord k) => (TreeTrieKey k -> v -> v') -> TreeTrieLookup -> TreeTrieKey k -> TreeTrie k v -> ([v'], Maybe v')
- lookupByKey :: (PP k, Ord k) => TreeTrieKey k -> TreeTrie k v -> Maybe v
- lookup :: (PP k, Ord k) => TreeTrieKey k -> TreeTrie k v -> Maybe v
- lookupResultToList :: ([v], Maybe v) -> [v]
- isEmpty :: TreeTrie k v -> Bool
- null :: TreeTrie k v -> Bool
- elems :: TreeTrie k v -> [v]
- singleton :: Ord k => TreeTrieKey k -> v -> TreeTrie k v
- singletonKeyable :: (Ord (TrTrKey v), TreeTrieKeyable v) => v -> TreeTrie (TrTrKey v) v
- unionWith :: Ord k => (v -> v -> v) -> TreeTrie k v -> TreeTrie k v -> TreeTrie k v
- union :: Ord k => TreeTrie k v -> TreeTrie k v -> TreeTrie k v
- unionsWith :: Ord k => (v -> v -> v) -> [TreeTrie k v] -> TreeTrie k v
- unions :: Ord k => [TreeTrie k v] -> TreeTrie k v
- insertByKeyWith :: Ord k => (v -> v -> v) -> TreeTrieKey k -> v -> TreeTrie k v -> TreeTrie k v
- insertByKey :: Ord k => TreeTrieKey k -> v -> TreeTrie k v -> TreeTrie k v
- deleteByKey :: Ord k => TreeTrieKey k -> TreeTrie k v -> TreeTrie k v
- delete :: Ord k => TreeTrieKey k -> TreeTrie k v -> TreeTrie k v
- deleteListByKey :: Ord k => [TreeTrieKey k] -> TreeTrie k v -> TreeTrie k v
Key into TreeTrie
data TreeTrie1Key k Source #
Both key and trie can allow partial matching, indicated by TreeTrie1Key
Instances
| Eq k => Eq (TreeTrie1Key k) Source # | |
| Ord k => Ord (TreeTrie1Key k) Source # | |
| Show k => Show (TreeTrie1Key k) Source # | |
| PP k => PP (TreeTrie1Key k) Source # | |
| Serialize k => Serialize (TreeTrie1Key k) Source # | |
data TreeTrieMp1Key k Source #
A key in a layer of TreeTrieMpKey
Constructors
| TTM1K [TreeTrie1Key k] | |
| TTM1K_Any |
Instances
| Eq k => Eq (TreeTrieMp1Key k) Source # | |
| Ord k => Ord (TreeTrieMp1Key k) Source # | |
| Show k => Show (TreeTrieMp1Key k) Source # | |
| PP k => PP (TreeTrieMp1Key k) Source # | |
| Serialize k => Serialize (TreeTrieMp1Key k) Source # | |
type TreeTrieMpKey k = [TreeTrieMp1Key k] Source #
The key into a map used internally by the trie
type TreeTrieKey k = [TreeTrieMpKey k] Source #
The key used externally to index into a trie
ppTreeTrieKey :: PP k => TreeTrieKey k -> PP_Doc Source #
Pretty print TrieKey
ttkSingleton :: TreeTrie1Key k -> TreeTrieKey k Source #
Make singleton, which should at end be stripped from bottom layer of empty TTM1K []
ttkAdd' :: TreeTrie1Key k -> TreeTrieKey k -> TreeTrieKey k Source #
Add a new layer with single node on top, combining the rest.
ttkAdd :: TreeTrie1Key k -> [TreeTrieKey k] -> TreeTrieKey k Source #
Add a new layer with single node on top, combining the rest. length ks >= 2
ttkChildren :: [TreeTrieKey k] -> TreeTrieKey k Source #
Construct intermediate structure for children for a new Key length ks >= 2
ttkFixate :: TreeTrieKey k -> TreeTrieKey k Source #
Fixate by removing lowest layer empty children
ttkParentChildren :: TreeTrieKey k -> (TreeTrie1Key k, TreeTrieKey k) Source #
Split key into parent and children components, inverse of ttkAdd'
Keyable
class TreeTrieKeyable x where Source #
Keyable values, i.e. capable of yielding a TreeTrieKey for retrieval from a trie
Minimal complete definition
Methods
toTreeTrieKey :: x -> TreeTrieKey (TrTrKey x) Source #
TreeTrie
The trie structure, branching out on (1) kind, (2) nr of children, (3) actual key
emptyTreeTrie :: TreeTrie k v Source #
toListByKey :: TreeTrie k v -> [(TreeTrieKey k, v)] Source #
toList :: TreeTrie k v -> [(TreeTrieKey k, v)] Source #
fromListByKeyWith :: Ord k => (v -> v -> v) -> [(TreeTrieKey k, v)] -> TreeTrie k v Source #
Lookup
data TreeTrieLookup Source #
How to lookup in a TreeTrie
Constructors
| TTL_Exact | |
| TTL_WildInTrie | |
| TTL_WildInKey |
Instances
lookupPartialByKey :: (PP k, Ord k) => TreeTrieLookup -> TreeTrieKey k -> TreeTrie k v -> ([v], Maybe v) Source #
lookupPartialByKey' :: forall k v v'. (PP k, Ord k) => (TreeTrieKey k -> v -> v') -> TreeTrieLookup -> TreeTrieKey k -> TreeTrie k v -> ([v'], Maybe v') Source #
Normal lookup for exact match + partial matches (which require some sort of further unification, determining whether it was found)
lookupByKey :: (PP k, Ord k) => TreeTrieKey k -> TreeTrie k v -> Maybe v Source #
lookupResultToList :: ([v], Maybe v) -> [v] Source #
Convert the lookup result to a list of results
Properties/observations
Construction
singletonKeyable :: (Ord (TrTrKey v), TreeTrieKeyable v) => v -> TreeTrie (TrTrKey v) v Source #
insertByKeyWith :: Ord k => (v -> v -> v) -> TreeTrieKey k -> v -> TreeTrie k v -> TreeTrie k v Source #
insertByKey :: Ord k => TreeTrieKey k -> v -> TreeTrie k v -> TreeTrie k v Source #
Deletion
deleteByKey :: Ord k => TreeTrieKey k -> TreeTrie k v -> TreeTrie k v Source #
deleteListByKey :: Ord k => [TreeTrieKey k] -> TreeTrie k v -> TreeTrie k v Source #