Safe Haskell	None
Language	Haskell2010

Data.Array.ShapedS

Synopsis

type ShapeL = [Int]
class Vector v
class Typeable s => Shape (s :: [Nat]) where
- shapeP :: Proxy s -> [Int]
- sizeP :: Proxy s -> Int
class Stride (ts :: [Nat]) (ss :: [Nat]) (rs :: [Nat]) | ts ss -> rs
class Window (ws :: [Nat]) (ss :: [Nat]) (rs :: [Nat]) | ws ss -> rs
class ValidDims (rs :: [Nat]) (sh :: [Nat])
type Permute (is :: [Nat]) (xs :: [Nat]) = Permute' is (Take (Rank is) xs) ++ Drop (Rank is) xs
class Permutation (is :: [Nat])
type Size (s :: [Nat]) = Size' 1 s
type family Rank (s :: [Nat]) :: Nat where ...
data Array sh a
type Unbox = Storable
size :: forall sh a. Shape sh => Array sh a -> Int
shapeL :: Shape sh => Array sh a -> ShapeL
rank :: (Shape sh, KnownNat (Rank sh)) => Array sh a -> Int
index :: (Unbox a, KnownNat s) => Array (s ': sh) a -> Int -> Array sh a
toList :: forall sh a. (Unbox a, Shape sh) => Array sh a -> [a]
fromList :: forall sh a. (HasCallStack, Unbox a, Shape sh) => [a] -> Array sh a
toVector :: (Unbox a, Shape sh) => Array sh a -> Vector a
fromVector :: forall sh a. (HasCallStack, Unbox a, Shape sh) => Vector a -> Array sh a
normalize :: (Unbox a, Shape sh) => Array sh a -> Array sh a
reshape :: forall sh' sh a. (Unbox a, Shape sh, Shape sh', Size sh ~ Size sh') => Array sh a -> Array sh' a
stretch :: forall sh' sh a. (Shape sh, Shape sh', ValidStretch sh sh') => Array sh a -> Array sh' a
stretchOuter :: (KnownNat s, Shape sh) => Array (1 ': sh) a -> Array (s ': sh) a
scalar :: Unbox a => a -> Array '[] a
unScalar :: Unbox a => Array '[] a -> a
constant :: forall sh a. (Unbox a, Shape sh) => a -> Array sh a
mapA :: (Unbox a, Unbox b, Shape sh) => (a -> b) -> Array sh a -> Array sh b
zipWithA :: (Unbox a, Unbox b, Unbox c, Shape sh) => (a -> b -> c) -> Array sh a -> Array sh b -> Array sh c
zipWith3A :: (Unbox a, Unbox b, Unbox c, Unbox d, Shape sh) => (a -> b -> c -> d) -> Array sh a -> Array sh b -> Array sh c -> Array sh d
pad :: forall ps sh' sh a. (Unbox a, Padded ps sh sh', Shape sh) => a -> Array sh a -> Array sh' a
transpose :: forall is sh a. (Permutation is, Rank is <= Rank sh, Shape sh, Shape is, KnownNat (Rank sh)) => Array sh a -> Array (Permute is sh) a
append :: (Unbox a, Shape sh, KnownNat m, KnownNat n, KnownNat (m + n)) => Array (m ': sh) a -> Array (n ': sh) a -> Array ((m + n) ': sh) a
ravel :: (Unbox a, Shape sh, KnownNat s) => Array '[s] (Array sh a) -> Array (s ': sh) a
unravel :: (Unbox a, Shape sh, KnownNat s) => Array (s ': sh) a -> Array '[s] (Array sh a)
window :: forall ws sh' sh a. (Window ws sh sh', KnownNat (Rank ws)) => Array sh a -> Array sh' a
stride :: forall ts sh' sh a. (Stride ts sh sh', Shape ts) => Array sh a -> Array sh' a
slice :: forall sl sh' sh a. Slice sl sh sh' => Array sh a -> Array sh' a
rerank :: forall n i o sh a b. (Unbox a, Unbox b, Drop n sh ~ i, Shape sh, KnownNat n, Shape o, Shape (Take n sh ++ o)) => (Array i a -> Array o b) -> Array sh a -> Array (Take n sh ++ o) b
rerank2 :: forall n i o sh a b c. (Unbox a, Unbox b, Unbox c, Drop n sh ~ i, Shape sh, KnownNat n, Shape o, Shape (Take n sh ++ o)) => (Array i a -> Array i b -> Array o c) -> Array sh a -> Array sh b -> Array (Take n sh ++ o) c
rev :: forall rs sh a. (ValidDims rs sh, Shape rs, Shape sh) => Array sh a -> Array sh a
reduce :: (Unbox a, Shape sh) => (a -> a -> a) -> a -> Array sh a -> Array '[] a
foldrA :: (Unbox a, Shape sh) => (a -> b -> b) -> b -> Array sh a -> b
traverseA :: (Unbox a, Unbox b, Applicative f, Shape sh) => (a -> f b) -> Array sh a -> f (Array sh b)
allSameA :: (Shape sh, Unbox a, Eq a) => Array sh a -> Bool
sumA :: (Unbox a, Num a, Shape sh) => Array sh a -> a
productA :: (Unbox a, Num a, Shape sh) => Array sh a -> a
maximumA :: (Unbox a, Ord a, Shape sh, 1 <= Size sh) => Array sh a -> a
minimumA :: (Unbox a, Ord a, Shape sh, 1 <= Size sh) => Array sh a -> a
anyA :: (Shape sh, Unbox a) => (a -> Bool) -> Array sh a -> Bool
allA :: (Shape sh, Unbox a) => (a -> Bool) -> Array sh a -> Bool
broadcast :: forall ds sh' sh a. (Unbox a, Shape sh, Shape sh', Broadcast ds sh sh') => Array sh a -> Array sh' a
generate :: (Unbox a, Shape sh) => ([Int] -> a) -> Array sh a
iterateN :: forall n a. (Unbox a, KnownNat n) => (a -> a) -> a -> Array '[n] a
iota :: (KnownNat n, Unbox a, Enum a, Num a) => Array '[n] a

