primitive-0.6.3.0: Primitive memory-related operations

Copyright(c) Roman Leshchinskiy 2009-2012
LicenseBSD-style
MaintainerRoman Leshchinskiy <rl@cse.unsw.edu.au>
Portabilitynon-portable
Safe HaskellNone
LanguageHaskell2010

Data.Primitive.Array

Description

Primitive arrays of boxed values.

Synopsis

Documentation

data Array a Source #

Boxed arrays

Constructors

Array 

Fields

Instances
Monad Array Source # 
Instance details

Defined in Data.Primitive.Array

Methods

(>>=) :: Array a -> (a -> Array b) -> Array b Source #

(>>) :: Array a -> Array b -> Array b Source #

return :: a -> Array a Source #

fail :: String -> Array a Source #

Functor Array Source # 
Instance details

Defined in Data.Primitive.Array

Methods

fmap :: (a -> b) -> Array a -> Array b Source #

(<$) :: a -> Array b -> Array a Source #

MonadFix Array Source # 
Instance details

Defined in Data.Primitive.Array

Methods

mfix :: (a -> Array a) -> Array a Source #

Applicative Array Source # 
Instance details

Defined in Data.Primitive.Array

Methods

pure :: a -> Array a Source #

(<*>) :: Array (a -> b) -> Array a -> Array b Source #

liftA2 :: (a -> b -> c) -> Array a -> Array b -> Array c Source #

(*>) :: Array a -> Array b -> Array b Source #

(<*) :: Array a -> Array b -> Array a Source #

Foldable Array Source # 
Instance details

Defined in Data.Primitive.Array

Methods

fold :: Monoid m => Array m -> m Source #

foldMap :: Monoid m => (a -> m) -> Array a -> m Source #

foldr :: (a -> b -> b) -> b -> Array a -> b Source #

foldr' :: (a -> b -> b) -> b -> Array a -> b Source #

foldl :: (b -> a -> b) -> b -> Array a -> b Source #

foldl' :: (b -> a -> b) -> b -> Array a -> b Source #

foldr1 :: (a -> a -> a) -> Array a -> a Source #

foldl1 :: (a -> a -> a) -> Array a -> a Source #

toList :: Array a -> [a] Source #

null :: Array a -> Bool Source #

length :: Array a -> Int Source #

elem :: Eq a => a -> Array a -> Bool Source #

maximum :: Ord a => Array a -> a Source #

minimum :: Ord a => Array a -> a Source #

sum :: Num a => Array a -> a Source #

product :: Num a => Array a -> a Source #

Traversable Array Source # 
Instance details

Defined in Data.Primitive.Array

Methods

traverse :: Applicative f => (a -> f b) -> Array a -> f (Array b) Source #

sequenceA :: Applicative f => Array (f a) -> f (Array a) Source #

mapM :: Monad m => (a -> m b) -> Array a -> m (Array b) Source #

sequence :: Monad m => Array (m a) -> m (Array a) Source #

MonadZip Array Source # 
Instance details

Defined in Data.Primitive.Array

Methods

mzip :: Array a -> Array b -> Array (a, b) Source #

mzipWith :: (a -> b -> c) -> Array a -> Array b -> Array c Source #

munzip :: Array (a, b) -> (Array a, Array b) Source #

Alternative Array Source # 
Instance details

Defined in Data.Primitive.Array

Methods

empty :: Array a Source #

(<|>) :: Array a -> Array a -> Array a Source #

some :: Array a -> Array [a] Source #

many :: Array a -> Array [a] Source #

MonadPlus Array Source # 
Instance details

Defined in Data.Primitive.Array

Methods

mzero :: Array a Source #

mplus :: Array a -> Array a -> Array a Source #

IsList (Array a) Source # 
Instance details

Defined in Data.Primitive.Array

Associated Types

type Item (Array a) :: Type Source #

Methods

fromList :: [Item (Array a)] -> Array a Source #

fromListN :: Int -> [Item (Array a)] -> Array a Source #

toList :: Array a -> [Item (Array a)] Source #

Eq a => Eq (Array a) Source # 
Instance details

Defined in Data.Primitive.Array

Methods

(==) :: Array a -> Array a -> Bool Source #

(/=) :: Array a -> Array a -> Bool Source #

Data a => Data (Array a) Source # 
Instance details

Defined in Data.Primitive.Array

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Array a -> c (Array a) Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Array a) Source #

toConstr :: Array a -> Constr Source #

dataTypeOf :: Array a -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Array a)) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Array a)) Source #

gmapT :: (forall b. Data b => b -> b) -> Array a -> Array a Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Array a -> r Source #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Array a -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> Array a -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Array a -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Array a -> m (Array a) Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Array a -> m (Array a) Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Array a -> m (Array a) Source #

Ord a => Ord (Array a) Source # 
Instance details

Defined in Data.Primitive.Array

Methods

compare :: Array a -> Array a -> Ordering Source #

(<) :: Array a -> Array a -> Bool Source #

(<=) :: Array a -> Array a -> Bool Source #

(>) :: Array a -> Array a -> Bool Source #

(>=) :: Array a -> Array a -> Bool Source #

max :: Array a -> Array a -> Array a Source #

min :: Array a -> Array a -> Array a Source #

Read a => Read (Array a) Source # 
Instance details

Defined in Data.Primitive.Array

Show a => Show (Array a) Source # 
Instance details

Defined in Data.Primitive.Array

Semigroup (Array a) Source # 
Instance details

Defined in Data.Primitive.Array

Methods

(<>) :: Array a -> Array a -> Array a Source #

sconcat :: NonEmpty (Array a) -> Array a Source #

