Data.Vec.Lazy.Inline

A variant of Data.Vec.Lazy with functions written using InlineInduction. The hypothesis is that these (goursive) functions could be fully unrolled, if the Vec size n is known at compile time.

The module has the same API as Data.Vec.Lazy (sans withDict and foldl'). Note: instance methods aren't changed, the Vec type is the same.

Documentation

data Vec (n :: Nat) a where

Vector, i.e. length-indexed list.

Constructors

VNil :: Vec Z a

(:::) :: a -> Vec n a -> Vec (S n) a infixr 5

Instances

SNatI n => Monad (Vec n)

Defined in Data.Vec.Lazy

Methods

(>>=) :: Vec n a -> (a -> Vec n b) -> Vec n b

(>>) :: Vec n a -> Vec n b -> Vec n b

return :: a -> Vec n a

fail :: String -> Vec n a

Functor (Vec n)

Defined in Data.Vec.Lazy

Methods

fmap :: (a -> b) -> Vec n a -> Vec n b

(<$) :: a -> Vec n b -> Vec n a

SNatI n => Applicative (Vec n)

Defined in Data.Vec.Lazy

Methods

pure :: a -> Vec n a

(<*>) :: Vec n (a -> b) -> Vec n a -> Vec n b

liftA2 :: (a -> b -> c) -> Vec n a -> Vec n b -> Vec n c

(*>) :: Vec n a -> Vec n b -> Vec n b

(<*) :: Vec n a -> Vec n b -> Vec n a

Foldable (Vec n)

Defined in Data.Vec.Lazy

Methods

fold :: Monoid m => Vec n m -> m

foldMap :: Monoid m => (a -> m) -> Vec n a -> m

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

foldr' :: (a -> b -> b) -> b -> Vec n a -> b

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

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

foldr1 :: (a -> a -> a) -> Vec n a -> a

foldl1 :: (a -> a -> a) -> Vec n a -> a

toList :: Vec n a -> [a]

null :: Vec n a -> Bool

length :: Vec n a -> Int

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

maximum :: Ord a => Vec n a -> a

minimum :: Ord a => Vec n a -> a

sum :: Num a => Vec n a -> a

product :: Num a => Vec n a -> a

Traversable (Vec n)

Defined in Data.Vec.Lazy

Methods

traverse :: Applicative f => (a -> f b) -> Vec n a -> f (Vec n b)

sequenceA :: Applicative f => Vec n (f a) -> f (Vec n a)

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

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

SNatI n => Arbitrary1 (Vec n)

Defined in Data.Vec.Lazy

Methods

liftArbitrary :: Gen a -> Gen (Vec n a)

liftShrink :: (a -> [a]) -> Vec n a -> [Vec n a]

SNatI n => Distributive (Vec n)

Defined in Data.Vec.Lazy

Methods

distribute :: Functor f => f (Vec n a) -> Vec n (f a)

collect :: Functor f => (a -> Vec n b) -> f a -> Vec n (f b)

distributeM :: Monad m => m (Vec n a) -> Vec n (m a)

collectM :: Monad m => (a -> Vec n b) -> m a -> Vec n (m b)

SNatI n => Representable (Vec n)

Defined in Data.Vec.Lazy

Associated Types

type Rep (Vec n) :: Type

Methods

tabulate :: (Rep (Vec n) -> a) -> Vec n a

index :: Vec n a -> Rep (Vec n) -> a

n ~ S m => Traversable1 (Vec n)

Defined in Data.Vec.Lazy

Methods

traverse1 :: Apply f => (a -> f b) -> Vec n a -> f (Vec n b)

sequence1 :: Apply f => Vec n (f b) -> f (Vec n b)

n ~ S m => Foldable1 (Vec n)

Defined in Data.Vec.Lazy

Methods

fold1 :: Semigroup m => Vec n m -> m

foldMap1 :: Semigroup m => (a -> m) -> Vec n a -> m

toNonEmpty :: Vec n a -> NonEmpty a

Apply (Vec n)

Defined in Data.Vec.Lazy

Methods

(<.>) :: Vec n (a -> b) -> Vec n a -> Vec n b

(.>) :: Vec n a -> Vec n b -> Vec n b

(<.) :: Vec n a -> Vec n b -> Vec n a

liftF2 :: (a -> b -> c) -> Vec n a -> Vec n b -> Vec n c

Bind (Vec n)

Defined in Data.Vec.Lazy

Methods

(>>-) :: Vec n a -> (a -> Vec n b) -> Vec n b

join :: Vec n (Vec n a) -> Vec n a

Eq a => Eq (Vec n a)

Defined in Data.Vec.Lazy

Methods

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

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

Ord a => Ord (Vec n a)

Defined in Data.Vec.Lazy

Methods

compare :: Vec n a -> Vec n a -> Ordering

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

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

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

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

max :: Vec n a -> Vec n a -> Vec n a

min :: Vec n a -> Vec n a -> Vec n a

Show a => Show (Vec n a)

Defined in Data.Vec.Lazy

Methods

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

show :: Vec n a -> String

showList :: [Vec n a] -> ShowS

Semigroup a => Semigroup (Vec n a)

Defined in Data.Vec.Lazy

Methods

(<>) :: Vec n a -> Vec n a -> Vec n a

sconcat :: NonEmpty (Vec n a) -> Vec n a

stimes :: Integral b => b -> Vec n a -> Vec n a

(Monoid a, SNatI n) => Monoid (Vec n a)

Defined in Data.Vec.Lazy

Methods

mempty :: Vec n a

mappend :: Vec n a -> Vec n a -> Vec n a

mconcat :: [Vec n a] -> Vec n a

(SNatI n, Function a) => Function (Vec n a)

Defined in Data.Vec.Lazy

Methods

function :: (Vec n a -> b) -> Vec n a :-> b

(SNatI n, Arbitrary a) => Arbitrary (Vec n a)

Defined in Data.Vec.Lazy

Methods

arbitrary :: Gen (Vec n a)

shrink :: Vec n a -> [Vec n a]

(SNatI n, CoArbitrary a) => CoArbitrary (Vec n a)

Defined in Data.Vec.Lazy

Methods

coarbitrary :: Vec n a -> Gen b -> Gen b

NFData a => NFData (Vec n a)

Defined in Data.Vec.Lazy

Methods

rnf :: Vec n a -> ()

Hashable a => Hashable (Vec n a)

Defined in Data.Vec.Lazy

Methods

hashWithSalt :: Int -> Vec n a -> Int

hash :: Vec n a -> Int

type Rep (Vec n)

Defined in Data.Vec.Lazy

type Rep (Vec n) = Fin n

Construction

empty :: Vec Z a

Empty Vec.

singleton :: a -> Vec (S Z) a

Vec with exactly one element.

>>> singleton True
True ::: VNil

Conversions

toPull :: forall n a. InlineInduction n => Vec n a -> Vec n a

Convert to pull Vec.

fromPull :: forall n a. InlineInduction n => Vec n a -> Vec n a

Convert from pull Vec.

toList :: forall n a. InlineInduction n => Vec n a -> [a]

Convert Vec to list.

>>> toList $ 'f' ::: 'o' ::: 'o' ::: VNil
"foo"

fromList :: InlineInduction n => [a] -> Maybe (Vec n a)

Convert list [a] to Vec n a. Returns Nothing if lengths don't match exactly.

>>> fromList "foo" :: Maybe (Vec N.Nat3 Char)
Just ('f' ::: 'o' ::: 'o' ::: VNil)

>>> fromList "quux" :: Maybe (Vec N.Nat3 Char)
Nothing

>>> fromList "xy" :: Maybe (Vec N.Nat3 Char)
Nothing

fromListPrefix :: InlineInduction n => [a] -> Maybe (Vec n a)

Convert list [a] to Vec n a. Returns Nothing if input list is too short.

>>> fromListPrefix "foo" :: Maybe (Vec N.Nat3 Char)
Just ('f' ::: 'o' ::: 'o' ::: VNil)

>>> fromListPrefix "quux" :: Maybe (Vec N.Nat3 Char)
Just ('q' ::: 'u' ::: 'u' ::: VNil)

>>> fromListPrefix "xy" :: Maybe (Vec N.Nat3 Char)
Nothing

reifyList :: [a] -> (forall n. InlineInduction n => Vec n a -> r) -> r

Reify any list [a] to Vec n a.

>>> reifyList "foo" length
3

Indexing

(!) :: InlineInduction n => Vec n a -> Fin n -> a

Indexing.

>>> ('a' ::: 'b' ::: 'c' ::: VNil) ! FS FZ
'b'

tabulate :: InlineInduction n => (Fin n -> a) -> Vec n a

Tabulating, inverse of !.

>>> tabulate id :: Vec N.Nat3 (Fin N.Nat3)
0 ::: 1 ::: 2 ::: VNil

cons :: a -> Vec n a -> Vec (S n) a

Cons an element in front of a Vec.

snoc :: forall n a. InlineInduction n => Vec n a -> a -> Vec (S n) a

Add a single element at the end of a Vec.

Since: 0.2.1

head :: Vec (S n) a -> a

The first element of a Vec.

tail :: Vec (S n) a -> Vec n a

The elements after the head of a Vec.

Concatenation and splitting

(++) :: forall n m a. InlineInduction n => Vec n a -> Vec m a -> Vec (Plus n m) a infixr 5

Append two Vec.

>>> ('a' ::: 'b' ::: VNil) ++ ('c' ::: 'd' ::: VNil)
'a' ::: 'b' ::: 'c' ::: 'd' ::: VNil

split :: InlineInduction n => Vec (Plus n m) a -> (Vec n a, Vec m a)

Split vector into two parts. Inverse of ++.

>>> split ('a' ::: 'b' ::: 'c' ::: VNil) :: (Vec N.Nat1 Char, Vec N.Nat2 Char)
('a' ::: VNil,'b' ::: 'c' ::: VNil)

>>> uncurry (++) (split ('a' ::: 'b' ::: 'c' ::: VNil) :: (Vec N.Nat1 Char, Vec N.Nat2 Char))
'a' ::: 'b' ::: 'c' ::: VNil

concatMap :: forall a b n m. (InlineInduction m, InlineInduction n) => (a -> Vec m b) -> Vec n a -> Vec (Mult n m) b

Map over all the elements of a Vec and concatenate the resulting Vecs.

>>> concatMap (\x -> x ::: x ::: VNil) ('a' ::: 'b' ::: VNil)
'a' ::: 'a' ::: 'b' ::: 'b' ::: VNil

concat :: (InlineInduction m, InlineInduction n) => Vec n (Vec m a) -> Vec (Mult n m) a

concatMap id

chunks :: (InlineInduction n, InlineInduction m) => Vec (Mult n m) a -> Vec n (Vec m a)

Inverse of concat.

>>> chunks <$> fromListPrefix [1..] :: Maybe (Vec N.Nat2 (Vec N.Nat3 Int))
Just ((1 ::: 2 ::: 3 ::: VNil) ::: (4 ::: 5 ::: 6 ::: VNil) ::: VNil)

>>> let idVec x = x :: Vec N.Nat2 (Vec N.Nat3 Int)
>>> concat . idVec . chunks <$> fromListPrefix [1..]
Just (1 ::: 2 ::: 3 ::: 4 ::: 5 ::: 6 ::: VNil)

Reverse

reverse :: forall n a. InlineInduction n => Vec n a -> Vec n a

Reverse Vec.

>>> reverse ('a' ::: 'b' ::: 'c' ::: VNil)
'c' ::: 'b' ::: 'a' ::: VNil

Since: 0.2.1

Folds

foldMap :: (Monoid m, InlineInduction n) => (a -> m) -> Vec n a -> m

See Foldable.

foldMap1 :: forall s a n. (Semigroup s, InlineInduction n) => (a -> s) -> Vec (S n) a -> s

See Foldable1.

ifoldMap :: forall a n m. (Monoid m, InlineInduction n) => (Fin n -> a -> m) -> Vec n a -> m

See FoldableWithIndex.

ifoldMap1 :: forall a n s. (Semigroup s, InlineInduction n) => (Fin (S n) -> a -> s) -> Vec (S n) a -> s

There is no type-class for this :(

foldr :: forall a b n. InlineInduction n => (a -> b -> b) -> b -> Vec n a -> b

Right fold.

ifoldr :: forall a b n. InlineInduction n => (Fin n -> a -> b -> b) -> b -> Vec n a -> b

Right fold with an index.

Special folds

length :: forall n a. InlineInduction n => Vec n a -> Int

Yield the length of a Vec. O(n)

null :: Vec n a -> Bool

Test whether a Vec is empty. O(1)

sum :: (Num a, InlineInduction n) => Vec n a -> a

Non-strict sum.

product :: (Num a, InlineInduction n) => Vec n a -> a

Non-strict product.

Mapping

map :: forall a b n. InlineInduction n => (a -> b) -> Vec n a -> Vec n b

>>> map not $ True ::: False ::: VNil
False ::: True ::: VNil

imap :: InlineInduction n => (Fin n -> a -> b) -> Vec n a -> Vec n b

>>> imap (,) $ 'a' ::: 'b' ::: 'c' ::: VNil
(0,'a') ::: (1,'b') ::: (2,'c') ::: VNil

traverse :: forall n f a b. (Applicative f, InlineInduction n) => (a -> f b) -> Vec n a -> f (Vec n b)

Apply an action to every element of a Vec, yielding a Vec of results.

traverse1 :: forall n f a b. (Apply f, InlineInduction n) => (a -> f b) -> Vec (S n) a -> f (Vec (S n) b)

Apply an action to non-empty Vec, yielding a Vec of results.

itraverse :: forall n f a b. (Applicative f, InlineInduction n) => (Fin n -> a -> f b) -> Vec n a -> f (Vec n b)

Apply an action to every element of a Vec and its index, yielding a Vec of results.

itraverse_ :: forall n f a b. (Applicative f, InlineInduction n) => (Fin n -> a -> f b) -> Vec n a -> f ()

Apply an action to every element of a Vec and its index, ignoring the results.

Zipping

zipWith :: forall a b c n. InlineInduction n => (a -> b -> c) -> Vec n a -> Vec n b -> Vec n c

Zip two Vecs with a function.

izipWith :: InlineInduction n => (Fin n -> a -> b -> c) -> Vec n a -> Vec n b -> Vec n c

Zip two Vecs. with a function that also takes the elements' indices.

repeat :: InlineInduction n => x -> Vec n x

Repeat value

>>> repeat 'x' :: Vec N.Nat3 Char
'x' ::: 'x' ::: 'x' ::: VNil

Since: 0.2.1

Monadic

bind :: InlineInduction n => Vec n a -> (a -> Vec n b) -> Vec n b

Monadic bind.

join :: InlineInduction n => Vec n (Vec n a) -> Vec n a

Monadic join.

>>> join $ ('a' ::: 'b' ::: VNil) ::: ('c' ::: 'd' ::: VNil) ::: VNil
'a' ::: 'd' ::: VNil

Universe

universe :: InlineInduction n => Vec n (Fin n)

Get all Fin n in a Vec n.

>>> universe :: Vec N.Nat3 (Fin N.Nat3)
0 ::: 1 ::: 2 ::: VNil

VecEach

class VecEach s t a b | s -> a, t -> b, s b -> t, t a -> s where

Write functions on Vec. Use them with tuples.

VecEach can be used to avoid "this function won't change the length of the list" in DSLs.

bad: Instead of

[x, y] <- badDslMagic ["foo", "bar"]  -- list!

good: we can write

(x, y) <- betterDslMagic ("foo", "bar") -- homogenic tuple!

where betterDslMagic can be defined using traverseWithVec.

Moreally lens Each should be a superclass, but there's no strict need for it.

Methods

mapWithVec :: (forall n. InlineInduction n => Vec n a -> Vec n b) -> s -> t

traverseWithVec :: Applicative f => (forall n. InlineInduction n => Vec n a -> f (Vec n b)) -> s -> f t

Instances

(a ~ a', b ~ b') => VecEach (a, a') (b, b') a b

Defined in Data.Vec.Lazy

Methods

mapWithVec :: (forall (n :: Nat). InlineInduction n => Vec n a -> Vec n b) -> (a, a') -> (b, b')

traverseWithVec :: Applicative f => (forall (n :: Nat). InlineInduction n => Vec n a -> f (Vec n b)) -> (a, a') -> f (b, b')

(a ~ a2, a ~ a3, b ~ b2, b ~ b3) => VecEach (a, a2, a3) (b, b2, b3) a b

Defined in Data.Vec.Lazy

Methods

mapWithVec :: (forall (n :: Nat). InlineInduction n => Vec n a -> Vec n b) -> (a, a2, a3) -> (b, b2, b3)

traverseWithVec :: Applicative f => (forall (n :: Nat). InlineInduction n => Vec n a -> f (Vec n b)) -> (a, a2, a3) -> f (b, b2, b3)

(a ~ a2, a ~ a3, a ~ a4, b ~ b2, b ~ b3, b ~ b4) => VecEach (a, a2, a3, a4) (b, b2, b3, b4) a b

Defined in Data.Vec.Lazy

Methods

mapWithVec :: (forall (n :: Nat). InlineInduction n => Vec n a -> Vec n b) -> (a, a2, a3, a4) -> (b, b2, b3, b4)

traverseWithVec :: Applicative f => (forall (n :: Nat). InlineInduction n => Vec n a -> f (Vec n b)) -> (a, a2, a3, a4) -> f (b, b2, b3, b4)