Documentation

type ShapeL = [Int] Source #

The shape of an array is a list of its dimensions.

class Vector v Source #

The Vector class is the interface to the underlying storage for the arrays. The operations map straight to operations for Vector.

Minimal complete definition

vIndex, vLength, vToList, vFromList, vSingleton, vReplicate, vMap, vZipWith, vZipWith3, vZipWith4, vZipWith5, vAppend, vConcat, vFold, vSlice, vSum, vProduct, vMaximum, vMinimum, vUpdate, vGenerate, vAll, vAny

Instances

Instances details

Vector [] Source #
Instance details Defined in Data.Array.Internal Associated Types type VecElem [] :: Type -> Constraint Source # Methods vIndex :: VecElem [] a => [a] -> Int -> a Source # vLength :: VecElem [] a => [a] -> Int Source # vToList :: VecElem [] a => [a] -> [a] Source # vFromList :: VecElem [] a => [a] -> [a] Source # vSingleton :: VecElem [] a => a -> [a] Source # vReplicate :: VecElem [] a => Int -> a -> [a] Source # vMap :: (VecElem [] a, VecElem [] b) => (a -> b) -> [a] -> [b] Source # vZipWith :: (VecElem [] a, VecElem [] b, VecElem [] c) => (a -> b -> c) -> [a] -> [b] -> [c] Source # vZipWith3 :: (VecElem [] a, VecElem [] b, VecElem [] c, VecElem [] d) => (a -> b -> c -> d) -> [a] -> [b] -> [c] -> [d] Source # vZipWith4 :: (VecElem [] a, VecElem [] b, VecElem [] c, VecElem [] d, VecElem [] e) => (a -> b -> c -> d -> e) -> [a] -> [b] -> [c] -> [d] -> [e] Source # vZipWith5 :: (VecElem [] a, VecElem [] b, VecElem [] c, VecElem [] d, VecElem [] e, VecElem [] f) => (a -> b -> c -> d -> e -> f) -> [a] -> [b] -> [c] -> [d] -> [e] -> [f] Source # vAppend :: VecElem [] a => [a] -> [a] -> [a] Source # vConcat :: VecElem [] a => [[a]] -> [a] Source # vFold :: VecElem [] a => (a -> a -> a) -> a -> [a] -> a Source # vSlice :: VecElem [] a => Int -> Int -> [a] -> [a] Source # vSum :: (VecElem [] a, Num a) => [a] -> a Source # vProduct :: (VecElem [] a, Num a) => [a] -> a Source # vMaximum :: (VecElem [] a, Ord a) => [a] -> a Source # vMinimum :: (VecElem [] a, Ord a) => [a] -> a Source # vUpdate :: VecElem [] a => [a] -> [(Int, a)] -> [a] Source # vGenerate :: VecElem [] a => Int -> (Int -> a) -> [a] Source # vAll :: VecElem [] a => (a -> Bool) -> [a] -> Bool Source # vAny :: VecElem [] a => (a -> Bool) -> [a] -> Bool Source #
Vector Vector Source #
Instance details Defined in Data.Array.Internal.DynamicU Associated Types type VecElem Vector :: Type -> Constraint Source # Methods vIndex :: VecElem Vector a => Vector a -> Int -> a Source # vLength :: VecElem Vector a => Vector a -> Int Source # vToList :: VecElem Vector a => Vector a -> [a] Source # vFromList :: VecElem Vector a => [a] -> Vector a Source # vSingleton :: VecElem Vector a => a -> Vector a Source # vReplicate :: VecElem Vector a => Int -> a -> Vector a Source # vMap :: (VecElem Vector a, VecElem Vector b) => (a -> b) -> Vector a -> Vector b Source # vZipWith :: (VecElem Vector a, VecElem Vector b, VecElem Vector c) => (a -> b -> c) -> Vector a -> Vector b -> Vector c Source # vZipWith3 :: (VecElem Vector a, VecElem Vector b, VecElem Vector c, VecElem Vector d) => (a -> b -> c -> d) -> Vector a -> Vector b -> Vector c -> Vector d Source # vZipWith4 :: (VecElem Vector a, VecElem Vector b, VecElem Vector c, VecElem Vector d, VecElem Vector e) => (a -> b -> c -> d -> e) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e Source # vZipWith5 :: (VecElem Vector a, VecElem Vector b, VecElem Vector c, VecElem Vector d, VecElem Vector e, VecElem Vector f) => (a -> b -> c -> d -> e -> f) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f Source # vAppend :: VecElem Vector a => Vector a -> Vector a -> Vector a Source # vConcat :: VecElem Vector a => [Vector a] -> Vector a Source # vFold :: VecElem Vector a => (a -> a -> a) -> a -> Vector a -> a Source # vSlice :: VecElem Vector a => Int -> Int -> Vector a -> Vector a Source # vSum :: (VecElem Vector a, Num a) => Vector a -> a Source # vProduct :: (VecElem Vector a, Num a) => Vector a -> a Source # vMaximum :: (VecElem Vector a, Ord a) => Vector a -> a Source # vMinimum :: (VecElem Vector a, Ord a) => Vector a -> a Source # vUpdate :: VecElem Vector a => Vector a -> [(Int, a)] -> Vector a Source # vGenerate :: VecElem Vector a => Int -> (Int -> a) -> Vector a Source # vAll :: VecElem Vector a => (a -> Bool) -> Vector a -> Bool Source # vAny :: VecElem Vector a => (a -> Bool) -> Vector a -> Bool Source #
Vector Vector Source #
Instance details Defined in Data.Array.Internal.DynamicS Associated Types type VecElem Vector :: Type -> Constraint Source # Methods vIndex :: VecElem Vector a => Vector a -> Int -> a Source # vLength :: VecElem Vector a => Vector a -> Int Source # vToList :: VecElem Vector a => Vector a -> [a] Source # vFromList :: VecElem Vector a => [a] -> Vector a Source # vSingleton :: VecElem Vector a => a -> Vector a Source # vReplicate :: VecElem Vector a => Int -> a -> Vector a Source # vMap :: (VecElem Vector a, VecElem Vector b) => (a -> b) -> Vector a -> Vector b Source # vZipWith :: (VecElem Vector a, VecElem Vector b, VecElem Vector c) => (a -> b -> c) -> Vector a -> Vector b -> Vector c Source # vZipWith3 :: (VecElem Vector a, VecElem Vector b, VecElem Vector c, VecElem Vector d) => (a -> b -> c -> d) -> Vector a -> Vector b -> Vector c -> Vector d Source # vZipWith4 :: (VecElem Vector a, VecElem Vector b, VecElem Vector c, VecElem Vector d, VecElem Vector e) => (a -> b -> c -> d -> e) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e Source # vZipWith5 :: (VecElem Vector a, VecElem Vector b, VecElem Vector c, VecElem Vector d, VecElem Vector e, VecElem Vector f) => (a -> b -> c -> d -> e -> f) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f Source # vAppend :: VecElem Vector a => Vector a -> Vector a -> Vector a Source # vConcat :: VecElem Vector a => [Vector a] -> Vector a Source # vFold :: VecElem Vector a => (a -> a -> a) -> a -> Vector a -> a Source # vSlice :: VecElem Vector a => Int -> Int -> Vector a -> Vector a Source # vSum :: (VecElem Vector a, Num a) => Vector a -> a Source # vProduct :: (VecElem Vector a, Num a) => Vector a -> a Source # vMaximum :: (VecElem Vector a, Ord a) => Vector a -> a Source # vMinimum :: (VecElem Vector a, Ord a) => Vector a -> a Source # vUpdate :: VecElem Vector a => Vector a -> [(Int, a)] -> Vector a Source # vGenerate :: VecElem Vector a => Int -> (Int -> a) -> Vector a Source # vAll :: VecElem Vector a => (a -> Bool) -> Vector a -> Bool Source # vAny :: VecElem Vector a => (a -> Bool) -> Vector a -> Bool Source #
Vector Vector Source #
Instance details Defined in Data.Array.Internal.Dynamic Associated Types type VecElem Vector :: Type -> Constraint Source # Methods vIndex :: VecElem Vector a => Vector a -> Int -> a Source # vLength :: VecElem Vector a => Vector a -> Int Source # vToList :: VecElem Vector a => Vector a -> [a] Source # vFromList :: VecElem Vector a => [a] -> Vector a Source # vSingleton :: VecElem Vector a => a -> Vector a Source # vReplicate :: VecElem Vector a => Int -> a -> Vector a Source # vMap :: (VecElem Vector a, VecElem Vector b) => (a -> b) -> Vector a -> Vector b Source # vZipWith :: (VecElem Vector a, VecElem Vector b, VecElem Vector c) => (a -> b -> c) -> Vector a -> Vector b -> Vector c Source # vZipWith3 :: (VecElem Vector a, VecElem Vector b, VecElem Vector c, VecElem Vector d) => (a -> b -> c -> d) -> Vector a -> Vector b -> Vector c -> Vector d Source # vZipWith4 :: (VecElem Vector a, VecElem Vector b, VecElem Vector c, VecElem Vector d, VecElem Vector e) => (a -> b -> c -> d -> e) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e Source # vZipWith5 :: (VecElem Vector a, VecElem Vector b, VecElem Vector c, VecElem Vector d, VecElem Vector e, VecElem Vector f) => (a -> b -> c -> d -> e -> f) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f Source # vAppend :: VecElem Vector a => Vector a -> Vector a -> Vector a Source # vConcat :: VecElem Vector a => [Vector a] -> Vector a Source # vFold :: VecElem Vector a => (a -> a -> a) -> a -> Vector a -> a Source # vSlice :: VecElem Vector a => Int -> Int -> Vector a -> Vector a Source # vSum :: (VecElem Vector a, Num a) => Vector a -> a Source # vProduct :: (VecElem Vector a, Num a) => Vector a -> a Source # vMaximum :: (VecElem Vector a, Ord a) => Vector a -> a Source # vMinimum :: (VecElem Vector a, Ord a) => Vector a -> a Source # vUpdate :: VecElem Vector a => Vector a -> [(Int, a)] -> Vector a Source # vGenerate :: VecElem Vector a => Int -> (Int -> a) -> Vector a Source # vAll :: VecElem Vector a => (a -> Bool) -> Vector a -> Bool Source # vAny :: VecElem Vector a => (a -> Bool) -> Vector a -> Bool Source #

