Data.Array.Comfort.Shape

Documentation

class C sh where

Methods

size :: sh -> Int

Instances

C ()

Defined in Data.Array.Comfort.Shape

Methods

size :: () -> Int

C Zero

Defined in Data.Array.Comfort.Shape

Methods

size :: Zero -> Int

Ord n => C (Set n)

Defined in Data.Array.Comfort.Shape

Methods

size :: Set n -> Int

Integral n => C (Cyclic n)

Defined in Data.Array.Comfort.Shape

Methods

size :: Cyclic n -> Int

C sh => C (Cube sh)

Defined in Data.Array.Comfort.Shape

Methods

size :: Cube sh -> Int

C sh => C (Square sh)

Defined in Data.Array.Comfort.Shape

Methods

size :: Square sh -> Int

C sh => C (Deferred sh)

Defined in Data.Array.Comfort.Shape

Methods

size :: Deferred sh -> Int

(Enum n, Bounded n) => C (Enumeration n)

Defined in Data.Array.Comfort.Shape

Methods

size :: Enumeration n -> Int

Integral n => C (Shifted n)

Defined in Data.Array.Comfort.Shape

Methods

size :: Shifted n -> Int

Ix n => C (Range n)

Defined in Data.Array.Comfort.Shape

Methods

size :: Range n -> Int

Integral n => C (OneBased n)

Defined in Data.Array.Comfort.Shape

Methods

size :: OneBased n -> Int

Integral n => C (ZeroBased n)

Defined in Data.Array.Comfort.Shape

Methods

size :: ZeroBased n -> Int

C f => C (Shape f)

Defined in Data.Array.Comfort.Container

Methods

size :: Shape f -> Int

(C sh0, C sh1) => C (sh0, sh1)

Defined in Data.Array.Comfort.Shape

Methods

size :: (sh0, sh1) -> Int

(Ord k, C shape) => C (Map k shape)

Concatenate many arrays according to the shapes stored in a Map.

Defined in Data.Array.Comfort.Shape

Methods

size :: Map k shape -> Int

(C sh0, C sh1) => C (sh0 ::+ sh1)

Defined in Data.Array.Comfort.Shape

Methods

size :: (sh0 ::+ sh1) -> Int

(TriangularPart part, C size) => C (Triangular part size)

Defined in Data.Array.Comfort.Shape

Methods

size :: Triangular part size -> Int

(C sh0, C sh1, C sh2) => C (sh0, sh1, sh2)

Defined in Data.Array.Comfort.Shape

Methods

size :: (sh0, sh1, sh2) -> Int

C sh => C (Tagged s sh)

Defined in Data.Array.Comfort.Shape

Methods

size :: Tagged s sh -> Int

(SimplexOrderC order, CollisionC coll, Traversable f, C size) => C (Simplex order coll f size)

Defined in Data.Array.Comfort.Shape

Methods

size :: Simplex order coll f size -> Int

class C sh => Indexed sh where

Minimal complete definition

indices, (unifiedOffset | unifiedSizeOffset)

Associated Types

type Index sh

Methods

indices :: sh -> [Index sh]

offset :: sh -> Index sh -> Int

uncheckedOffset :: sh -> Index sh -> Int

unifiedOffset :: Checking check => sh -> Index sh -> Result check Int

inBounds :: sh -> Index sh -> Bool

sizeOffset :: sh -> (Int, Index sh -> Int)

uncheckedSizeOffset :: sh -> (Int, Index sh -> Int)

unifiedSizeOffset :: Checking check => sh -> (Int, Index sh -> Result check Int)

Instances

Indexed ()

>>> Shape.indices ()
[()]

Defined in Data.Array.Comfort.Shape

Associated Types

type Index ()

Methods

indices :: () -> [Index ()]

offset :: () -> Index () -> Int

uncheckedOffset :: () -> Index () -> Int

unifiedOffset :: Checking check => () -> Index () -> Result check Int

inBounds :: () -> Index () -> Bool

sizeOffset :: () -> (Int, Index () -> Int)

uncheckedSizeOffset :: () -> (Int, Index () -> Int)

unifiedSizeOffset :: Checking check => () -> (Int, Index () -> Result check Int)

Ord n => Indexed (Set n)

You can use an arbitrary Set of indices as shape. The array elements are ordered according to the index order in the Set.

Disadvantage is that combinators of different Set indexed arrays have to compare whole sets. However, the Set implementation may have low-level optimizations for pointer equality.

>>> Shape.indices (Set.fromList "comfort")
"cfmort"

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Set n)

Methods

indices :: Set n -> [Index (Set n)]

offset :: Set n -> Index (Set n) -> Int

uncheckedOffset :: Set n -> Index (Set n) -> Int

unifiedOffset :: Checking check => Set n -> Index (Set n) -> Result check Int

inBounds :: Set n -> Index (Set n) -> Bool

sizeOffset :: Set n -> (Int, Index (Set n) -> Int)

uncheckedSizeOffset :: Set n -> (Int, Index (Set n) -> Int)

unifiedSizeOffset :: Checking check => Set n -> (Int, Index (Set n) -> Result check Int)

Integral n => Indexed (Cyclic n)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Cyclic n)

Methods

indices :: Cyclic n -> [Index (Cyclic n)]

offset :: Cyclic n -> Index (Cyclic n) -> Int

uncheckedOffset :: Cyclic n -> Index (Cyclic n) -> Int

unifiedOffset :: Checking check => Cyclic n -> Index (Cyclic n) -> Result check Int

inBounds :: Cyclic n -> Index (Cyclic n) -> Bool

sizeOffset :: Cyclic n -> (Int, Index (Cyclic n) -> Int)

uncheckedSizeOffset :: Cyclic n -> (Int, Index (Cyclic n) -> Int)

unifiedSizeOffset :: Checking check => Cyclic n -> (Int, Index (Cyclic n) -> Result check Int)

Indexed sh => Indexed (Cube sh)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Cube sh)

Methods

indices :: Cube sh -> [Index (Cube sh)]

offset :: Cube sh -> Index (Cube sh) -> Int

uncheckedOffset :: Cube sh -> Index (Cube sh) -> Int

unifiedOffset :: Checking check => Cube sh -> Index (Cube sh) -> Result check Int

inBounds :: Cube sh -> Index (Cube sh) -> Bool

sizeOffset :: Cube sh -> (Int, Index (Cube sh) -> Int)

uncheckedSizeOffset :: Cube sh -> (Int, Index (Cube sh) -> Int)

unifiedSizeOffset :: Checking check => Cube sh -> (Int, Index (Cube sh) -> Result check Int)

Indexed sh => Indexed (Square sh)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Square sh)

Methods

indices :: Square sh -> [Index (Square sh)]

offset :: Square sh -> Index (Square sh) -> Int

uncheckedOffset :: Square sh -> Index (Square sh) -> Int

unifiedOffset :: Checking check => Square sh -> Index (Square sh) -> Result check Int

inBounds :: Square sh -> Index (Square sh) -> Bool

sizeOffset :: Square sh -> (Int, Index (Square sh) -> Int)

uncheckedSizeOffset :: Square sh -> (Int, Index (Square sh) -> Int)

unifiedSizeOffset :: Checking check => Square sh -> (Int, Index (Square sh) -> Result check Int)

C sh => Indexed (Deferred sh)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Deferred sh)

Methods

indices :: Deferred sh -> [Index (Deferred sh)]

offset :: Deferred sh -> Index (Deferred sh) -> Int

uncheckedOffset :: Deferred sh -> Index (Deferred sh) -> Int

unifiedOffset :: Checking check => Deferred sh -> Index (Deferred sh) -> Result check Int

inBounds :: Deferred sh -> Index (Deferred sh) -> Bool

sizeOffset :: Deferred sh -> (Int, Index (Deferred sh) -> Int)

uncheckedSizeOffset :: Deferred sh -> (Int, Index (Deferred sh) -> Int)

unifiedSizeOffset :: Checking check => Deferred sh -> (Int, Index (Deferred sh) -> Result check Int)

(Enum n, Bounded n) => Indexed (Enumeration n)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Enumeration n)

Methods

indices :: Enumeration n -> [Index (Enumeration n)]

offset :: Enumeration n -> Index (Enumeration n) -> Int

uncheckedOffset :: Enumeration n -> Index (Enumeration n) -> Int

unifiedOffset :: Checking check => Enumeration n -> Index (Enumeration n) -> Result check Int

inBounds :: Enumeration n -> Index (Enumeration n) -> Bool

sizeOffset :: Enumeration n -> (Int, Index (Enumeration n) -> Int)

uncheckedSizeOffset :: Enumeration n -> (Int, Index (Enumeration n) -> Int)

unifiedSizeOffset :: Checking check => Enumeration n -> (Int, Index (Enumeration n) -> Result check Int)

Integral n => Indexed (Shifted n)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Shifted n)

Methods

indices :: Shifted n -> [Index (Shifted n)]

offset :: Shifted n -> Index (Shifted n) -> Int

uncheckedOffset :: Shifted n -> Index (Shifted n) -> Int

unifiedOffset :: Checking check => Shifted n -> Index (Shifted n) -> Result check Int

inBounds :: Shifted n -> Index (Shifted n) -> Bool

sizeOffset :: Shifted n -> (Int, Index (Shifted n) -> Int)

