Haskus.Utils.STM.TList

Transactional list

Documentation

data TList a

A double linked-list

data TNode a

A node in the list

Every list has a marker node whose value is Nothing. Its nodePrev links to the last node and its nodeNext links to the first node.

empty :: STM (TList a)

Empty node singleton

singleton :: e -> STM (TList e)

Create a singleton list

null :: TList e -> STM Bool

Indicate if the list is empty

length :: TList e -> STM Word

Count the number of elements in the list (0(n))

first :: TList e -> STM (Maybe (TNode e))

Get the first element if any

last :: TList e -> STM (Maybe (TNode e))

Get the last element if any

prev :: TNode a -> STM (Maybe (TNode a))

Get the previous element if any

next :: TNode a -> STM (Maybe (TNode a))

Get the next element if any

value :: TNode a -> a

Get value associated with a node

deleteAll :: TList a -> STM ()

Remove all the elements of the list (O(1))

delete :: TNode a -> STM ()

Delete a element of the list

filter :: (e -> STM Bool) -> TList e -> STM ()

Only keep element matching the criterium

find :: (e -> STM Bool) -> TList e -> STM (Maybe (TNode e))

Find the first node matching the predicate (if any)

append :: a -> TList a -> STM (TNode a)

Append an element to the list

append_ :: a -> TList a -> STM ()

Append an element to the list

prepend :: a -> TList a -> STM (TNode a)

Prepend an element to the list

prepend_ :: a -> TList a -> STM ()

Prepend an element to the list

insertBefore :: a -> TNode a -> STM (TNode a)

Insert an element before another

insertAfter :: a -> TNode a -> STM (TNode a)

Insert an element after another

toList :: TList a -> STM [a]

Convert into a list (O(n))

toReverseList :: TList a -> STM [a]

Convert into a reversed list (O(n))

fromList :: [e] -> STM (TList e)

Create from a list

index :: Word -> TList e -> STM (Maybe (TNode e))

Get the node from its index

take :: Word -> TList e -> STM [e]

Take (and remove) up to n elements in the list (O(n))