class Typeable s => Shape (s :: [Nat]) where Source #

Methods

shapeP :: Proxy s -> [Int] Source #

sizeP :: Proxy s -> Int Source #

Instances

Instances details

Shape ('[] :: [Nat]) Source #
Instance details Defined in Data.Array.Internal.Shape Methods shapeP :: Proxy '[] -> [Int] Source # sizeP :: Proxy '[] -> Int Source #
(Shape s, KnownNat n) => Shape (n ': s) Source #
Instance details Defined in Data.Array.Internal.Shape Methods shapeP :: Proxy (n ': s) -> [Int] Source # sizeP :: Proxy (n ': s) -> Int Source #

class Stride (ts :: [Nat]) (ss :: [Nat]) (rs :: [Nat]) | ts ss -> rs Source #

Instances

Instances details

Stride ('[] :: [Nat]) ss ss Source #
Instance details Defined in Data.Array.Internal.Shape
(Stride ts ss rs, DivRoundUp s t ~ r) => Stride (t ': ts) (s ': ss) (r ': rs) Source #
Instance details Defined in Data.Array.Internal.Shape

class Window (ws :: [Nat]) (ss :: [Nat]) (rs :: [Nat]) | ws ss -> rs Source #

Instances

Instances details

Window' ws ws ss rs => Window ws ss rs Source #
Instance details Defined in Data.Array.Internal.Shape

class ValidDims (rs :: [Nat]) (sh :: [Nat]) Source #

Instances

Instances details

AllElem rs (Count 0 sh) => ValidDims rs sh Source #
Instance details Defined in Data.Array.Internal.Shape

type Permute (is :: [Nat]) (xs :: [Nat]) = Permute' is (Take (Rank is) xs) ++ Drop (Rank is) xs Source #

class Permutation (is :: [Nat]) Source #

Instances

Instances details

AllElem is (Count 0 is) => Permutation is Source #
Instance details Defined in Data.Array.Internal.Shape

type Size (s :: [Nat]) = Size' 1 s Source #

Compute the size, i.e., total number of elements of a type level shape.

type family Rank (s :: [Nat]) :: Nat where ... Source #

Compute the rank, i.e., length of a type level shape.

Equations

Rank '[] = 0
Rank (n ': ns) = 1 + Rank ns

data Array sh a Source #

Instances

Instances details

(a ~ b, Shape sh) => Convert (Array a) (Array sh b) Source #
Instance details Defined in Data.Array.Convert Methods convert :: Array0 a -> Array sh b Source # convertE :: Array0 a -> Either String (Array sh b) Source #
Eq (Array sh Vector a) => Eq (Array sh a) Source #
Instance details Defined in Data.Array.Internal.ShapedS Methods (==) :: Array sh a -> Array sh a -> Bool # (/=) :: Array sh a -> Array sh a -> Bool #
(Typeable sh, Data a, Storable a) => Data (Array sh a) Source #
Instance details Defined in Data.Array.Internal.ShapedS Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Array sh a -> c (Array sh a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Array sh a) # toConstr :: Array sh a -> Constr # dataTypeOf :: Array sh a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Array sh a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Array sh a)) # gmapT :: (forall b. Data b => b -> b) -> Array sh a -> Array sh a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Array sh a -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Array sh a -> r # gmapQ :: (forall d. Data d => d -> u) -> Array sh a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Array sh a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Array sh a -> m (Array sh a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Array sh a -> m (Array sh a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Array sh a -> m (Array sh a) #
Ord (Array sh Vector a) => Ord (Array sh a) Source #
Instance details Defined in Data.Array.Internal.ShapedS Methods compare :: Array sh a -> Array sh a -> Ordering # (<) :: Array sh a -> Array sh a -> Bool # (<=) :: Array sh a -> Array sh a -> Bool # (>) :: Array sh a -> Array sh a -> Bool # (>=) :: Array sh a -> Array sh a -> Bool # max :: Array sh a -> Array sh a -> Array sh a # min :: Array sh a -> Array sh a -> Array sh a #
(Read a, Unbox a, Shape sh) => Read (Array sh a) Source #
Instance details Defined in Data.Array.Internal.ShapedS Methods readsPrec :: Int -> ReadS (Array sh a) # readList :: ReadS [Array sh a] # readPrec :: ReadPrec (Array sh a) # readListPrec :: ReadPrec [Array sh a] #
(Unbox a, Show a, Shape sh) => Show (Array sh a) Source #
Instance details Defined in Data.Array.Internal.ShapedS Methods showsPrec :: Int -> Array sh a -> ShowS # show :: Array sh a -> String # showList :: [Array sh a] -> ShowS #
Generic (Array sh a) Source #
Instance details Defined in Data.Array.Internal.ShapedS Associated Types type Rep (Array sh a) :: Type -> Type # Methods from :: Array sh a -> Rep (Array sh a) x # to :: Rep (Array sh a) x -> Array sh a #
(Shape sh, Arbitrary a, Unbox a) => Arbitrary (Array sh a) Source #
Instance details Defined in Data.Array.Internal.ShapedS Methods arbitrary :: Gen (Array sh a) # shrink :: Array sh a -> [Array sh a] #
NFData a => NFData (Array sh a) Source #
Instance details Defined in Data.Array.Internal.ShapedS Methods rnf :: Array sh a -> () #
(Pretty a, Storable a, Shape sh) => Pretty (Array sh a) Source #
Instance details Defined in Data.Array.Internal.ShapedS Methods pPrintPrec :: PrettyLevel -> Rational -> Array sh a -> Doc # pPrint :: Array sh a -> Doc # pPrintList :: PrettyLevel -> [Array sh a] -> Doc #
(a ~ b, Shape sh) => Convert (Array sh a) (Array b) Source #
Instance details Defined in Data.Array.Convert Methods convert :: Array sh a -> Array0 b Source # convertE :: Array sh a -> Either String (Array0 b) Source #
(a ~ b, Rank sh ~ n, Shape sh) => Convert (Array n a) (Array sh b) Source #
Instance details Defined in Data.Array.Convert Methods convert :: Array0 n a -> Array sh b Source # convertE :: Array0 n a -> Either String (Array sh b) Source #
(a ~ b, n ~ m, Unbox a) => Convert (Array n a) (Array m b) Source #
Instance details Defined in Data.Array.Convert Methods convert :: Array0 n a -> Array m b Source # convertE :: Array0 n a -> Either String (Array m b) Source #
(a ~ b, n ~ m, Unbox a) => Convert (Array n a) (Array m b) Source #
Instance details Defined in Data.Array.Convert Methods convert :: Array n a -> Array0 m b Source # convertE :: Array n a -> Either String (Array0 m b) Source #
(a ~ b, s ~ t) => Convert (Array s a) (Array t Vector b) Source #
Instance details Defined in Data.Array.Convert Methods convert :: Array s a -> Array0 t Vector b Source # convertE :: Array s a -> Either String (Array0 t Vector b) Source #
type Rep (Array sh a) Source #
Instance details Defined in Data.Array.Internal.ShapedS type Rep (Array sh a) = D1 ('MetaData "Array" "Data.Array.Internal.ShapedS" "orthotope-0.1.1.0-8N9XOymS4o4K1BvtpFJxFr" 'True) (C1 ('MetaCons "A" 'PrefixI 'True) (S1 ('MetaSel ('Just "unA") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Array sh Vector a))))

type Unbox = Storable Source #

size :: forall sh a. Shape sh => Array sh a -> Int Source #

The number of elements in the array.

shapeL :: Shape sh => Array sh a -> ShapeL Source #

The shape of an array, i.e., a list of the sizes of its dimensions. In the linearization of the array the outermost (i.e. first list element) varies most slowly. O(1) time.

rank :: (Shape sh, KnownNat (Rank sh)) => Array sh a -> Int Source #

The rank of an array, i.e., the number if dimensions it has, which is the n in Array n a. O(1) time.

index :: (Unbox a, KnownNat s) => Array (s ': sh) a -> Int -> Array sh a Source #

Index into an array. Fails if the index is out of bounds. O(1) time.

toList :: forall sh a. (Unbox a, Shape sh) => Array sh a -> [a] Source #

Convert to a list with the elements in the linearization order. O(n) time.

fromList :: forall sh a. (HasCallStack, Unbox a, Shape sh) => [a] -> Array sh a Source #

Convert from a list with the elements given in the linearization order. Fails if the given shape does not have the same number of elements as the list. O(n) time.

toVector :: (Unbox a, Shape sh) => Array sh a -> Vector a Source #

Convert to a vector with the elements in the linearization order. O(n) or O(1) time (the latter if the vector is already in the linearization order).

fromVector :: forall sh a. (HasCallStack, Unbox a, Shape sh) => Vector a -> Array sh a Source #

Convert from a vector with the elements given in the linearization order. Fails if the given shape does not have the same number of elements as the list. O(1) time.

normalize :: (Unbox a, Shape sh) => Array sh a -> Array sh a Source #

Make sure the underlying vector is in the linearization order. This is semantically an identity function, but can have big performance implications. O(n) or O(1) time.

reshape :: forall sh' sh a. (Unbox a, Shape sh, Shape sh', Size sh ~ Size sh') => Array sh a -> Array sh' a Source #

Change the shape of an array. Fails if the arrays have different number of elements. O(n) or O(1) time.

stretch :: forall sh' sh a. (Shape sh, Shape sh', ValidStretch sh sh') => Array sh a -> Array sh' a Source #

Change the size of dimensions with size 1. These dimension can be changed to any size. All other dimensions must remain the same. O(1) time.

stretchOuter :: (KnownNat s, Shape sh) => Array (1 ': sh) a -> Array (s ': sh) a Source #

Change the size of the outermost dimension by replication.

scalar :: Unbox a => a -> Array '[] a Source #

Convert a value to a scalar (rank 0) array. O(1) time.

unScalar :: Unbox a => Array '[] a -> a Source #

Convert a scalar (rank 0) array to a value. O(1) time.

constant :: forall sh a. (Unbox a, Shape sh) => a -> Array sh a Source #

Make an array with all elements having the same value. O(1) time.

mapA :: (Unbox a, Unbox b, Shape sh) => (a -> b) -> Array sh a -> Array sh b Source #

Map over the array elements. O(n) time.

zipWithA :: (Unbox a, Unbox b, Unbox c, Shape sh) => (a -> b -> c) -> Array sh a -> Array sh b -> Array sh c Source #

Map over the array elements. O(n) time.

zipWith3A :: (Unbox a, Unbox b, Unbox c, Unbox d, Shape sh) => (a -> b -> c -> d) -> Array sh a -> Array sh b -> Array sh c -> Array sh d Source #

Map over the array elements. O(n) time.

pad :: forall ps sh' sh a. (Unbox a, Padded ps sh sh', Shape sh) => a -> Array sh a -> Array sh' a Source #

Pad each dimension on the low and high side with the given value. O(n) time.

transpose :: forall is sh a. (Permutation is, Rank is <= Rank sh, Shape sh, Shape is, KnownNat (Rank sh)) => Array sh a -> Array (Permute is sh) a Source #

Do an arbitrary array transposition. Fails if the transposition argument is not a permutation of the numbers [0..r-1], where r is the rank of the array. O(1) time.

append :: (Unbox a, Shape sh, KnownNat m, KnownNat n, KnownNat (m + n)) => Array (m ': sh) a -> Array (n ': sh) a -> Array ((m + n) ': sh) a Source #

Append two arrays along the outermost dimension. All dimensions, except the outermost, must be the same. O(n) time.

ravel :: (Unbox a, Shape sh, KnownNat s) => Array '[s] (Array sh a) -> Array (s ': sh) a Source #

Turn a rank-1 array of arrays into a single array by making the outer array into the outermost dimension of the result array. All the arrays must have the same shape. O(n) time.

unravel :: (Unbox a, Shape sh, KnownNat s) => Array (s ': sh) a -> Array '[s] (Array sh a) Source #

Turn an array into a nested array, this is the inverse of ravel. I.e., ravel . unravel == id.

window :: forall ws sh' sh a. (Window ws sh sh', KnownNat (Rank ws)) => Array sh a -> Array sh' a Source #

Make a window of the outermost dimensions. The rank increases with the length of the window list. E.g., if the shape of the array is [10,12,8] and the window size is [3,3] then the resulting array will have shape [8,10,3,3,8]. O(1) time.

stride :: forall ts sh' sh a. (Stride ts sh sh', Shape ts) => Array sh a -> Array sh' a Source #

Stride the outermost dimensions. E.g., if the array shape is [10,12,8] and the strides are [2,2] then the resulting shape will be [5,6,8]. O(1) time.

slice :: forall sl sh' sh a. Slice sl sh sh' => Array sh a -> Array sh' a Source #

Extract a slice of an array. The first argument is a list of (offset, length) pairs. The length of the slicing argument must not exceed the rank of the arrar. The extracted slice mul fall within the array dimensions. E.g. slice [1,2] (fromList [4] [1,2,3,4]) == [2,3]. O(1) time.

rerank :: forall n i o sh a b. (Unbox a, Unbox b, Drop n sh ~ i, Shape sh, KnownNat n, Shape o, Shape (Take n sh ++ o)) => (Array i a -> Array o b) -> Array sh a -> Array (Take n sh ++ o) b Source #

Apply a function to the subarrays n levels down and make the results into an array with the same n outermost dimensions. The n must not exceed the rank of the array. O(n) time.

rerank2 :: forall n i o sh a b c. (Unbox a, Unbox b, Unbox c, Drop n sh ~ i, Shape sh, KnownNat n, Shape o, Shape (Take n sh ++ o)) => (Array i a -> Array i b -> Array o c) -> Array sh a -> Array sh b -> Array (Take n sh ++ o) c Source #

Apply a two-argument function to the subarrays n levels down and make the results into an array with the same n outermost dimensions. The n must not exceed the rank of the array. O(n) time.

rev :: forall rs sh a. (ValidDims rs sh, Shape rs, Shape sh) => Array sh a -> Array sh a Source #

Reverse the given dimensions, with the outermost being dimension 0. O(1) time.

reduce :: (Unbox a, Shape sh) => (a -> a -> a) -> a -> Array sh a -> Array '[] a Source #

Reduce all elements of an array into a rank 0 array. To reduce parts use rerank and transpose together with reduce. O(n) time.

foldrA :: (Unbox a, Shape sh) => (a -> b -> b) -> b -> Array sh a -> b Source #

Constrained version of foldr for Arrays.

traverseA :: (Unbox a, Unbox b, Applicative f, Shape sh) => (a -> f b) -> Array sh a -> f (Array sh b) Source #

Constrained version of traverse for Arrays.

allSameA :: (Shape sh, Unbox a, Eq a) => Array sh a -> Bool Source #

Check if all elements of the array are equal.

sumA :: (Unbox a, Num a, Shape sh) => Array sh a -> a Source #

productA :: (Unbox a, Num a, Shape sh) => Array sh a -> a Source #

Product of all elements.

maximumA :: (Unbox a, Ord a, Shape sh, 1 <= Size sh) => Array sh a -> a Source #

Maximum of all elements.

minimumA :: (Unbox a, Ord a, Shape sh, 1 <= Size sh) => Array sh a -> a Source #

Minimum of all elements.

anyA :: (Shape sh, Unbox a) => (a -> Bool) -> Array sh a -> Bool Source #

Test if the predicate holds for any element.

allA :: (Shape sh, Unbox a) => (a -> Bool) -> Array sh a -> Bool Source #

Test if the predicate holds for all elements.

broadcast :: forall ds sh' sh a. (Unbox a, Shape sh, Shape sh', Broadcast ds sh sh') => Array sh a -> Array sh' a Source #

Put the dimensions of the argument into the specified dimensions, and just replicate the data along all other dimensions. The list of dimensions indicies must have the same rank as the argument array and it must be strictly ascending.

generate :: (Unbox a, Shape sh) => ([Int] -> a) -> Array sh a Source #

Generate an array with a function that computes the value for each index.

iterateN :: forall n a. (Unbox a, KnownNat n) => (a -> a) -> a -> Array '[n] a Source #

Iterate a function n times.

iota :: (KnownNat n, Unbox a, Enum a, Num a) => Array '[n] a Source #

Generate a vector from 0 to n-1.