uncheckedSizeOffset :: Shifted n -> (Int, Index (Shifted n) -> Int)

unifiedSizeOffset :: Checking check => Shifted n -> (Int, Index (Shifted n) -> Result check Int)

Ix n => Indexed (Range n)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Range n)

Methods

indices :: Range n -> [Index (Range n)]

offset :: Range n -> Index (Range n) -> Int

uncheckedOffset :: Range n -> Index (Range n) -> Int

unifiedOffset :: Checking check => Range n -> Index (Range n) -> Result check Int

inBounds :: Range n -> Index (Range n) -> Bool

sizeOffset :: Range n -> (Int, Index (Range n) -> Int)

uncheckedSizeOffset :: Range n -> (Int, Index (Range n) -> Int)

unifiedSizeOffset :: Checking check => Range n -> (Int, Index (Range n) -> Result check Int)

Integral n => Indexed (OneBased n)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (OneBased n)

Methods

indices :: OneBased n -> [Index (OneBased n)]

offset :: OneBased n -> Index (OneBased n) -> Int

uncheckedOffset :: OneBased n -> Index (OneBased n) -> Int

unifiedOffset :: Checking check => OneBased n -> Index (OneBased n) -> Result check Int

inBounds :: OneBased n -> Index (OneBased n) -> Bool

sizeOffset :: OneBased n -> (Int, Index (OneBased n) -> Int)

uncheckedSizeOffset :: OneBased n -> (Int, Index (OneBased n) -> Int)

unifiedSizeOffset :: Checking check => OneBased n -> (Int, Index (OneBased n) -> Result check Int)

Integral n => Indexed (ZeroBased n)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (ZeroBased n)

Methods

indices :: ZeroBased n -> [Index (ZeroBased n)]

offset :: ZeroBased n -> Index (ZeroBased n) -> Int

uncheckedOffset :: ZeroBased n -> Index (ZeroBased n) -> Int

unifiedOffset :: Checking check => ZeroBased n -> Index (ZeroBased n) -> Result check Int

inBounds :: ZeroBased n -> Index (ZeroBased n) -> Bool

sizeOffset :: ZeroBased n -> (Int, Index (ZeroBased n) -> Int)

uncheckedSizeOffset :: ZeroBased n -> (Int, Index (ZeroBased n) -> Int)

unifiedSizeOffset :: Checking check => ZeroBased n -> (Int, Index (ZeroBased n) -> Result check Int)

(Indexed sh0, Indexed sh1) => Indexed (sh0, sh1)

Row-major composition of two dimensions.

>>> Shape.indices (Shape.ZeroBased (3::Int), Shape.ZeroBased (3::Int))
[(0,0),(0,1),(0,2),(1,0),(1,1),(1,2),(2,0),(2,1),(2,2)]

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (sh0, sh1)

Methods

indices :: (sh0, sh1) -> [Index (sh0, sh1)]

offset :: (sh0, sh1) -> Index (sh0, sh1) -> Int

uncheckedOffset :: (sh0, sh1) -> Index (sh0, sh1) -> Int

unifiedOffset :: Checking check => (sh0, sh1) -> Index (sh0, sh1) -> Result check Int

inBounds :: (sh0, sh1) -> Index (sh0, sh1) -> Bool

sizeOffset :: (sh0, sh1) -> (Int, Index (sh0, sh1) -> Int)

uncheckedSizeOffset :: (sh0, sh1) -> (Int, Index (sh0, sh1) -> Int)

unifiedSizeOffset :: Checking check => (sh0, sh1) -> (Int, Index (sh0, sh1) -> Result check Int)

(Ord k, Indexed shape) => Indexed (Map k shape)

The implementations of offset et.al. are optimized for frequent calls with respect to the same shape.

>>> Shape.indices $ fmap Shape.ZeroBased $ Map.fromList [('b', (0::Int)), ('a', 5), ('c', 2)]
[('a',0),('a',1),('a',2),('a',3),('a',4),('c',0),('c',1)]

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Map k shape)

Methods

indices :: Map k shape -> [Index (Map k shape)]

offset :: Map k shape -> Index (Map k shape) -> Int

uncheckedOffset :: Map k shape -> Index (Map k shape) -> Int

unifiedOffset :: Checking check => Map k shape -> Index (Map k shape) -> Result check Int

inBounds :: Map k shape -> Index (Map k shape) -> Bool

sizeOffset :: Map k shape -> (Int, Index (Map k shape) -> Int)

uncheckedSizeOffset :: Map k shape -> (Int, Index (Map k shape) -> Int)

unifiedSizeOffset :: Checking check => Map k shape -> (Int, Index (Map k shape) -> Result check Int)

(Indexed sh0, Indexed sh1) => Indexed (sh0 ::+ sh1)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (sh0 ::+ sh1)

Methods

indices :: (sh0 ::+ sh1) -> [Index (sh0 ::+ sh1)]

offset :: (sh0 ::+ sh1) -> Index (sh0 ::+ sh1) -> Int

uncheckedOffset :: (sh0 ::+ sh1) -> Index (sh0 ::+ sh1) -> Int

unifiedOffset :: Checking check => (sh0 ::+ sh1) -> Index (sh0 ::+ sh1) -> Result check Int

inBounds :: (sh0 ::+ sh1) -> Index (sh0 ::+ sh1) -> Bool

sizeOffset :: (sh0 ::+ sh1) -> (Int, Index (sh0 ::+ sh1) -> Int)

uncheckedSizeOffset :: (sh0 ::+ sh1) -> (Int, Index (sh0 ::+ sh1) -> Int)

unifiedSizeOffset :: Checking check => (sh0 ::+ sh1) -> (Int, Index (sh0 ::+ sh1) -> Result check Int)

(TriangularPart part, Indexed size) => Indexed (Triangular part size)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Triangular part size)

Methods

indices :: Triangular part size -> [Index (Triangular part size)]

offset :: Triangular part size -> Index (Triangular part size) -> Int

uncheckedOffset :: Triangular part size -> Index (Triangular part size) -> Int

unifiedOffset :: Checking check => Triangular part size -> Index (Triangular part size) -> Result check Int

inBounds :: Triangular part size -> Index (Triangular part size) -> Bool

sizeOffset :: Triangular part size -> (Int, Index (Triangular part size) -> Int)

uncheckedSizeOffset :: Triangular part size -> (Int, Index (Triangular part size) -> Int)

unifiedSizeOffset :: Checking check => Triangular part size -> (Int, Index (Triangular part size) -> Result check Int)

(Indexed sh0, Indexed sh1, Indexed sh2) => Indexed (sh0, sh1, sh2)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (sh0, sh1, sh2)

Methods

indices :: (sh0, sh1, sh2) -> [Index (sh0, sh1, sh2)]

offset :: (sh0, sh1, sh2) -> Index (sh0, sh1, sh2) -> Int

uncheckedOffset :: (sh0, sh1, sh2) -> Index (sh0, sh1, sh2) -> Int

unifiedOffset :: Checking check => (sh0, sh1, sh2) -> Index (sh0, sh1, sh2) -> Result check Int

inBounds :: (sh0, sh1, sh2) -> Index (sh0, sh1, sh2) -> Bool

sizeOffset :: (sh0, sh1, sh2) -> (Int, Index (sh0, sh1, sh2) -> Int)

uncheckedSizeOffset :: (sh0, sh1, sh2) -> (Int, Index (sh0, sh1, sh2) -> Int)

unifiedSizeOffset :: Checking check => (sh0, sh1, sh2) -> (Int, Index (sh0, sh1, sh2) -> Result check Int)

Indexed sh => Indexed (Tagged s sh)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Tagged s sh)

Methods

indices :: Tagged s sh -> [Index (Tagged s sh)]

offset :: Tagged s sh -> Index (Tagged s sh) -> Int

uncheckedOffset :: Tagged s sh -> Index (Tagged s sh) -> Int

unifiedOffset :: Checking check => Tagged s sh -> Index (Tagged s sh) -> Result check Int

inBounds :: Tagged s sh -> Index (Tagged s sh) -> Bool

sizeOffset :: Tagged s sh -> (Int, Index (Tagged s sh) -> Int)

uncheckedSizeOffset :: Tagged s sh -> (Int, Index (Tagged s sh) -> Int)

unifiedSizeOffset :: Checking check => Tagged s sh -> (Int, Index (Tagged s sh) -> Result check Int)

(SimplexOrderC order, CollisionC coll, Traversable f, Eq1 f, Indexed size) => Indexed (Simplex order coll f size)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Simplex order coll f size)

Methods

indices :: Simplex order coll f size -> [Index (Simplex order coll f size)]

offset :: Simplex order coll f size -> Index (Simplex order coll f size) -> Int

uncheckedOffset :: Simplex order coll f size -> Index (Simplex order coll f size) -> Int

unifiedOffset :: Checking check => Simplex order coll f size -> Index (Simplex order coll f size) -> Result check Int

inBounds :: Simplex order coll f size -> Index (Simplex order coll f size) -> Bool

sizeOffset :: Simplex order coll f size -> (Int, Index (Simplex order coll f size) -> Int)

uncheckedSizeOffset :: Simplex order coll f size -> (Int, Index (Simplex order coll f size) -> Int)

unifiedSizeOffset :: Checking check => Simplex order coll f size -> (Int, Index (Simplex order coll f size) -> Result check Int)

