Data.Vector.Circular

Types

data CircularVector a

A circular, immutable vector. This type is equivalent to cycle xs for some finite, nonempty xs, but with O(1) access and O(1) rotations. Indexing into this type is always total.

Constructors

CircularVector

Fields

• vector :: !(NonEmptyVector a)
• rotation :: !Int

Instances

Functor CircularVector

Defined in Data.Vector.Circular

Methods

fmap :: (a -> b) -> CircularVector a -> CircularVector b

(<$) :: a -> CircularVector b -> CircularVector a

Foldable CircularVector

Defined in Data.Vector.Circular

Methods

fold :: Monoid m => CircularVector m -> m

foldMap :: Monoid m => (a -> m) -> CircularVector a -> m

foldr :: (a -> b -> b) -> b -> CircularVector a -> b

foldr' :: (a -> b -> b) -> b -> CircularVector a -> b

foldl :: (b -> a -> b) -> b -> CircularVector a -> b

foldl' :: (b -> a -> b) -> b -> CircularVector a -> b

foldr1 :: (a -> a -> a) -> CircularVector a -> a

foldl1 :: (a -> a -> a) -> CircularVector a -> a

toList :: CircularVector a -> [a]

null :: CircularVector a -> Bool

length :: CircularVector a -> Int

elem :: Eq a => a -> CircularVector a -> Bool

maximum :: Ord a => CircularVector a -> a

minimum :: Ord a => CircularVector a -> a

sum :: Num a => CircularVector a -> a

product :: Num a => CircularVector a -> a

Foldable1 CircularVector

Defined in Data.Vector.Circular

Methods

fold1 :: Semigroup m => CircularVector m -> m

foldMap1 :: Semigroup m => (a -> m) -> CircularVector a -> m

toNonEmpty :: CircularVector a -> NonEmpty a

Eq a => Eq (CircularVector a)

Defined in Data.Vector.Circular

Methods

(==) :: CircularVector a -> CircularVector a -> Bool

(/=) :: CircularVector a -> CircularVector a -> Bool

Ord a => Ord (CircularVector a)

Defined in Data.Vector.Circular

Methods

compare :: CircularVector a -> CircularVector a -> Ordering

(<) :: CircularVector a -> CircularVector a -> Bool

(<=) :: CircularVector a -> CircularVector a -> Bool

(>) :: CircularVector a -> CircularVector a -> Bool

(>=) :: CircularVector a -> CircularVector a -> Bool

max :: CircularVector a -> CircularVector a -> CircularVector a

min :: CircularVector a -> CircularVector a -> CircularVector a

Read a => Read (CircularVector a)

Defined in Data.Vector.Circular

Methods

readsPrec :: Int -> ReadS (CircularVector a)

readList :: ReadS [CircularVector a]

readPrec :: ReadPrec (CircularVector a)

readListPrec :: ReadPrec [CircularVector a]

Show a => Show (CircularVector a)

Defined in Data.Vector.Circular

Methods

showsPrec :: Int -> CircularVector a -> ShowS

show :: CircularVector a -> String

showList :: [CircularVector a] -> ShowS

Semigroup (CircularVector a)

The Semigroup (<>) operation behaves by un-rolling the two vectors so that their rotation is 0, concatenating them, returning a new vector with a 0-rotation.

Defined in Data.Vector.Circular

Methods

(<>) :: CircularVector a -> CircularVector a -> CircularVector a

sconcat :: NonEmpty (CircularVector a) -> CircularVector a

stimes :: Integral b => b -> CircularVector a -> CircularVector a

Lift a => Lift (CircularVector a)

Defined in Data.Vector.Circular

Methods

lift :: CircularVector a -> Q Exp

Construction

singleton :: a -> CircularVector a

Construct a singleton 'CircularVector.

toVector :: CircularVector a -> Vector a

Construct a Vector from a CircularVector.

fromVector :: NonEmptyVector a -> CircularVector a

Construct a CircularVector from a NonEmptyVector.

unsafeFromVector :: Vector a -> CircularVector a

Construct a CircularVector from a Vector.

Calls error if the input vector is empty.

fromList :: [a] -> Maybe (CircularVector a)

Construct a CircularVector from a list.

fromListN :: Int -> [a] -> Maybe (CircularVector a)

Construct a CircularVector from a list with a size hint.

unsafeFromList :: [a] -> CircularVector a

Construct a CircularVector from a list.

Calls error if the input list is empty.

unsafeFromListN :: Int -> [a] -> CircularVector a

Construct a CircularVector from a list with a size hint.

Calls error if the input list is empty, or if the size hint is <= 0.

vec :: Lift a => [a] -> Q (TExp (CircularVector a))

Construct a CircularVector at compile-time using typed Template Haskell.

TODO: show examples

Rotation

rotateLeft :: Int -> CircularVector a -> CircularVector a

Rotate the vector to the left by n number of elements.

Note: Left rotations start to break down due to arithmetic underflow when the size of the input vector is > maxBound Int@

rotateRight :: Int -> CircularVector a -> CircularVector a

Rotate the vector to left by n number of elements.

Note: Right rotations start to break down due to arithmetic overflow when the size of the input vector is > maxBound Int@

Comparisons

equivalent :: Ord a => CircularVector a -> CircularVector a -> Bool

canonise :: Ord a => CircularVector a -> CircularVector a

leastRotation :: forall a. Ord a => Vector a -> Int

Folds

foldMap :: Monoid m => (a -> m) -> CircularVector a -> m

Lazily-accumulating monoidal fold over a CircularVector.

foldMap' :: Monoid m => (a -> m) -> CircularVector a -> m

Strictly-accumulating monoidal fold over a CircularVector.

foldr :: (a -> b -> b) -> b -> CircularVector a -> b

foldl :: (b -> a -> b) -> b -> CircularVector a -> b

foldr' :: (a -> b -> b) -> b -> CircularVector a -> b

foldl' :: (b -> a -> b) -> b -> CircularVector a -> b

foldr1 :: (a -> a -> a) -> CircularVector a -> a

foldl1 :: (a -> a -> a) -> CircularVector a -> a

foldMap1 :: Semigroup m => (a -> m) -> CircularVector a -> m

Lazily-accumulating semigroupoidal fold over a CircularVector.

foldMap1' :: Semigroup m => (a -> m) -> CircularVector a -> m

Strictly-accumulating semigroupoidal fold over a CircularVector.

toNonEmpty :: CircularVector a -> NonEmpty a

Indexing

index :: CircularVector a -> Int -> a

Index into a CircularVector. This is always total.

head :: CircularVector a -> a

Get the first element of a CircularVector. This is always total.

last :: CircularVector a -> a

Get the last element of a CircularVector. This is always total.