Data.FixFile.BTree

This is a BTree data type that can be used with FixFile. It can be used as a key-value store where the same key can correspond to multiple values. It supports logarithmic insert, lookup, and delete operations.

Documentation

data BTree n k v a

A Fixed (BTree n k v) stores a BTree of key/value pairs. n should be a Nat and will be the maximum number of elements in each branch of the BTree.

Instances

Functor (BTree n k v)

Methods

fmap :: (a -> b) -> BTree n k v a -> BTree n k v b

(<$) :: a -> BTree n k v b -> BTree n k v a

Foldable (BTree n k v)

Methods

fold :: Monoid m => BTree n k v m -> m

foldMap :: Monoid m => (a -> m) -> BTree n k v a -> m

foldr :: (a -> b -> b) -> b -> BTree n k v a -> b

foldr' :: (a -> b -> b) -> b -> BTree n k v a -> b

foldl :: (b -> a -> b) -> b -> BTree n k v a -> b

foldl' :: (b -> a -> b) -> b -> BTree n k v a -> b

foldr1 :: (a -> a -> a) -> BTree n k v a -> a

foldl1 :: (a -> a -> a) -> BTree n k v a -> a

toList :: BTree n k v a -> [a]

null :: BTree n k v a -> Bool

length :: BTree n k v a -> Int

elem :: Eq a => a -> BTree n k v a -> Bool

maximum :: Ord a => BTree n k v a -> a

minimum :: Ord a => BTree n k v a -> a

sum :: Num a => BTree n k v a -> a

product :: Num a => BTree n k v a -> a

Traversable (BTree n k v)

Methods

traverse :: Applicative f => (a -> f b) -> BTree n k v a -> f (BTree n k v b)

sequenceA :: Applicative f => BTree n k v (f a) -> f (BTree n k v a)

mapM :: Monad m => (a -> m b) -> BTree n k v a -> m (BTree n k v b)

sequence :: Monad m => BTree n k v (m a) -> m (BTree n k v a)

FixedTraversable (BTree n k v)

Methods

traverseF :: (Fixed g, Fixed g', Applicative h, (* ~ a) (Alg (BTree n k v))) => (a -> h b) -> g (BTree n k v) -> h (g' (Sub (BTree n k v) a b))

FixedFoldable (BTree n k v)

Methods

foldMapF :: (Fixed g, Monoid m, (* ~ a) (Alg (BTree n k v))) => (a -> m) -> g (BTree n k v) -> m

FixedFunctor (BTree n k v)

Methods

fmapF :: (Fixed g, Fixed g', (* ~ a) (Alg (BTree n k v))) => (a -> b) -> g (BTree n k v) -> g' (Sub (BTree n k v) a b)

FixedSub (BTree n k v)

Associated Types

type Sub (BTree n k v :: * -> *) v v' :: * -> *

FixedAlg (BTree n k v)

Associated Types

type Alg (BTree n k v :: * -> *) :: *

Null1 (BTree n k v)

Methods

empty1 :: BTree n k v a

null1 :: BTree n k v a -> Bool

(Read k, Read v, Read a) => Read (BTree n k v a)

Methods

readsPrec :: Int -> ReadS (BTree n k v a)

readList :: ReadS [BTree n k v a]

readPrec :: ReadPrec (BTree n k v a)

readListPrec :: ReadPrec [BTree n k v a]

(Show k, Show v, Show a) => Show (BTree n k v a)

Methods

showsPrec :: Int -> BTree n k v a -> ShowS

show :: BTree n k v a -> String

showList :: [BTree n k v a] -> ShowS

Generic (BTree n k v a)

Associated Types

type Rep (BTree n k v a) :: * -> *

Methods

from :: BTree n k v a -> Rep (BTree n k v a) x

to :: Rep (BTree n k v a) x -> BTree n k v a

(Binary k, Binary v, Binary a) => Binary (BTree n k v a)

Methods

put :: BTree n k v a -> Put

get :: Get (BTree n k v a)

putList :: [BTree n k v a] -> Put

type Alg (BTree n k v)

type Alg (BTree n k v) = v

type Sub (BTree n k v) v v'

type Sub (BTree n k v) v v' = BTree n k v'

type Rep (BTree n k v a)

type Rep (BTree n k v a) = D1 (MetaData "BTree" "Data.FixFile.BTree" "fixfile-0.6.0.0-5pujpGE70zs5t2DORaJOWK" False) ((:+:) (C1 (MetaCons "Empty" PrefixI False) U1) ((:+:) (C1 (MetaCons "Value" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 v))) (C1 (MetaCons "Node" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word32)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Vector (k, a))))))))

createBTreeFile :: (Typeable n, Binary k, Typeable k, Binary v, Typeable v) => FilePath -> IO (FixFile (Ref (BTree n k v)))

Create a FixFile storing a (BTree k v). The initial value is empty.

openBTreeFile :: (Binary k, Typeable k, Binary v, Typeable v) => FilePath -> IO (FixFile (Ref (BTree n k v)))

Open a FixFile storing a (BTree k v).

depth :: Fixed g => g (BTree n k v) -> Int

Compute the depth of a BTree

insertBTree :: (KnownNat n, Ord k, Fixed g) => k -> v -> g (BTree n k v) -> g (BTree n k v)

Insert the value v with the key k into a Fixed (BTree k v).

insertBTreeT :: (KnownNat n, Ord k, Binary k, Binary v) => k -> v -> Transaction (Ref (BTree n k v)) s ()

Transaction version of insertBTree.

lookupBTree :: (Ord k, Fixed g) => k -> g (BTree n k v) -> [v]

Lookup the values stored for the key k in a Fixed (BTree k v).

lookupBTreeT :: (Ord k, Binary k, Binary v) => k -> Transaction (Ref (BTree n k v)) s [v]

Transaction version of lookupBTree.

filterBTree :: (Ord k, Fixed g) => k -> (v -> Bool) -> g (BTree n k v) -> g (BTree n k v)

Filter items from a Fixed (BTree k v) for a key k that match the predicate.

filterBTreeT :: (Ord k, Binary k, Binary v) => k -> (v -> Bool) -> Transaction (Ref (BTree n k v)) s ()

Transaction version of filterBTree.

deleteBTree :: (Ord k, Fixed g) => k -> g (BTree n k v) -> g (BTree n k v)

Delete all items for key k from the Fixed (BTree k v).

deleteBTreeT :: (Ord k, Binary k, Binary v) => k -> Transaction (Ref (BTree n k v)) s ()

Transaction version of deleteBTree.

partitionBTree :: (Ord k, Fixed g) => k -> g (BTree n k v) -> (g (BTree n k v), g (BTree n k v))

Split a BTree into two two BTrees with keys and keys k.

toListBTree :: (Ord k, Fixed g) => g (BTree n k v) -> [(k, v)]

Turn a Fixed (BTree k v) into a list of key value tuples.

fromListBTree :: (KnownNat n, Ord k, Fixed g) => [(k, v)] -> g (BTree n k v)

Turn a list of key value tuples into a Fixed (BTree k v).