class Indexed sh => InvIndexed sh where

Minimal complete definition

unifiedIndexFromOffset

Methods

indexFromOffset :: sh -> Int -> Index sh

It should hold indexFromOffset sh k == indices sh !! k, but indexFromOffset should generally be faster.

uncheckedIndexFromOffset :: sh -> Int -> Index sh

unifiedIndexFromOffset :: Checking check => sh -> Int -> Result check (Index sh)

Instances

InvIndexed ()

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: () -> Int -> Index ()

uncheckedIndexFromOffset :: () -> Int -> Index ()

unifiedIndexFromOffset :: Checking check => () -> Int -> Result check (Index ())

Ord n => InvIndexed (Set n)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Set n -> Int -> Index (Set n)

uncheckedIndexFromOffset :: Set n -> Int -> Index (Set n)

unifiedIndexFromOffset :: Checking check => Set n -> Int -> Result check (Index (Set n))

Integral n => InvIndexed (Cyclic n)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Cyclic n -> Int -> Index (Cyclic n)

uncheckedIndexFromOffset :: Cyclic n -> Int -> Index (Cyclic n)

unifiedIndexFromOffset :: Checking check => Cyclic n -> Int -> Result check (Index (Cyclic n))

InvIndexed sh => InvIndexed (Cube sh)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Cube sh -> Int -> Index (Cube sh)

uncheckedIndexFromOffset :: Cube sh -> Int -> Index (Cube sh)

unifiedIndexFromOffset :: Checking check => Cube sh -> Int -> Result check (Index (Cube sh))

InvIndexed sh => InvIndexed (Square sh)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Square sh -> Int -> Index (Square sh)

uncheckedIndexFromOffset :: Square sh -> Int -> Index (Square sh)

unifiedIndexFromOffset :: Checking check => Square sh -> Int -> Result check (Index (Square sh))

C sh => InvIndexed (Deferred sh)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Deferred sh -> Int -> Index (Deferred sh)

uncheckedIndexFromOffset :: Deferred sh -> Int -> Index (Deferred sh)

unifiedIndexFromOffset :: Checking check => Deferred sh -> Int -> Result check (Index (Deferred sh))

(Enum n, Bounded n) => InvIndexed (Enumeration n)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Enumeration n -> Int -> Index (Enumeration n)

uncheckedIndexFromOffset :: Enumeration n -> Int -> Index (Enumeration n)

unifiedIndexFromOffset :: Checking check => Enumeration n -> Int -> Result check (Index (Enumeration n))

Integral n => InvIndexed (Shifted n)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Shifted n -> Int -> Index (Shifted n)

uncheckedIndexFromOffset :: Shifted n -> Int -> Index (Shifted n)

unifiedIndexFromOffset :: Checking check => Shifted n -> Int -> Result check (Index (Shifted n))

Ix n => InvIndexed (Range n)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Range n -> Int -> Index (Range n)

uncheckedIndexFromOffset :: Range n -> Int -> Index (Range n)

unifiedIndexFromOffset :: Checking check => Range n -> Int -> Result check (Index (Range n))

Integral n => InvIndexed (OneBased n)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: OneBased n -> Int -> Index (OneBased n)

uncheckedIndexFromOffset :: OneBased n -> Int -> Index (OneBased n)

unifiedIndexFromOffset :: Checking check => OneBased n -> Int -> Result check (Index (OneBased n))

Integral n => InvIndexed (ZeroBased n)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: ZeroBased n -> Int -> Index (ZeroBased n)

uncheckedIndexFromOffset :: ZeroBased n -> Int -> Index (ZeroBased n)

unifiedIndexFromOffset :: Checking check => ZeroBased n -> Int -> Result check (Index (ZeroBased n))

(InvIndexed sh0, InvIndexed sh1) => InvIndexed (sh0, sh1)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: (sh0, sh1) -> Int -> Index (sh0, sh1)

uncheckedIndexFromOffset :: (sh0, sh1) -> Int -> Index (sh0, sh1)

unifiedIndexFromOffset :: Checking check => (sh0, sh1) -> Int -> Result check (Index (sh0, sh1))

(Ord k, InvIndexed shape) => InvIndexed (Map k shape)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Map k shape -> Int -> Index (Map k shape)

uncheckedIndexFromOffset :: Map k shape -> Int -> Index (Map k shape)

unifiedIndexFromOffset :: Checking check => Map k shape -> Int -> Result check (Index (Map k shape))

(InvIndexed sh0, InvIndexed sh1) => InvIndexed (sh0 ::+ sh1)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: (sh0 ::+ sh1) -> Int -> Index (sh0 ::+ sh1)

uncheckedIndexFromOffset :: (sh0 ::+ sh1) -> Int -> Index (sh0 ::+ sh1)

unifiedIndexFromOffset :: Checking check => (sh0 ::+ sh1) -> Int -> Result check (Index (sh0 ::+ sh1))

(TriangularPart part, InvIndexed size) => InvIndexed (Triangular part size)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Triangular part size -> Int -> Index (Triangular part size)

uncheckedIndexFromOffset :: Triangular part size -> Int -> Index (Triangular part size)

unifiedIndexFromOffset :: Checking check => Triangular part size -> Int -> Result check (Index (Triangular part size))

(InvIndexed sh0, InvIndexed sh1, InvIndexed sh2) => InvIndexed (sh0, sh1, sh2)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: (sh0, sh1, sh2) -> Int -> Index (sh0, sh1, sh2)

uncheckedIndexFromOffset :: (sh0, sh1, sh2) -> Int -> Index (sh0, sh1, sh2)

unifiedIndexFromOffset :: Checking check => (sh0, sh1, sh2) -> Int -> Result check (Index (sh0, sh1, sh2))

InvIndexed sh => InvIndexed (Tagged s sh)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Tagged s sh -> Int -> Index (Tagged s sh)

uncheckedIndexFromOffset :: Tagged s sh -> Int -> Index (Tagged s sh)

unifiedIndexFromOffset :: Checking check => Tagged s sh -> Int -> Result check (Index (Tagged s sh))

(SimplexOrderC order, CollisionC coll, Traversable f, Eq1 f, InvIndexed size) => InvIndexed (Simplex order coll f size)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Simplex order coll f size -> Int -> Index (Simplex order coll f size)

uncheckedIndexFromOffset :: Simplex order coll f size -> Int -> Index (Simplex order coll f size)

unifiedIndexFromOffset :: Checking check => Simplex order coll f size -> Int -> Result check (Index (Simplex order coll f size))

messageIndexFromOffset :: String -> Int -> String

assertIndexFromOffset :: Checking check => String -> Int -> Bool -> Result check ()

class (C sh, Eq sh) => Static sh where

Methods

static :: sh

Instances

Static ()

Defined in Data.Array.Comfort.Shape

Methods

static :: ()

Static Zero

Defined in Data.Array.Comfort.Shape

Methods

static :: Zero

Static sh => Static (Deferred sh)

Defined in Data.Array.Comfort.Shape

Methods

static :: Deferred sh

(Enum n, Bounded n) => Static (Enumeration n)

Defined in Data.Array.Comfort.Shape

Methods

static :: Enumeration n

(Static sh0, Static sh1) => Static (sh0, sh1)

Defined in Data.Array.Comfort.Shape

Methods

static :: (sh0, sh1)

(Static sh0, Static sh1) => Static (sh0 ::+ sh1)

Defined in Data.Array.Comfort.Shape

Methods

static :: sh0 ::+ sh1

(TriangularPart part, Static size) => Static (Triangular part size)

Defined in Data.Array.Comfort.Shape

Methods

static :: Triangular part size

(Static sh0, Static sh1, Static sh2) => Static (sh0, sh1, sh2)

Defined in Data.Array.Comfort.Shape

Methods

static :: (sh0, sh1, sh2)

Static sh => Static (Tagged s sh)

Defined in Data.Array.Comfort.Shape

Methods

static :: Tagged s sh

requireCheck :: CheckSingleton check -> Result check a -> Result check a

data CheckSingleton check where

Constructors

Checked :: CheckSingleton Checked

Unchecked :: CheckSingleton Unchecked

class Checking check where

Associated Types

data Result check a

Methods

switchCheck :: f Checked -> f Unchecked -> f check

runChecked :: String -> Result Checked a -> a

runUnchecked :: Result Unchecked a -> a

assert :: Checking check => String -> Bool -> Result check ()

throwOrError :: Checking check => String -> Result check a

data Zero

Constructors

Zero

Instances

Eq Zero

Defined in Data.Array.Comfort.Shape

Methods

(==) :: Zero -> Zero -> Bool

(/=) :: Zero -> Zero -> Bool

Ord Zero

Defined in Data.Array.Comfort.Shape

Methods

compare :: Zero -> Zero -> Ordering

(<) :: Zero -> Zero -> Bool

(<=) :: Zero -> Zero -> Bool

(>) :: Zero -> Zero -> Bool

(>=) :: Zero -> Zero -> Bool

max :: Zero -> Zero -> Zero

min :: Zero -> Zero -> Zero

Show Zero

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> Zero -> ShowS

show :: Zero -> String

showList :: [Zero] -> ShowS

Static Zero

Defined in Data.Array.Comfort.Shape

Methods

static :: Zero

C Zero

