Data.Array.Comfort.Shape

Documentation

class C sh where

Minimal complete definition

size

Methods

size :: sh -> Int

uncheckedSize :: sh -> Int

Instances

C ()

Defined in Data.Array.Comfort.Shape

Methods

size :: () -> Int

uncheckedSize :: () -> Int

Integral n => C (Shifted n)

Defined in Data.Array.Comfort.Shape

Methods

size :: Shifted n -> Int

uncheckedSize :: Shifted n -> Int

Ix n => C (Range n)

Defined in Data.Array.Comfort.Shape

Methods

size :: Range n -> Int

uncheckedSize :: Range n -> Int

Integral n => C (OneBased n)

Defined in Data.Array.Comfort.Shape

Methods

size :: OneBased n -> Int

uncheckedSize :: OneBased n -> Int

Integral n => C (ZeroBased n)

Defined in Data.Array.Comfort.Shape

Methods

size :: ZeroBased n -> Int

uncheckedSize :: ZeroBased n -> Int

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

Row-major composition of two dimensions.

Defined in Data.Array.Comfort.Shape

Methods

size :: (sh0, sh1) -> Int

uncheckedSize :: (sh0, sh1) -> Int

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

Defined in Data.Array.Comfort.Shape

Methods

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

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

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

Defined in Data.Array.Comfort.Shape

Methods

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

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

class C sh => Indexed sh where

Minimal complete definition

indices, (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

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

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

Instances

Indexed ()

Defined in Data.Array.Comfort.Shape

Associated Types

type Index () :: *

Methods

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

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

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

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

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

uncheckedSizeOffset :: () -> Index () -> (Int, 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

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

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

uncheckedSizeOffset :: Shifted n -> Index (Shifted n) -> (Int, 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

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

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

uncheckedSizeOffset :: Range n -> Index (Range n) -> (Int, 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

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

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

uncheckedSizeOffset :: OneBased n -> Index (OneBased n) -> (Int, 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

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

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

uncheckedSizeOffset :: ZeroBased n -> Index (ZeroBased n) -> (Int, 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

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

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

uncheckedSizeOffset :: (sh0, sh1) -> Index (sh0, sh1) -> (Int, 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

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

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

uncheckedSizeOffset :: (sh0 :+: sh1) -> Index (sh0 :+: sh1) -> (Int, 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

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

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

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

class Indexed sh => InvIndexed sh where

Minimal complete definition

indexFromOffset

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

Instances

InvIndexed ()

Defined in Data.Array.Comfort.Shape

Methods

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

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

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)

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)

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)

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)

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

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

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

newtype ZeroBased n

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

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

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

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)

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

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

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

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

Integral n => C (ZeroBased n)

Defined in Data.Array.Comfort.Shape

Methods

size :: ZeroBased n -> Int

uncheckedSize :: ZeroBased n -> Int

type Index (ZeroBased n)

Defined in Data.Array.Comfort.Shape

type Index (ZeroBased n) = n

newtype OneBased n

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

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

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

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)

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

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

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

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

Integral n => C (OneBased n)

Defined in Data.Array.Comfort.Shape

Methods

size :: OneBased n -> Int

uncheckedSize :: 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.

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

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)

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

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

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

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

Ix n => C (Range n)

Defined in Data.Array.Comfort.Shape

Methods

size :: Range n -> Int

uncheckedSize :: 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.

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

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)

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

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

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

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

Integral n => C (Shifted n)

Defined in Data.Array.Comfort.Shape

Methods

size :: Shifted n -> Int

uncheckedSize :: Shifted n -> Int

type Index (Shifted n)

Defined in Data.Array.Comfort.Shape

type Index (Shifted n) = n

data sh0 :+: sh1 infixr 5

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

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

(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

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

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

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

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

Defined in Data.Array.Comfort.Shape

Methods

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

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

type Index (sh0 :+: sh1)

Defined in Data.Array.Comfort.Shape

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