Data.JoinList

A Join List datatype and operations.

Join Lists are symmetric lists where joining two lists (catenation, aka (++)) is a cheap operation. This constrasts with the regular list datatype which is a cons list: while consing on a regular list (building a list by adding an elementary prefix) is by nature cheap, joining (++) is expensive.

Join list datatype

data JoinList a

Instances

Monad JoinList

Functor JoinList

Foldable JoinList

Traversable JoinList

Eq a => Eq (JoinList a)

Show a => Show (JoinList a)

Monoid (JoinList a)

Elementary construction

empty :: JoinList a

Create an empty join list.

wrap :: a -> JoinList a

Create a singleton join list.

(++) :: JoinList a -> JoinList a -> JoinList a

Catenate two join lists. Unlike (++) on regular lists, catenation on join lists is (relatively) cheap hence the monicker join list.

join :: JoinList a -> JoinList a -> JoinList a

An alias for (++) that does not cause a name clash with the Prelude.

Basic functions

null :: JoinList a -> Bool

Test whether a join list is empty.

concat :: JoinList (JoinList a) -> JoinList a

Concatenate a (join) list of (join) lists.

length :: JoinList a -> Int

Get the length of a join list.

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

Map a function over a join list.

Building join lists

replicate :: Int -> a -> JoinList a

Build a join list of n elements.

repeated :: Int -> JoinList a -> JoinList a

Repeatedly build a join list by catenating the seed list.

Generalized fold

gfold :: b -> (a -> b) -> (b -> b -> b) -> JoinList a -> b

A Jeremy Gibbons style generalised fold, where each constructor has an operation.

Zipping

xzip :: JoinList a -> [b] -> JoinList (a, b)

cross zip - zip a join list against a regular list, maintaining the shape of the join list provided the lengths of the lists match.

xzipWith :: (a -> b -> c) -> JoinList a -> [b] -> JoinList c

Generalized cross zip - c.f. zipWith on regular lists.

Conversion between join lists and regular lists

toList :: JoinList a -> [a]

Convert a join list to a regular list.

fromList :: [a] -> JoinList a

Build a join list from a regular list.