Data.Vector.Mutable.Linear

Mutable vectors with a linear API.

Vectors are arrays that grow automatically, that you can append to with push. They never shrink automatically to reduce unnecessary copying, use shrinkToFit to get rid of the wasted space.

To use mutable vectors, create a linear computation of type Vector a %1-> Ur b and feed it to constant or fromList.

Example

>>> :set -XLinearTypes
>>> import Prelude.Linear
>>> import qualified Data.Vector.Mutable.Linear as Vector
>>> :{
 isFirstZero :: Vector.Vector Int %1-> Ur Bool
 isFirstZero vec =
   Vector.get 0 vec
     & \(Ur ret, vec) -> vec `lseq` Ur (ret == 0)
:}

>>> unur $ Vector.fromList [0..10] isFirstZero
True
>>> unur $ Vector.fromList [1,2,3] isFirstZero
False

A mutable vector

data Vector a

A dynamic mutable vector.

Instances

Functor Vector

Defined in Data.Vector.Mutable.Linear

Methods

fmap :: (a %1 -> b) -> Vector a %1 -> Vector b

Semigroup (Vector a)

Defined in Data.Vector.Mutable.Linear

Methods

(<>) :: Vector a -> Vector a -> Vector a

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

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

Consumable (Vector a)

Defined in Data.Vector.Mutable.Linear

Methods

consume :: Vector a %1 -> ()

Semigroup (Vector a)

Defined in Data.Vector.Mutable.Linear

Methods

(<>) :: Vector a %1 -> Vector a %1 -> Vector a

Dupable (Vector a)

Defined in Data.Vector.Mutable.Linear

Methods

dupV :: forall (n :: Nat). KnownNat n => Vector a %1 -> V n (Vector a)

dup2 :: Vector a %1 -> (Vector a, Vector a)

Run a computation with a vector

empty :: (Vector a %1 -> Ur b) %1 -> Ur b

constant :: HasCallStack => Int -> a -> (Vector a %1 -> Ur b) %1 -> Ur b

Allocate a constant vector of a given non-negative size (and error on a bad size)

fromList :: HasCallStack => [a] -> (Vector a %1 -> Ur b) %1 -> Ur b

Allocator from a list

Mutators

set :: HasCallStack => Int -> a -> Vector a %1 -> Vector a

Write to an element . Note: this will not write to elements beyond the current size of the vector and will error instead.

unsafeSet :: HasCallStack => Int -> a -> Vector a %1 -> Vector a

Same as write, but does not do bounds-checking. The behaviour is undefined when passed an invalid index.

modify :: HasCallStack => (a -> (a, b)) -> Int -> Vector a %1 -> (Ur b, Vector a)

Modify a value inside a vector, with an ability to return an extra information. Errors if the index is out of bounds.

modify_ :: HasCallStack => (a -> a) -> Int -> Vector a %1 -> Vector a

Same as modify, but without the ability to return extra information.

push :: a -> Vector a %1 -> Vector a

Insert at the end of the vector. This will grow the vector if there is no empty space.

pop :: Vector a %1 -> (Ur (Maybe a), Vector a)

Pop from the end of the vector. This will never shrink the vector, use shrinkToFit to remove the wasted space.

filter :: Vector a %1 -> (a -> Bool) -> Vector a

Filters the vector in-place. It does not deallocate unused capacity, use shrinkToFit for that if necessary.

mapMaybe :: Vector a %1 -> (a -> Maybe b) -> Vector b

A version of fmap which can throw out elements.

slice :: Int -> Int -> Vector a %1 -> Vector a

Return a slice of the vector with given size, starting from an offset.

Start offset + target size should be within the input vector, and both should be non-negative.

This is a constant time operation if the start offset is 0. Use shrinkToFit to remove the possible wasted space if necessary.

shrinkToFit :: Vector a %1 -> Vector a

Resize the vector to not have any wasted memory (size == capacity). This returns a semantically identical vector.

Accessors

get :: HasCallStack => Int -> Vector a %1 -> (Ur a, Vector a)

Read from a vector, with an in-range index and error for an index that is out of range (with the usual range 0..size-1).

unsafeGet :: HasCallStack => Int -> Vector a %1 -> (Ur a, Vector a)

Same as read, but does not do bounds-checking. The behaviour is undefined when passed an invalid index.

size :: Vector a %1 -> (Ur Int, Vector a)

Number of elements inside the vector.

This might be different than how much actual memory the vector is using. For that, see: capacity.

capacity :: Vector a %1 -> (Ur Int, Vector a)

Capacity of a vector. In other words, the number of elements the vector can contain before it is copied to a bigger array.

toList :: Vector a %1 -> Ur [a]

Return the vector elements as a lazy list.

freeze :: Vector a %1 -> Ur (Vector a)

O(1) Convert a Vector to an immutable Vector (from vector package).

Mutable-style interface

read :: HasCallStack => Vector a %1 -> Int -> (Ur a, Vector a)

Same as get, but takes the Vector as the first parameter.

unsafeRead :: Vector a %1 -> Int -> (Ur a, Vector a)

Same as unsafeGet, but takes the Vector as the first parameter.

write :: HasCallStack => Vector a %1 -> Int -> a -> Vector a

Same as set, but takes the Vector as the first parameter.

unsafeWrite :: Vector a %1 -> Int -> a -> Vector a

Same as unsafeSafe, but takes the Vector as the first parameter.