Data.Array.Comfort.Shape

Documentation

class C sh where

Minimal complete definition

indices, size, (sizeOffset | offset), inBounds

Associated Types

type Index sh :: *

Methods

indices :: sh -> [Index sh]

offset :: sh -> Index sh -> Int

uncheckedOffset :: sh -> Index sh -> Int

inBounds :: sh -> Index sh -> Bool

size :: sh -> Int

uncheckedSize :: sh -> Int

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

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

Instances

C ()

Associated Types

type Index () :: *

Methods

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

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

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

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

size :: () -> Int

uncheckedSize :: () -> Int

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

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

Integral n => C (Shifted n)

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

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

size :: Shifted n -> Int

uncheckedSize :: Shifted n -> Int

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

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

Ix n => C (Range n)

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

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

size :: Range n -> Int

uncheckedSize :: Range n -> Int

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

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

Integral n => C (OneBased n)

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

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

size :: OneBased n -> Int

uncheckedSize :: OneBased n -> Int

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

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

Integral n => C (ZeroBased n)

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

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

size :: ZeroBased n -> Int

uncheckedSize :: ZeroBased n -> Int

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

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

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

Row-major composition of two dimensions.

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

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

size :: (sh0, sh1) -> Int

uncheckedSize :: (sh0, sh1) -> Int

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

newtype ZeroBased n

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

Constructors

ZeroBased

Fields

• zeroBasedSize :: n

Instances

Eq n => Eq (ZeroBased n)

Methods

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

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

Show n => Show (ZeroBased n)

Methods

showsPrec :: Int -> ZeroBased n -> ShowS

show :: ZeroBased n -> String

showList :: [ZeroBased n] -> ShowS

Integral n => C (ZeroBased n)

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

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

size :: ZeroBased n -> Int

uncheckedSize :: ZeroBased n -> Int

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

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

type Index (ZeroBased n)

type Index (ZeroBased n) = n

newtype OneBased n

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

Constructors

OneBased

Fields

• oneBasedSize :: n

Instances

Eq n => Eq (OneBased n)

Methods

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

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

Show n => Show (OneBased n)

Methods

showsPrec :: Int -> OneBased n -> ShowS

show :: OneBased n -> String

showList :: [OneBased n] -> ShowS

Integral n => C (OneBased n)

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

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

size :: OneBased n -> Int

uncheckedSize :: OneBased n -> Int

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

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

type Index (OneBased n)

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.

Constructors

Range

Fields

• rangeFrom, rangeTo :: n

Instances

Eq n => Eq (Range n)

Methods

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

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

Show n => Show (Range n)

Methods

showsPrec :: Int -> Range n -> ShowS

show :: Range n -> String

showList :: [Range n] -> ShowS

Storable n => Storable (Range n)

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 ()

Ix n => C (Range n)

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

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

size :: Range n -> Int

uncheckedSize :: Range n -> Int

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

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

type Index (Range n)

type Index (Range n) = n

data Shifted n

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

Constructors

Shifted

Fields

• shiftedOffset, shiftedSize :: n

Instances

Eq n => Eq (Shifted n)

Methods

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

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

Show n => Show (Shifted n)

Methods

showsPrec :: Int -> Shifted n -> ShowS

show :: Shifted n -> String

showList :: [Shifted n] -> ShowS

Storable n => Storable (Shifted n)

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 ()

Integral n => C (Shifted n)

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

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

size :: Shifted n -> Int

uncheckedSize :: Shifted n -> Int

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

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

type Index (Shifted n)

type Index (Shifted n) = n

data sh0 :+: sh1 infixr 5

Constructors

sh0 :+: sh1 infixr 5

Instances

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

Methods

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

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

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

Methods

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

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

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

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

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

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

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

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

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

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

type Index ((:+:) sh0 sh1)

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