stimes :: Integral b => b -> Array a -> Array a Source #

Monoid (Array a) Source # 
Instance details

Defined in Data.Primitive.Array

Methods

mempty :: Array a Source #

mappend :: Array a -> Array a -> Array a Source #

mconcat :: [Array a] -> Array a Source #

PrimUnlifted (Array a) Source # 
Instance details

Defined in Data.Primitive.UnliftedArray

type Item (Array a) Source # 
Instance details

Defined in Data.Primitive.Array

type Item (Array a) = a

data MutableArray s a Source #

Mutable boxed arrays associated with a primitive state token.

Constructors

MutableArray 

Fields

Instances
Eq (MutableArray s a) Source # 
Instance details

Defined in Data.Primitive.Array

(Typeable s, Typeable a) => Data (MutableArray s a) Source # 
Instance details

Defined in Data.Primitive.Array

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MutableArray s a -> c (MutableArray s a) Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (MutableArray s a) Source #

toConstr :: MutableArray s a -> Constr Source #

dataTypeOf :: MutableArray s a -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (MutableArray s a)) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (MutableArray s a)) Source #

gmapT :: (forall b. Data b => b -> b) -> MutableArray s a -> MutableArray s a Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MutableArray s a -> r Source #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MutableArray s a -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> MutableArray s a -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> MutableArray s a -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MutableArray s a -> m (MutableArray s a) Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MutableArray s a -> m (MutableArray s a) Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MutableArray s a -> m (MutableArray s a) Source #

PrimUnlifted (MutableArray s a) Source # 
Instance details

Defined in Data.Primitive.UnliftedArray

newArray :: PrimMonad m => Int -> a -> m (MutableArray (PrimState m) a) Source #

Create a new mutable array of the specified size and initialise all elements with the given value.

readArray :: PrimMonad m => MutableArray (PrimState m) a -> Int -> m a Source #

Read a value from the array at the given index.

writeArray :: PrimMonad m => MutableArray (PrimState m) a -> Int -> a -> m () Source #

Write a value to the array at the given index.

indexArray :: Array a -> Int -> a Source #

Read a value from the immutable array at the given index.

indexArrayM :: Monad m => Array a -> Int -> m a Source #

Monadically read a value from the immutable array at the given index. This allows us to be strict in the array while remaining lazy in the read element which is very useful for collective operations. Suppose we want to copy an array. We could do something like this:

copy marr arr ... = do ...
                       writeArray marr i (indexArray arr i) ...
                       ...

But since primitive arrays are lazy, the calls to indexArray will not be evaluated. Rather, marr will be filled with thunks each of which would retain a reference to arr. This is definitely not what we want!

With indexArrayM, we can instead write

copy marr arr ... = do ...
                       x <- indexArrayM arr i
                       writeArray marr i x
                       ...

Now, indexing is executed immediately although the returned element is still not evaluated.

freezeArray Source #

Arguments

:: PrimMonad m 
=> MutableArray (PrimState m) a

source

-> Int

offset

-> Int

length

-> m (Array a) 

Create an immutable copy of a slice of an array.

This operation makes a copy of the specified section, so it is safe to continue using the mutable array afterward.

thawArray Source #

Arguments

:: PrimMonad m 
=> Array a

source

-> Int

offset

-> Int

length

-> m (MutableArray (PrimState m) a) 

Create a mutable array from a slice of an immutable array.

This operation makes a copy of the specified slice, so it is safe to use the immutable array afterward.

unsafeFreezeArray :: PrimMonad m => MutableArray (PrimState m) a -> m (Array a) Source #

Convert a mutable array to an immutable one without copying. The array should not be modified after the conversion.

unsafeThawArray :: PrimMonad m => Array a -> m (MutableArray (PrimState m) a) Source #

Convert an immutable array to an mutable one without copying. The immutable array should not be used after the conversion.

sameMutableArray :: MutableArray s a -> MutableArray s a -> Bool Source #

Check whether the two arrays refer to the same memory block.

copyArray Source #

Arguments

:: PrimMonad m 
=> MutableArray (PrimState m) a

destination array

-> Int

offset into destination array

-> Array a

source array

-> Int

offset into source array

-> Int

number of elements to copy

-> m () 

Copy a slice of an immutable array to a mutable array.

copyMutableArray Source #

Arguments

:: PrimMonad m 
=> MutableArray (PrimState m) a

destination array

-> Int

offset into destination array

-> MutableArray (PrimState m) a

source array

-> Int

offset into source array

-> Int

number of elements to copy

-> m () 

Copy a slice of a mutable array to another array. The two arrays may not be the same.

cloneArray Source #

Arguments

:: Array a

source array

-> Int

offset into destination array

-> Int

number of elements to copy

-> Array a 

Return a newly allocated Array with the specified subrange of the provided Array. The provided Array should contain the full subrange specified by the two Ints, but this is not checked.

cloneMutableArray Source #

Arguments

:: PrimMonad m 
=> MutableArray (PrimState m) a

source array

-> Int

offset into destination array

-> Int

number of elements to copy

-> m (MutableArray (PrimState m) a) 

Return a newly allocated MutableArray. with the specified subrange of the provided MutableArray. The provided MutableArray should contain the full subrange specified by the two Ints, but this is not checked.

fromListN :: IsList l => Int -> [Item l] -> l Source #

The fromListN function takes the input list's length as a hint. Its behaviour should be equivalent to fromList. The hint can be used to construct the structure l more efficiently compared to fromList. If the given hint does not equal to the input list's length the behaviour of fromListN is not specified.

fromList :: IsList l => [Item l] -> l Source #

The fromList function constructs the structure l from the given list of Item l