Defined in Data.Array.Comfort.Shape

Methods

size :: Zero -> Int

newtype ZeroBased n

ZeroBased denotes a range starting at zero and has a certain length.

>>> Shape.indices (Shape.ZeroBased (7::Int))
[0,1,2,3,4,5,6]

Constructors

ZeroBased

Fields

• zeroBasedSize :: n

Instances

Functor ZeroBased

Defined in Data.Array.Comfort.Shape

Methods

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

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

Applicative ZeroBased

Defined in Data.Array.Comfort.Shape

Methods

pure :: a -> ZeroBased a

(<*>) :: ZeroBased (a -> b) -> ZeroBased a -> ZeroBased b

liftA2 :: (a -> b -> c) -> ZeroBased a -> ZeroBased b -> ZeroBased c

(*>) :: ZeroBased a -> ZeroBased b -> ZeroBased b

(<*) :: ZeroBased a -> ZeroBased b -> ZeroBased a

Eq n => Eq (ZeroBased n)

Defined in Data.Array.Comfort.Shape

Methods

(==) :: ZeroBased n -> ZeroBased n -> Bool

(/=) :: ZeroBased n -> ZeroBased n -> Bool

Show n => Show (ZeroBased n)

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> ZeroBased n -> ShowS

show :: ZeroBased n -> String

showList :: [ZeroBased n] -> ShowS

Storable n => Storable (ZeroBased n)

Defined in Data.Array.Comfort.Shape

Methods

sizeOf :: ZeroBased n -> Int

alignment :: ZeroBased n -> Int

peekElemOff :: Ptr (ZeroBased n) -> Int -> IO (ZeroBased n)

pokeElemOff :: Ptr (ZeroBased n) -> Int -> ZeroBased n -> IO ()

peekByteOff :: Ptr b -> Int -> IO (ZeroBased n)

pokeByteOff :: Ptr b -> Int -> ZeroBased n -> IO ()

peek :: Ptr (ZeroBased n) -> IO (ZeroBased n)

poke :: Ptr (ZeroBased n) -> ZeroBased n -> IO ()

NFData n => NFData (ZeroBased n)

Defined in Data.Array.Comfort.Shape

Methods

rnf :: ZeroBased n -> ()

Integral n => InvIndexed (ZeroBased n)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: ZeroBased n -> Int -> Index (ZeroBased n)

uncheckedIndexFromOffset :: ZeroBased n -> Int -> Index (ZeroBased n)

unifiedIndexFromOffset :: Checking check => ZeroBased n -> Int -> Result check (Index (ZeroBased n))

Integral n => Indexed (ZeroBased n)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (ZeroBased n)

Methods

indices :: ZeroBased n -> [Index (ZeroBased n)]

offset :: ZeroBased n -> Index (ZeroBased n) -> Int

uncheckedOffset :: ZeroBased n -> Index (ZeroBased n) -> Int

unifiedOffset :: Checking check => ZeroBased n -> Index (ZeroBased n) -> Result check Int

inBounds :: ZeroBased n -> Index (ZeroBased n) -> Bool

sizeOffset :: ZeroBased n -> (Int, Index (ZeroBased n) -> Int)

uncheckedSizeOffset :: ZeroBased n -> (Int, Index (ZeroBased n) -> Int)

unifiedSizeOffset :: Checking check => ZeroBased n -> (Int, Index (ZeroBased n) -> Result check Int)

Integral n => C (ZeroBased n)

Defined in Data.Array.Comfort.Shape

Methods

size :: ZeroBased n -> Int

type Index (ZeroBased n)

Defined in Data.Array.Comfort.Shape

type Index (ZeroBased n) = n

zeroBasedSplit :: Real n => n -> ZeroBased n -> ZeroBased n ::+ ZeroBased n

newtype OneBased n

OneBased denotes a range starting at one and has a certain length.

>>> Shape.indices (Shape.OneBased (7::Int))
[1,2,3,4,5,6,7]

Constructors

OneBased

Fields

• oneBasedSize :: n

Instances

Functor OneBased

Defined in Data.Array.Comfort.Shape

Methods

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

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

Applicative OneBased

Defined in Data.Array.Comfort.Shape

Methods

pure :: a -> OneBased a

(<*>) :: OneBased (a -> b) -> OneBased a -> OneBased b

liftA2 :: (a -> b -> c) -> OneBased a -> OneBased b -> OneBased c

(*>) :: OneBased a -> OneBased b -> OneBased b

(<*) :: OneBased a -> OneBased b -> OneBased a

Eq n => Eq (OneBased n)

Defined in Data.Array.Comfort.Shape

Methods

(==) :: OneBased n -> OneBased n -> Bool

(/=) :: OneBased n -> OneBased n -> Bool

Show n => Show (OneBased n)

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> OneBased n -> ShowS

show :: OneBased n -> String

showList :: [OneBased n] -> ShowS

Storable n => Storable (OneBased n)

Defined in Data.Array.Comfort.Shape

Methods

sizeOf :: OneBased n -> Int

alignment :: OneBased n -> Int

peekElemOff :: Ptr (OneBased n) -> Int -> IO (OneBased n)

pokeElemOff :: Ptr (OneBased n) -> Int -> OneBased n -> IO ()

peekByteOff :: Ptr b -> Int -> IO (OneBased n)

pokeByteOff :: Ptr b -> Int -> OneBased n -> IO ()

peek :: Ptr (OneBased n) -> IO (OneBased n)

poke :: Ptr (OneBased n) -> OneBased n -> IO ()

NFData n => NFData (OneBased n)

Defined in Data.Array.Comfort.Shape

Methods

rnf :: OneBased n -> ()

Integral n => InvIndexed (OneBased n)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: OneBased n -> Int -> Index (OneBased n)

uncheckedIndexFromOffset :: OneBased n -> Int -> Index (OneBased n)

unifiedIndexFromOffset :: Checking check => OneBased n -> Int -> Result check (Index (OneBased n))

Integral n => Indexed (OneBased n)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (OneBased n)

Methods

indices :: OneBased n -> [Index (OneBased n)]

offset :: OneBased n -> Index (OneBased n) -> Int

uncheckedOffset :: OneBased n -> Index (OneBased n) -> Int

unifiedOffset :: Checking check => OneBased n -> Index (OneBased n) -> Result check Int

inBounds :: OneBased n -> Index (OneBased n) -> Bool

sizeOffset :: OneBased n -> (Int, Index (OneBased n) -> Int)

uncheckedSizeOffset :: OneBased n -> (Int, Index (OneBased n) -> Int)

unifiedSizeOffset :: Checking check => OneBased n -> (Int, Index (OneBased n) -> Result check Int)

Integral n => C (OneBased n)

Defined in Data.Array.Comfort.Shape

Methods

size :: OneBased n -> Int

type Index (OneBased n)

Defined in Data.Array.Comfort.Shape

type Index (OneBased n) = n

data Range n

Range denotes an inclusive range like those of the Haskell 98 standard Array type from the array package. E.g. the shape type (Range Int32, Range Int64) is equivalent to the ix type (Int32, Int64) for Arrays.

>>> Shape.indices (Shape.Range (-5) (5::Int))
[-5,-4,-3,-2,-1,0,1,2,3,4,5]
>>> Shape.indices (Shape.Range (-1,-1) (1::Int,1::Int))
[(-1,-1),(-1,0),(-1,1),(0,-1),(0,0),(0,1),(1,-1),(1,0),(1,1)]

Constructors

Range

Fields

• rangeFrom, rangeTo :: n

Instances

Functor Range

Defined in Data.Array.Comfort.Shape

Methods

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

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

Eq n => Eq (Range n)

Defined in Data.Array.Comfort.Shape

Methods

(==) :: Range n -> Range n -> Bool

(/=) :: Range n -> Range n -> Bool

Show n => Show (Range n)

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> Range n -> ShowS

show :: Range n -> String

showList :: [Range n] -> ShowS

Storable n => Storable (Range n)

Defined in Data.Array.Comfort.Shape

Methods

sizeOf :: Range n -> Int

alignment :: Range n -> Int

peekElemOff :: Ptr (Range n) -> Int -> IO (Range n)

pokeElemOff :: Ptr (Range n) -> Int -> Range n -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Range n)

pokeByteOff :: Ptr b -> Int -> Range n -> IO ()

peek :: Ptr (Range n) -> IO (Range n)

poke :: Ptr (Range n) -> Range n -> IO ()

NFData n => NFData (Range n)

Defined in Data.Array.Comfort.Shape

Methods

rnf :: Range n -> ()

Ix n => InvIndexed (Range n)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Range n -> Int -> Index (Range n)

uncheckedIndexFromOffset :: Range n -> Int -> Index (Range n)

unifiedIndexFromOffset :: Checking check => Range n -> Int -> Result check (Index (Range n))

Ix n => Indexed (Range n)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Range n)

Methods

indices :: Range n -> [Index (Range n)]

offset :: Range n -> Index (Range n) -> Int

uncheckedOffset :: Range n -> Index (Range n) -> Int

unifiedOffset :: Checking check => Range n -> Index (Range n) -> Result check Int

inBounds :: Range n -> Index (Range n) -> Bool

sizeOffset :: Range n -> (Int, Index (Range n) -> Int)

uncheckedSizeOffset :: Range n -> (Int, Index (Range n) -> Int)

