repa-3.4.0.1: High performance, regular, shape polymorphic parallel arrays.

Safe HaskellSafe
LanguageHaskell98

Data.Array.Repa.Shape

Description

Class of types that can be used as array shapes and indices.

Synopsis

Documentation

class Eq sh => Shape sh where Source

Class of types that can be used as array shapes and indices.

Methods

rank :: sh -> Int Source

Get the number of dimensions in a shape.

zeroDim :: sh Source

The shape of an array of size zero, with a particular dimensionality.

unitDim :: sh Source

The shape of an array with size one, with a particular dimensionality.

intersectDim :: sh -> sh -> sh Source

Compute the intersection of two shapes.

addDim :: sh -> sh -> sh Source

Add the coordinates of two shapes componentwise

size :: sh -> Int Source

Get the total number of elements in an array with this shape.

sizeIsValid :: sh -> Bool Source

Check whether this shape is small enough so that its flat indices an be represented as Int. If this returns False then your array is too big. Mostly used for writing QuickCheck tests.

toIndex Source

Arguments

:: sh

Shape of the array.

-> sh

Index into the array.

-> Int 

Convert an index into its equivalent flat, linear, row-major version.

fromIndex Source

Arguments

:: sh

Shape of the array.

-> Int

Index into linear representation.

-> sh 

Inverse of toIndex.

inShapeRange Source

Arguments

:: sh

Start index for range.

-> sh

Final index for range.

-> sh

Index to check for.

-> Bool 

Check whether an index is within a given shape.

listOfShape :: sh -> [Int] Source

Convert a shape into its list of dimensions.

shapeOfList :: [Int] -> sh Source

Convert a list of dimensions to a shape

deepSeq :: sh -> a -> a infixr 0 Source

Ensure that a shape is completely evaluated.

Instances

inShape Source

Arguments

:: Shape sh 
=> sh

Shape of the array.

-> sh

Index.

-> Bool 

Check whether an index is a part of a given shape.

showShape :: Shape sh => sh -> String Source

Nicely format a shape as a string