Basement.Sized.List

A Nat-sized list abstraction

Using this module is limited to GHC 7.10 and above.

Documentation

data ListN (n :: Nat) a

A Typed-level sized List equivalent to [a]

Instances

Eq a => Eq (ListN n a)

Methods

(==) :: ListN n a -> ListN n a -> Bool

(/=) :: ListN n a -> ListN n a -> Bool

Ord a => Ord (ListN n a)

Methods

compare :: ListN n a -> ListN n a -> Ordering

(<) :: ListN n a -> ListN n a -> Bool

(<=) :: ListN n a -> ListN n a -> Bool

(>) :: ListN n a -> ListN n a -> Bool

(>=) :: ListN n a -> ListN n a -> Bool

max :: ListN n a -> ListN n a -> ListN n a

min :: ListN n a -> ListN n a -> ListN n a

Show a => Show (ListN n a)

Methods

showsPrec :: Int -> ListN n a -> ShowS

show :: ListN n a -> String

showList :: [ListN n a] -> ShowS

Generic (ListN n a)

Associated Types

type Rep (ListN n a) :: * -> *

Methods

from :: ListN n a -> Rep (ListN n a) x

to :: Rep (ListN n a) x -> ListN n a

NormalForm a => NormalForm (ListN n a)

Methods

toNormalForm :: ListN n a -> ()

type Rep (ListN n a)

type Rep (ListN n a) = D1 * (MetaData "ListN" "Basement.Sized.List" "basement-0.0.7-IRcTCDmYoctGxt4FUYqdQc" True) (C1 * (MetaCons "ListN" PrefixI True) (S1 * (MetaSel (Just Symbol "unListN") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [a])))

toListN :: forall (n :: Nat) a. (KnownNat n, NatWithinBound Int n) => [a] -> Maybe (ListN n a)

Try to create a ListN from a List, succeeding if the length is correct

toListN_ :: forall n a. (HasCallStack, NatWithinBound Int n, KnownNat n) => [a] -> ListN n a

Create a ListN from a List, expecting a given length

If this list contains more or less than the expected length of the resulting type, then an asynchronous error is raised. use toListN for a more friendly functions

unListN :: ListN n a -> [a]

length :: forall a (n :: Nat). (KnownNat n, NatWithinBound Int n) => ListN n a -> CountOf a

Get the length of a list

create :: forall a (n :: Nat). KnownNat n => (Natural -> a) -> ListN n a

Create a new list of size n, repeately calling f from 0 to n-1

createFrom :: forall a (n :: Nat) (start :: Nat). (KnownNat n, KnownNat start) => Proxy start -> (Natural -> a) -> ListN n a

Same as create but apply an offset

empty :: ListN 0 a

Create an empty list of a

singleton :: a -> ListN 1 a

create a list of 1 element

uncons :: 1 <= n => ListN n a -> (a, ListN (n - 1) a)

Decompose a list into its head and tail.

cons :: a -> ListN n a -> ListN (n + 1) a

prepend an element to the list

unsnoc :: 1 <= n => ListN n a -> (ListN (n - 1) a, a)

Decompose a list into its first elements and the last.

snoc :: ListN n a -> a -> ListN (n + 1) a

append an element to the list

index :: ListN n ty -> Offset ty -> ty

Get the i'the element

indexStatic :: forall i n a. (KnownNat i, CmpNat i n ~ LT, Offsetable a i) => ListN n a -> a

Get the i'th elements

This only works with TypeApplication:

indexStatic @1 (toListN_ [1,2,3] :: ListN 3 Int)

updateAt :: forall n a. Offset a -> (a -> a) -> ListN n a -> ListN n a

Update the value in a list at a specific location

map :: (a -> b) -> ListN n a -> ListN n b

Map all elements in a list

mapi :: (Natural -> a -> b) -> ListN n a -> ListN n b

Map all elements in a list with an additional index

elem :: Eq a => a -> ListN n a -> Bool

Check if a list contains the element a

foldl :: (b -> a -> b) -> b -> ListN n a -> b

Fold all elements from left

foldl' :: (b -> a -> b) -> b -> ListN n a -> b

Fold all elements from left strictly

foldl1' :: 1 <= n => (a -> a -> a) -> ListN n a -> a

Fold all elements from left strictly with a first element as the accumulator

scanl' :: (b -> a -> b) -> b -> ListN n a -> ListN (n + 1) b