unifiedSizeOffset :: Checking check => Range n -> (Int, Index (Range n) -> Result check Int)

Ix n => C (Range n)

Defined in Data.Array.Comfort.Shape

Methods

size :: Range n -> Int

type Index (Range n)

Defined in Data.Array.Comfort.Shape

type Index (Range n) = n

data Shifted n

Shifted denotes a range defined by the start index and the length.

>>> Shape.indices (Shape.Shifted (-4) (8::Int))
[-4,-3,-2,-1,0,1,2,3]

Constructors

Shifted

Fields

• shiftedOffset, shiftedSize :: n

Instances

Functor Shifted

Defined in Data.Array.Comfort.Shape

Methods

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

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

Eq n => Eq (Shifted n)

Defined in Data.Array.Comfort.Shape

Methods

(==) :: Shifted n -> Shifted n -> Bool

(/=) :: Shifted n -> Shifted n -> Bool

Show n => Show (Shifted n)

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> Shifted n -> ShowS

show :: Shifted n -> String

showList :: [Shifted n] -> ShowS

Storable n => Storable (Shifted n)

Defined in Data.Array.Comfort.Shape

Methods

sizeOf :: Shifted n -> Int

alignment :: Shifted n -> Int

peekElemOff :: Ptr (Shifted n) -> Int -> IO (Shifted n)

pokeElemOff :: Ptr (Shifted n) -> Int -> Shifted n -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Shifted n)

pokeByteOff :: Ptr b -> Int -> Shifted n -> IO ()

peek :: Ptr (Shifted n) -> IO (Shifted n)

poke :: Ptr (Shifted n) -> Shifted n -> IO ()

NFData n => NFData (Shifted n)

Defined in Data.Array.Comfort.Shape

Methods

rnf :: Shifted n -> ()

Integral n => InvIndexed (Shifted n)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Shifted n -> Int -> Index (Shifted n)

uncheckedIndexFromOffset :: Shifted n -> Int -> Index (Shifted n)

unifiedIndexFromOffset :: Checking check => Shifted n -> Int -> Result check (Index (Shifted n))

Integral n => Indexed (Shifted n)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Shifted n)

Methods

indices :: Shifted n -> [Index (Shifted n)]

offset :: Shifted n -> Index (Shifted n) -> Int

uncheckedOffset :: Shifted n -> Index (Shifted n) -> Int

unifiedOffset :: Checking check => Shifted n -> Index (Shifted n) -> Result check Int

inBounds :: Shifted n -> Index (Shifted n) -> Bool

sizeOffset :: Shifted n -> (Int, Index (Shifted n) -> Int)

uncheckedSizeOffset :: Shifted n -> (Int, Index (Shifted n) -> Int)

unifiedSizeOffset :: Checking check => Shifted n -> (Int, Index (Shifted n) -> Result check Int)

Integral n => C (Shifted n)

Defined in Data.Array.Comfort.Shape

Methods

size :: Shifted n -> Int

type Index (Shifted n)

Defined in Data.Array.Comfort.Shape

type Index (Shifted n) = n

data Enumeration n

Enumeration denotes a shape of fixed size that is defined by Enum and Bounded methods. For correctness it is necessary that the Enum and Bounded instances are properly implemented. Automatically derived instances are fine.

>>> Shape.indices (Shape.Enumeration :: Shape.Enumeration Ordering)
[LT,EQ,GT]

Constructors

Enumeration

Instances

Eq (Enumeration n)

Defined in Data.Array.Comfort.Shape

Methods

(==) :: Enumeration n -> Enumeration n -> Bool

(/=) :: Enumeration n -> Enumeration n -> Bool

Show (Enumeration n)

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> Enumeration n -> ShowS

show :: Enumeration n -> String

showList :: [Enumeration n] -> ShowS

Storable (Enumeration n)

Defined in Data.Array.Comfort.Shape

Methods

sizeOf :: Enumeration n -> Int

alignment :: Enumeration n -> Int

peekElemOff :: Ptr (Enumeration n) -> Int -> IO (Enumeration n)

pokeElemOff :: Ptr (Enumeration n) -> Int -> Enumeration n -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Enumeration n)

pokeByteOff :: Ptr b -> Int -> Enumeration n -> IO ()

peek :: Ptr (Enumeration n) -> IO (Enumeration n)

poke :: Ptr (Enumeration n) -> Enumeration n -> IO ()

NFData (Enumeration n)

Defined in Data.Array.Comfort.Shape

Methods

rnf :: Enumeration n -> ()

(Enum n, Bounded n) => Static (Enumeration n)

Defined in Data.Array.Comfort.Shape

Methods

static :: Enumeration n

(Enum n, Bounded n) => InvIndexed (Enumeration n)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Enumeration n -> Int -> Index (Enumeration n)

uncheckedIndexFromOffset :: Enumeration n -> Int -> Index (Enumeration n)

unifiedIndexFromOffset :: Checking check => Enumeration n -> Int -> Result check (Index (Enumeration n))

(Enum n, Bounded n) => Indexed (Enumeration n)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Enumeration n)

Methods

indices :: Enumeration n -> [Index (Enumeration n)]

offset :: Enumeration n -> Index (Enumeration n) -> Int

uncheckedOffset :: Enumeration n -> Index (Enumeration n) -> Int

unifiedOffset :: Checking check => Enumeration n -> Index (Enumeration n) -> Result check Int

inBounds :: Enumeration n -> Index (Enumeration n) -> Bool

sizeOffset :: Enumeration n -> (Int, Index (Enumeration n) -> Int)

uncheckedSizeOffset :: Enumeration n -> (Int, Index (Enumeration n) -> Int)

unifiedSizeOffset :: Checking check => Enumeration n -> (Int, Index (Enumeration n) -> Result check Int)

(Enum n, Bounded n) => C (Enumeration n)

Defined in Data.Array.Comfort.Shape

Methods

size :: Enumeration n -> Int

type Index (Enumeration n)

Defined in Data.Array.Comfort.Shape

type Index (Enumeration n) = n

newtype Deferred sh

This data type wraps another array shape. Its index type is a wrapped Int. The advantages are: No conversion forth and back Int and Index sh. You can convert once using deferIndex and revealIndex whenever you need your application specific index type. No need for e.g. Storable (Index sh), because Int is already Storable. You get Indexed and InvIndexed instances without the need for an Index type. The disadvantage is: A deferred index should be bound to a specific shape, but this is not checked. That is, you may obtain a deferred index for one shape and accidentally abuse it for another shape without a warning.

Example:

>>> :{
let sh2 = (Shape.ZeroBased (2::Int), Shape.ZeroBased (2::Int)) in
let sh3 = (Shape.ZeroBased (3::Int), Shape.ZeroBased (3::Int)) in
(Shape.offset sh3 $ Shape.indexFromOffset sh2 3,
 Shape.offset (Shape.Deferred sh3) $
   Shape.indexFromOffset (Shape.Deferred sh2) 3)
:}
(4,3)

Constructors

Deferred sh

Instances

Eq sh => Eq (Deferred sh)

Defined in Data.Array.Comfort.Shape

Methods

(==) :: Deferred sh -> Deferred sh -> Bool

(/=) :: Deferred sh -> Deferred sh -> Bool

Show sh => Show (Deferred sh)

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> Deferred sh -> ShowS

show :: Deferred sh -> String

showList :: [Deferred sh] -> ShowS

NFData sh => NFData (Deferred sh)

Defined in Data.Array.Comfort.Shape

Methods

rnf :: Deferred sh -> ()

Static sh => Static (Deferred sh)

Defined in Data.Array.Comfort.Shape

Methods

static :: Deferred sh

C sh => InvIndexed (Deferred sh)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Deferred sh -> Int -> Index (Deferred sh)

uncheckedIndexFromOffset :: Deferred sh -> Int -> Index (Deferred sh)

unifiedIndexFromOffset :: Checking check => Deferred sh -> Int -> Result check (Index (Deferred sh))

C sh => Indexed (Deferred sh)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Deferred sh)

Methods

indices :: Deferred sh -> [Index (Deferred sh)]

offset :: Deferred sh -> Index (Deferred sh) -> Int

uncheckedOffset :: Deferred sh -> Index (Deferred sh) -> Int

unifiedOffset :: Checking check => Deferred sh -> Index (Deferred sh) -> Result check Int

inBounds :: Deferred sh -> Index (Deferred sh) -> Bool

sizeOffset :: Deferred sh -> (Int, Index (Deferred sh) -> Int)

uncheckedSizeOffset :: Deferred sh -> (Int, Index (Deferred sh) -> Int)

unifiedSizeOffset :: Checking check => Deferred sh -> (Int, Index (Deferred sh) -> Result check Int)

C sh => C (Deferred sh)

Defined in Data.Array.Comfort.Shape

Methods

size :: Deferred sh -> Int

type Index (Deferred sh)

Defined in Data.Array.Comfort.Shape

type Index (Deferred sh) = DeferredIndex sh

newtype DeferredIndex sh

DeferredIndex has an Ord instance that is based on the storage order in memory. This way, you can put DeferredIndex values in a Set or use them as keys in a Map even if Index sh has no Ord instance. The downside is, that the ordering of DeferredIndex sh may differ from the one of Index sh.

Constructors

DeferredIndex Int

Instances

Eq (DeferredIndex sh)