scanl is similar to foldl, but returns a list of successive reduced values from the left

scanl f z [x1, x2, ...] == [z, z `f` x1, (z `f` x1) `f` x2, ...]

scanl1' :: (a -> a -> a) -> ListN n a -> ListN n a

scanl1 is a variant of scanl that has no starting value argument:

scanl1 f [x1, x2, ...] == [x1, x1 `f` x2, ...]

foldr :: (a -> b -> b) -> b -> ListN n a -> b

Fold all elements from right

foldr1 :: 1 <= n => (a -> a -> a) -> ListN n a -> a

Fold all elements from right assuming at least one element is in the list.

reverse :: ListN n a -> ListN n a

Reverse a list

append :: ListN n a -> ListN m a -> ListN (n + m) a

Append 2 list together returning the new list

minimum :: (Ord a, 1 <= n) => ListN n a -> a

Get the minimum element of a list

maximum :: (Ord a, 1 <= n) => ListN n a -> a

Get the maximum element of a list

head :: 1 <= n => ListN n a -> a

Get the head element of a list

tail :: 1 <= n => ListN n a -> ListN (n - 1) a

Get the tail of a list

init :: 1 <= n => ListN n a -> ListN (n - 1) a

Get the list with the last element missing

take :: forall a (m :: Nat) (n :: Nat). (KnownNat m, NatWithinBound Int m, m <= n) => ListN n a -> ListN m a

Take m elements from the beggining of the list.

The number of elements need to be less or equal to the list in argument

drop :: forall a d (m :: Nat) (n :: Nat). (KnownNat d, NatWithinBound Int d, (n - m) ~ d, m <= n) => ListN n a -> ListN m a

Drop elements from a list keeping the m remaining elements

splitAt :: forall a d (m :: Nat) (n :: Nat). (KnownNat d, NatWithinBound Int d, (n - m) ~ d, m <= n) => ListN n a -> (ListN m a, ListN (n - m) a)

Split a list into two, returning 2 lists

zip :: ListN n a -> ListN n b -> ListN n (a, b)

Zip 2 lists of the same size, returning a new list of the tuple of each elements

zip3 :: ListN n a -> ListN n b -> ListN n c -> ListN n (a, b, c)

Zip 3 lists of the same size

zip4 :: ListN n a -> ListN n b -> ListN n c -> ListN n d -> ListN n (a, b, c, d)

Zip 4 lists of the same size

zip5 :: ListN n a -> ListN n b -> ListN n c -> ListN n d -> ListN n e -> ListN n (a, b, c, d, e)

Zip 5 lists of the same size

unzip :: ListN n (a, b) -> (ListN n a, ListN n b)

Unzip a list of tuple, to 2 List of the deconstructed tuples

zipWith :: (a -> b -> x) -> ListN n a -> ListN n b -> ListN n x

Zip 2 lists using a function

zipWith3 :: (a -> b -> c -> x) -> ListN n a -> ListN n b -> ListN n c -> ListN n x

Zip 3 lists using a function

zipWith4 :: (a -> b -> c -> d -> x) -> ListN n a -> ListN n b -> ListN n c -> ListN n d -> ListN n x

Zip 4 lists using a function

zipWith5 :: (a -> b -> c -> d -> e -> x) -> ListN n a -> ListN n b -> ListN n c -> ListN n d -> ListN n e -> ListN n x

Zip 5 lists using a function

replicate :: forall (n :: Nat) a. (NatWithinBound Int n, KnownNat n) => a -> ListN n a

Create a list of n elements where each element is the element in argument

Applicative And Monadic

replicateM :: forall (n :: Nat) m a. (NatWithinBound Int n, Monad m, KnownNat n) => m a -> m (ListN n a)

performs a monadic action n times, gathering the results in a List of size n.

sequence :: Monad m => ListN n (m a) -> m (ListN n a)

Evaluate each monadic action in the list sequentially, and collect the results.

sequence_ :: Monad m => ListN n (m a) -> m ()

Evaluate each monadic action in the list sequentially, and ignore the results.

mapM :: Monad m => (a -> m b) -> ListN n a -> m (ListN n b)

Map each element of a List to a monadic action, evaluate these actions sequentially and collect the results

mapM_ :: Monad m => (a -> m b) -> ListN n a -> m ()

Map each element of a List to a monadic action, evaluate these actions sequentially and ignore the results