Defined in Data.Array.Comfort.Shape

Methods

(==) :: DeferredIndex sh -> DeferredIndex sh -> Bool

(/=) :: DeferredIndex sh -> DeferredIndex sh -> Bool

Ord (DeferredIndex sh)

Defined in Data.Array.Comfort.Shape

Methods

compare :: DeferredIndex sh -> DeferredIndex sh -> Ordering

(<) :: DeferredIndex sh -> DeferredIndex sh -> Bool

(<=) :: DeferredIndex sh -> DeferredIndex sh -> Bool

(>) :: DeferredIndex sh -> DeferredIndex sh -> Bool

(>=) :: DeferredIndex sh -> DeferredIndex sh -> Bool

max :: DeferredIndex sh -> DeferredIndex sh -> DeferredIndex sh

min :: DeferredIndex sh -> DeferredIndex sh -> DeferredIndex sh

Show (DeferredIndex sh)

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> DeferredIndex sh -> ShowS

show :: DeferredIndex sh -> String

showList :: [DeferredIndex sh] -> ShowS

Storable (DeferredIndex sh)

Defined in Data.Array.Comfort.Shape

Methods

sizeOf :: DeferredIndex sh -> Int

alignment :: DeferredIndex sh -> Int

peekElemOff :: Ptr (DeferredIndex sh) -> Int -> IO (DeferredIndex sh)

pokeElemOff :: Ptr (DeferredIndex sh) -> Int -> DeferredIndex sh -> IO ()

peekByteOff :: Ptr b -> Int -> IO (DeferredIndex sh)

pokeByteOff :: Ptr b -> Int -> DeferredIndex sh -> IO ()

peek :: Ptr (DeferredIndex sh) -> IO (DeferredIndex sh)

poke :: Ptr (DeferredIndex sh) -> DeferredIndex sh -> IO ()

deferIndex :: (Indexed sh, Index sh ~ ix) => sh -> ix -> DeferredIndex sh

revealIndex :: (InvIndexed sh, Index sh ~ ix) => sh -> DeferredIndex sh -> ix

data sh0 ::+ sh1 infixr 5

Row-major composition of two dimensions.

>>> Shape.indices (Shape.ZeroBased (3::Int) ::+ Shape.Range 'a' 'c')
[Left 0,Left 1,Left 2,Right 'a',Right 'b',Right 'c']

Constructors

sh0 ::+ sh1 infixr 5

Instances

(Eq sh0, Eq sh1) => Eq (sh0 ::+ sh1)

Defined in Data.Array.Comfort.Shape

Methods

(==) :: (sh0 ::+ sh1) -> (sh0 ::+ sh1) -> Bool

(/=) :: (sh0 ::+ sh1) -> (sh0 ::+ sh1) -> Bool

(Show sh0, Show sh1) => Show (sh0 ::+ sh1)

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> (sh0 ::+ sh1) -> ShowS

show :: (sh0 ::+ sh1) -> String

showList :: [sh0 ::+ sh1] -> ShowS

(NFData sh0, NFData sh1) => NFData (sh0 ::+ sh1)

Defined in Data.Array.Comfort.Shape

Methods

rnf :: (sh0 ::+ sh1) -> ()

(Static sh0, Static sh1) => Static (sh0 ::+ sh1)

Defined in Data.Array.Comfort.Shape

Methods

static :: sh0 ::+ sh1

(InvIndexed sh0, InvIndexed sh1) => InvIndexed (sh0 ::+ sh1)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: (sh0 ::+ sh1) -> Int -> Index (sh0 ::+ sh1)

uncheckedIndexFromOffset :: (sh0 ::+ sh1) -> Int -> Index (sh0 ::+ sh1)

unifiedIndexFromOffset :: Checking check => (sh0 ::+ sh1) -> Int -> Result check (Index (sh0 ::+ sh1))

(Indexed sh0, Indexed sh1) => Indexed (sh0 ::+ sh1)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (sh0 ::+ sh1)

Methods

indices :: (sh0 ::+ sh1) -> [Index (sh0 ::+ sh1)]

offset :: (sh0 ::+ sh1) -> Index (sh0 ::+ sh1) -> Int

uncheckedOffset :: (sh0 ::+ sh1) -> Index (sh0 ::+ sh1) -> Int

unifiedOffset :: Checking check => (sh0 ::+ sh1) -> Index (sh0 ::+ sh1) -> Result check Int

inBounds :: (sh0 ::+ sh1) -> Index (sh0 ::+ sh1) -> Bool

sizeOffset :: (sh0 ::+ sh1) -> (Int, Index (sh0 ::+ sh1) -> Int)

uncheckedSizeOffset :: (sh0 ::+ sh1) -> (Int, Index (sh0 ::+ sh1) -> Int)

unifiedSizeOffset :: Checking check => (sh0 ::+ sh1) -> (Int, Index (sh0 ::+ sh1) -> Result check Int)

(C sh0, C sh1) => C (sh0 ::+ sh1)

Defined in Data.Array.Comfort.Shape

Methods

size :: (sh0 ::+ sh1) -> Int

type Index (sh0 ::+ sh1)

Defined in Data.Array.Comfort.Shape

type Index (sh0 ::+ sh1) = Either (Index sh0) (Index sh1)

newtype Square sh

Square is like a Cartesian product, but it is statically asserted that both dimension shapes match.

>>> Shape.indices $ Shape.Square $ Shape.ZeroBased (3::Int)
[(0,0),(0,1),(0,2),(1,0),(1,1),(1,2),(2,0),(2,1),(2,2)]

Constructors

Square

Fields

• squareSize :: sh

Instances

Functor Square

Defined in Data.Array.Comfort.Shape

Methods

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

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

Applicative Square

Defined in Data.Array.Comfort.Shape

Methods

pure :: a -> Square a

(<*>) :: Square (a -> b) -> Square a -> Square b

liftA2 :: (a -> b -> c) -> Square a -> Square b -> Square c

(*>) :: Square a -> Square b -> Square b

(<*) :: Square a -> Square b -> Square a

Eq sh => Eq (Square sh)

Defined in Data.Array.Comfort.Shape

Methods

(==) :: Square sh -> Square sh -> Bool

(/=) :: Square sh -> Square sh -> Bool

Show sh => Show (Square sh)

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> Square sh -> ShowS

show :: Square sh -> String

showList :: [Square sh] -> ShowS

Storable sh => Storable (Square sh)

Defined in Data.Array.Comfort.Shape

Methods

sizeOf :: Square sh -> Int

alignment :: Square sh -> Int

peekElemOff :: Ptr (Square sh) -> Int -> IO (Square sh)

pokeElemOff :: Ptr (Square sh) -> Int -> Square sh -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Square sh)

pokeByteOff :: Ptr b -> Int -> Square sh -> IO ()

peek :: Ptr (Square sh) -> IO (Square sh)

poke :: Ptr (Square sh) -> Square sh -> IO ()

NFData sh => NFData (Square sh)

Defined in Data.Array.Comfort.Shape

Methods

rnf :: Square sh -> ()

InvIndexed sh => InvIndexed (Square sh)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Square sh -> Int -> Index (Square sh)

uncheckedIndexFromOffset :: Square sh -> Int -> Index (Square sh)

unifiedIndexFromOffset :: Checking check => Square sh -> Int -> Result check (Index (Square sh))

Indexed sh => Indexed (Square sh)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Square sh)

Methods

indices :: Square sh -> [Index (Square sh)]

offset :: Square sh -> Index (Square sh) -> Int

uncheckedOffset :: Square sh -> Index (Square sh) -> Int

unifiedOffset :: Checking check => Square sh -> Index (Square sh) -> Result check Int

inBounds :: Square sh -> Index (Square sh) -> Bool

sizeOffset :: Square sh -> (Int, Index (Square sh) -> Int)

uncheckedSizeOffset :: Square sh -> (Int, Index (Square sh) -> Int)

unifiedSizeOffset :: Checking check => Square sh -> (Int, Index (Square sh) -> Result check Int)

C sh => C (Square sh)

Defined in Data.Array.Comfort.Shape

Methods

size :: Square sh -> Int

type Index (Square sh)

Defined in Data.Array.Comfort.Shape

type Index (Square sh) = (Index sh, Index sh)

newtype Cube sh

Cube is like a Cartesian product, but it is statically asserted that both dimension shapes match.

>>> Shape.indices $ Shape.Cube $ Shape.ZeroBased (2::Int)
[(0,0,0),(0,0,1),(0,1,0),(0,1,1),(1,0,0),(1,0,1),(1,1,0),(1,1,1)]

Constructors

Cube

Fields

• cubeSize :: sh

Instances

Functor Cube

Defined in Data.Array.Comfort.Shape

Methods

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

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

Applicative Cube

Defined in Data.Array.Comfort.Shape

Methods

pure :: a -> Cube a

(<*>) :: Cube (a -> b) -> Cube a -> Cube b

liftA2 :: (a -> b -> c) -> Cube a -> Cube b -> Cube c

(*>) :: Cube a -> Cube b -> Cube b

(<*) :: Cube a -> Cube b -> Cube a

Eq sh => Eq (Cube sh)

Defined in Data.Array.Comfort.Shape

Methods

(==) :: Cube sh -> Cube sh -> Bool

(/=) :: Cube sh -> Cube sh -> Bool

Show sh => Show (Cube sh)

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> Cube sh -> ShowS

show :: Cube sh -> String

showList :: [Cube sh] -> ShowS

Storable sh => Storable (Cube sh)

Defined in Data.Array.Comfort.Shape

Methods

sizeOf :: Cube sh -> Int

alignment :: Cube sh -> Int

peekElemOff :: Ptr (Cube sh) -> Int -> IO (Cube sh)

pokeElemOff :: Ptr (Cube sh) -> Int -> Cube sh -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Cube sh)

pokeByteOff :: Ptr b -> Int -> Cube sh -> IO ()

peek :: Ptr (Cube sh) -> IO (Cube sh)

poke :: Ptr (Cube sh) -> Cube sh -> IO ()

NFData sh => NFData (Cube sh)

Defined in Data.Array.Comfort.Shape

Methods

rnf :: Cube sh -> ()

InvIndexed sh => InvIndexed (Cube sh)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Cube sh -> Int -> Index (Cube sh)

uncheckedIndexFromOffset :: Cube sh -> Int -> Index (Cube sh)

unifiedIndexFromOffset :: Checking check => Cube sh -> Int -> Result check (Index (Cube sh))

Indexed sh => Indexed (Cube sh)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Cube sh)

Methods

indices :: Cube sh -> [Index (Cube sh)]

offset :: Cube sh -> Index (Cube sh) -> Int

uncheckedOffset :: Cube sh -> Index (Cube sh) -> Int

unifiedOffset :: Checking check => Cube sh -> Index (Cube sh) -> Result check Int

inBounds :: Cube sh -> Index (Cube sh) -> Bool

sizeOffset :: Cube sh -> (Int, Index (Cube sh) -> Int)

uncheckedSizeOffset :: Cube sh -> (Int, Index (Cube sh) -> Int)

unifiedSizeOffset :: Checking check => Cube sh -> (Int, Index (Cube sh) -> Result check Int)

C sh => C (Cube sh)

Defined in Data.Array.Comfort.Shape

Methods

size :: Cube sh -> Int

type Index (Cube sh)

Defined in Data.Array.Comfort.Shape

type Index (Cube sh) = (Index sh, Index sh, Index sh)

data Triangular part size

>>> Shape.indices $ Shape.Triangular Shape.Upper $ Shape.ZeroBased (3::Int)
[(0,0),(0,1),(0,2),(1,1),(1,2),(2,2)]
>>> Shape.indices $ Shape.Triangular Shape.Lower $ Shape.ZeroBased (3::Int)
[(0,0),(1,0),(1,1),(2,0),(2,1),(2,2)]

Constructors

Triangular

Fields

• triangularPart :: part
• triangularSize :: size

Instances

(TriangularPart part, Eq size) => Eq (Triangular part size)

Defined in Data.Array.Comfort.Shape

Methods

(==) :: Triangular part size -> Triangular part size -> Bool

(/=) :: Triangular part size -> Triangular part size -> Bool

(Show part, Show size) => Show (Triangular part size)

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> Triangular part size -> ShowS

show :: Triangular part size -> String

showList :: [Triangular part size] -> ShowS

(TriangularPart part, NFData size) => NFData (Triangular part size)

Defined in Data.Array.Comfort.Shape

Methods

rnf :: Triangular part size -> ()

(TriangularPart part, Static size) => Static (Triangular part size)

Defined in Data.Array.Comfort.Shape

Methods

static :: Triangular part size

(TriangularPart part, InvIndexed size) => InvIndexed (Triangular part size)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Triangular part size -> Int -> Index (Triangular part size)

uncheckedIndexFromOffset :: Triangular part size -> Int -> Index (Triangular part size)

unifiedIndexFromOffset :: Checking check => Triangular part size -> Int -> Result check (Index (Triangular part size))

(TriangularPart part, Indexed size) => Indexed (Triangular part size)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Triangular part size)

Methods

indices :: Triangular part size -> [Index (Triangular part size)]

offset :: Triangular part size -> Index (Triangular part size) -> Int

uncheckedOffset :: Triangular part size -> Index (Triangular part size) -> Int

unifiedOffset :: Checking check => Triangular part size -> Index (Triangular part size) -> Result check Int

inBounds :: Triangular part size -> Index (Triangular part size) -> Bool

sizeOffset :: Triangular part size -> (Int, Index (Triangular part size) -> Int)

uncheckedSizeOffset :: Triangular part size -> (Int, Index (Triangular part size) -> Int)

unifiedSizeOffset :: Checking check => Triangular part size -> (Int, Index (Triangular part size) -> Result check Int)

(TriangularPart part, C size) => C (Triangular part size)

Defined in Data.Array.Comfort.Shape

Methods

size :: Triangular part size -> Int

type Index (Triangular part size)

Defined in Data.Array.Comfort.Shape

type Index (Triangular part size) = (Index size, Index size)

data Lower

Constructors

Lower

Instances

Eq Lower

Defined in Data.Array.Comfort.Shape

Methods

(==) :: Lower -> Lower -> Bool

(/=) :: Lower -> Lower -> Bool

Show Lower

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> Lower -> ShowS

show :: Lower -> String

showList :: [Lower] -> ShowS

data Upper

Constructors

Upper

Instances

Eq Upper

Defined in Data.Array.Comfort.Shape

Methods

(==) :: Upper -> Upper -> Bool

(/=) :: Upper -> Upper -> Bool

Show Upper

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> Upper -> ShowS

show :: Upper -> String

showList :: [Upper] -> ShowS

type LowerTriangular = Triangular Lower

type UpperTriangular = Triangular Upper

lowerTriangular :: size -> LowerTriangular size

upperTriangular :: size -> UpperTriangular size

triangleSize :: Int -> Int

triangleRoot :: Floating a => a -> a

data Simplex order coll f size

Simplex is a generalization of Triangular to more than two dimensions. Indices are tuples of fixed size with elements ordered in ascending, strictly ascending, descending or strictly descending order. "Order" refers to the index order in indices. In order to avoid confusion we suggest that the order of indices is consistent with <=.

Obviously, offset implements ranking and indexFromOffset implements unranking of combinations (in the combinatorial sense) with or without repetitions.

>>> Shape.indices $ Shape.simplexAscending (replicate 3 Shape.AllDistinct) $ Shape.ZeroBased (4::Int)
[[0,1,2],[0,1,3],[0,2,3],[1,2,3]]
>>> Shape.indices $ Shape.simplexAscending (replicate 3 Shape.SomeRepetitive) $ Shape.ZeroBased (3::Int)
[[0,0,0],[0,0,1],[0,0,2],[0,1,1],[0,1,2],[0,2,2],[1,1,1],[1,1,2],[1,2,2],[2,2,2]]
>>> Shape.indices $ Shape.simplexAscending [Shape.Repetitive,Shape.Distinct,Shape.Repetitive] $ Shape.ZeroBased (4::Int)
[[0,0,1],[0,0,2],[0,0,3],[0,1,2],[0,1,3],[0,2,3],[1,1,2],[1,1,3],[1,2,3],[2,2,3]]
>>> Shape.indices $ Shape.simplexAscending [Shape.Repetitive,Shape.Distinct,Shape.Distinct] $ Shape.ZeroBased (4::Int)
[[0,0,1],[0,0,2],[0,0,3],[0,1,2],[0,1,3],[0,2,3],[1,1,2],[1,1,3],[1,2,3],[2,2,3]]

>>> Shape.indices $ Shape.simplexDescending (replicate 3 Shape.AllDistinct) $ Shape.ZeroBased (4::Int)
[[2,1,0],[3,1,0],[3,2,0],[3,2,1]]
>>> Shape.indices $ Shape.simplexDescending (replicate 3 Shape.SomeRepetitive) $ Shape.ZeroBased (3::Int)
[[0,0,0],[1,0,0],[1,1,0],[1,1,1],[2,0,0],[2,1,0],[2,1,1],[2,2,0],[2,2,1],[2,2,2]]
>>> Shape.indices $ Shape.simplexDescending [Shape.Repetitive,Shape.Distinct,Shape.Repetitive] $ Shape.ZeroBased (4::Int)
[[1,1,0],[2,1,0],[2,2,0],[2,2,1],[3,1,0],[3,2,0],[3,2,1],[3,3,0],[3,3,1],[3,3,2]]
>>> Shape.indices $ Shape.simplexDescending [Shape.Repetitive,Shape.Distinct,Shape.Distinct] $ Shape.ZeroBased (4::Int)
[[1,1,0],[2,1,0],[2,2,0],[2,2,1],[3,1,0],[3,2,0],[3,2,1],[3,3,0],[3,3,1],[3,3,2]]

Constructors

Simplex

Fields

• simplexOrder :: SimplexOrder order
• simplexDimension :: f coll
• simplexSize :: size

Instances

(SimplexOrderC order, Show coll, Show1 f, Show size) => Show (Simplex order coll f size)

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> Simplex order coll f size -> ShowS

show :: Simplex order coll f size -> String

showList :: [Simplex order coll f size] -> ShowS

(SimplexOrderC order, CollisionC coll, Traversable f, Eq1 f, InvIndexed size) => InvIndexed (Simplex order coll f size)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Simplex order coll f size -> Int -> Index (Simplex order coll f size)

uncheckedIndexFromOffset :: Simplex order coll f size -> Int -> Index (Simplex order coll f size)

unifiedIndexFromOffset :: Checking check => Simplex order coll f size -> Int -> Result check (Index (Simplex order coll f size))

(SimplexOrderC order, CollisionC coll, Traversable f, Eq1 f, Indexed size) => Indexed (Simplex order coll f size)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Simplex order coll f size)

Methods

indices :: Simplex order coll f size -> [Index (Simplex order coll f size)]

offset :: Simplex order coll f size -> Index (Simplex order coll f size) -> Int

uncheckedOffset :: Simplex order coll f size -> Index (Simplex order coll f size) -> Int

unifiedOffset :: Checking check => Simplex order coll f size -> Index (Simplex order coll f size) -> Result check Int

inBounds :: Simplex order coll f size -> Index (Simplex order coll f size) -> Bool

sizeOffset :: Simplex order coll f size -> (Int, Index (Simplex order coll f size) -> Int)

uncheckedSizeOffset :: Simplex order coll f size -> (Int, Index (Simplex order coll f size) -> Int)

unifiedSizeOffset :: Checking check => Simplex order coll f size -> (Int, Index (Simplex order coll f size) -> Result check Int)

(SimplexOrderC order, CollisionC coll, Traversable f, C size) => C (Simplex order coll f size)

Defined in Data.Array.Comfort.Shape

Methods

size :: Simplex order coll f size -> Int

type Index (Simplex order coll f size)

Defined in Data.Array.Comfort.Shape

type Index (Simplex order coll f size) = f (Index size)

type SimplexAscending = Simplex Ascending

simplexAscending :: f coll -> size -> SimplexAscending coll f size

type SimplexDescending = Simplex Descending

simplexDescending :: f coll -> size -> SimplexDescending coll f size

data Ascending

Instances

SimplexOrderC Ascending

Defined in Data.Array.Comfort.Shape

data Descending

Instances

SimplexOrderC Descending

Defined in Data.Array.Comfort.Shape

data SimplexOrder order where

Constructors

Ascending :: SimplexOrder Ascending

Descending :: SimplexOrder Descending

Instances

Eq (SimplexOrder order)

Defined in Data.Array.Comfort.Shape

Methods

(==) :: SimplexOrder order -> SimplexOrder order -> Bool

(/=) :: SimplexOrder order -> SimplexOrder order -> Bool

Show (SimplexOrder order)

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> SimplexOrder order -> ShowS

show :: SimplexOrder order -> String

showList :: [SimplexOrder order] -> ShowS

class SimplexOrderC order

Instances

SimplexOrderC Descending

Defined in Data.Array.Comfort.Shape

SimplexOrderC Ascending

Defined in Data.Array.Comfort.Shape

data AllDistinct

Constructors

AllDistinct

Instances

Eq AllDistinct

Defined in Data.Array.Comfort.Shape

Methods

(==) :: AllDistinct -> AllDistinct -> Bool

(/=) :: AllDistinct -> AllDistinct -> Bool

Show AllDistinct

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> AllDistinct -> ShowS

show :: AllDistinct -> String

showList :: [AllDistinct] -> ShowS

CollisionC AllDistinct

Defined in Data.Array.Comfort.Shape

Methods

repetitionAllowed :: AllDistinct -> Bool

data SomeRepetitive

Constructors

SomeRepetitive

Instances

Eq SomeRepetitive

Defined in Data.Array.Comfort.Shape

Methods

(==) :: SomeRepetitive -> SomeRepetitive -> Bool

(/=) :: SomeRepetitive -> SomeRepetitive -> Bool

Show SomeRepetitive

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> SomeRepetitive -> ShowS

show :: SomeRepetitive -> String

showList :: [SomeRepetitive] -> ShowS

CollisionC SomeRepetitive

Defined in Data.Array.Comfort.Shape

Methods

repetitionAllowed :: SomeRepetitive -> Bool

data Collision

Constructors

Distinct

Repetitive

Instances

Enum Collision

Defined in Data.Array.Comfort.Shape

Methods

succ :: Collision -> Collision

pred :: Collision -> Collision

toEnum :: Int -> Collision

fromEnum :: Collision -> Int

enumFrom :: Collision -> [Collision]

enumFromThen :: Collision -> Collision -> [Collision]

enumFromTo :: Collision -> Collision -> [Collision]

enumFromThenTo :: Collision -> Collision -> Collision -> [Collision]

Eq Collision

Defined in Data.Array.Comfort.Shape

Methods

(==) :: Collision -> Collision -> Bool

(/=) :: Collision -> Collision -> Bool

Ord Collision

Defined in Data.Array.Comfort.Shape

Methods

compare :: Collision -> Collision -> Ordering

(<) :: Collision -> Collision -> Bool

(<=) :: Collision -> Collision -> Bool

(>) :: Collision -> Collision -> Bool

(>=) :: Collision -> Collision -> Bool

max :: Collision -> Collision -> Collision

min :: Collision -> Collision -> Collision

Show Collision

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> Collision -> ShowS

show :: Collision -> String

showList :: [Collision] -> ShowS

CollisionC Collision

Defined in Data.Array.Comfort.Shape

Methods

repetitionAllowed :: Collision -> Bool

class CollisionC coll

Minimal complete definition

repetitionAllowed

Instances

CollisionC Collision

Defined in Data.Array.Comfort.Shape

Methods

repetitionAllowed :: Collision -> Bool

CollisionC SomeRepetitive

Defined in Data.Array.Comfort.Shape

Methods

repetitionAllowed :: SomeRepetitive -> Bool

CollisionC AllDistinct

Defined in Data.Array.Comfort.Shape

Methods

repetitionAllowed :: AllDistinct -> Bool

newtype Cyclic n

Cyclic is a shape, where the indices wrap around at the array boundaries. E.g.

let shape = Shape.Cyclic (10::Int) in Shape.offset shape (-1) == Shape.offset shape 9

This also means that there are multiple indices that address the same array element.

>>> Shape.indices (Shape.Cyclic (7::Int))
[0,1,2,3,4,5,6]

Constructors

Cyclic

Fields

• cyclicSize :: n

Instances

Functor Cyclic

Defined in Data.Array.Comfort.Shape

Methods

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

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

Applicative Cyclic

Defined in Data.Array.Comfort.Shape

Methods

pure :: a -> Cyclic a

(<*>) :: Cyclic (a -> b) -> Cyclic a -> Cyclic b

liftA2 :: (a -> b -> c) -> Cyclic a -> Cyclic b -> Cyclic c

(*>) :: Cyclic a -> Cyclic b -> Cyclic b

(<*) :: Cyclic a -> Cyclic b -> Cyclic a

Eq n => Eq (Cyclic n)

Defined in Data.Array.Comfort.Shape

Methods

(==) :: Cyclic n -> Cyclic n -> Bool

(/=) :: Cyclic n -> Cyclic n -> Bool

Show n => Show (Cyclic n)

Defined in Data.Array.Comfort.Shape

Methods

showsPrec :: Int -> Cyclic n -> ShowS

show :: Cyclic n -> String

showList :: [Cyclic n] -> ShowS

Storable n => Storable (Cyclic n)

Defined in Data.Array.Comfort.Shape

Methods

sizeOf :: Cyclic n -> Int

alignment :: Cyclic n -> Int

peekElemOff :: Ptr (Cyclic n) -> Int -> IO (Cyclic n)

pokeElemOff :: Ptr (Cyclic n) -> Int -> Cyclic n -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Cyclic n)

pokeByteOff :: Ptr b -> Int -> Cyclic n -> IO ()

peek :: Ptr (Cyclic n) -> IO (Cyclic n)

poke :: Ptr (Cyclic n) -> Cyclic n -> IO ()

NFData n => NFData (Cyclic n)

Defined in Data.Array.Comfort.Shape

Methods

rnf :: Cyclic n -> ()

Integral n => InvIndexed (Cyclic n)

Defined in Data.Array.Comfort.Shape

Methods

indexFromOffset :: Cyclic n -> Int -> Index (Cyclic n)

uncheckedIndexFromOffset :: Cyclic n -> Int -> Index (Cyclic n)

unifiedIndexFromOffset :: Checking check => Cyclic n -> Int -> Result check (Index (Cyclic n))

Integral n => Indexed (Cyclic n)

Defined in Data.Array.Comfort.Shape

Associated Types

type Index (Cyclic n)

Methods

indices :: Cyclic n -> [Index (Cyclic n)]

offset :: Cyclic n -> Index (Cyclic n) -> Int

uncheckedOffset :: Cyclic n -> Index (Cyclic n) -> Int

unifiedOffset :: Checking check => Cyclic n -> Index (Cyclic n) -> Result check Int

inBounds :: Cyclic n -> Index (Cyclic n) -> Bool

sizeOffset :: Cyclic n -> (Int, Index (Cyclic n) -> Int)

uncheckedSizeOffset :: Cyclic n -> (Int, Index (Cyclic n) -> Int)

unifiedSizeOffset :: Checking check => Cyclic n -> (Int, Index (Cyclic n) -> Result check Int)

Integral n => C (Cyclic n)

Defined in Data.Array.Comfort.Shape

Methods

size :: Cyclic n -> Int

type Index (Cyclic n)

Defined in Data.Array.Comfort.Shape

type Index (Cyclic n) = n