Safe Haskell	None
Language	Haskell98

Data.Array.Comfort.Shape

Synopsis

class C sh where
class C sh => Indexed sh where
- type Index sh :: *
class Indexed sh => InvIndexed sh where
newtype ZeroBased n = ZeroBased {
- zeroBasedSize :: n
}
newtype OneBased n = OneBased {
- oneBasedSize :: n
}
data Range n = Range {
- rangeFrom, rangeTo :: n
}
data Shifted n = Shifted {
- shiftedOffset, shiftedSize :: n
}
data sh0 :+: sh1 = sh0 :+: sh1

Documentation

class C sh where Source #

Minimal complete definition

size

Methods

size :: sh -> Int Source #

uncheckedSize :: sh -> Int Source #

Instances

C () Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: () -> Int Source # uncheckedSize :: () -> Int Source #
Integral n => C (Shifted n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: Shifted n -> Int Source # uncheckedSize :: Shifted n -> Int Source #
Ix n => C (Range n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: Range n -> Int Source # uncheckedSize :: Range n -> Int Source #
Integral n => C (OneBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: OneBased n -> Int Source # uncheckedSize :: OneBased n -> Int Source #
Integral n => C (ZeroBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: ZeroBased n -> Int Source # uncheckedSize :: ZeroBased n -> Int Source #
(C sh0, C sh1) => C (sh0, sh1) Source #	Row-major composition of two dimensions.
Instance details Defined in Data.Array.Comfort.Shape Methods size :: (sh0, sh1) -> Int Source # uncheckedSize :: (sh0, sh1) -> Int Source #
(C sh0, C sh1) => C (sh0 :+: sh1) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: (sh0 :+: sh1) -> Int Source # uncheckedSize :: (sh0 :+: sh1) -> Int Source #
(C sh0, C sh1, C sh2) => C (sh0, sh1, sh2) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: (sh0, sh1, sh2) -> Int Source # uncheckedSize :: (sh0, sh1, sh2) -> Int Source #

class C sh => Indexed sh where Source #

Minimal complete definition

indices, (sizeOffset | offset), inBounds

Associated Types

type Index sh :: * Source #

Methods

indices :: sh -> [Index sh] Source #

offset :: sh -> Index sh -> Int Source #

uncheckedOffset :: sh -> Index sh -> Int Source #

inBounds :: sh -> Index sh -> Bool Source #

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

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

Instances

Indexed () Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index () :: * Source # Methods indices :: () -> [Index ()] Source # offset :: () -> Index () -> Int Source # uncheckedOffset :: () -> Index () -> Int Source # inBounds :: () -> Index () -> Bool Source # sizeOffset :: () -> Index () -> (Int, Int) Source # uncheckedSizeOffset :: () -> Index () -> (Int, Int) Source #
Integral n => Indexed (Shifted n) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (Shifted n) :: * Source # Methods indices :: Shifted n -> [Index (Shifted n)] Source # offset :: Shifted n -> Index (Shifted n) -> Int Source # uncheckedOffset :: Shifted n -> Index (Shifted n) -> Int Source # inBounds :: Shifted n -> Index (Shifted n) -> Bool Source # sizeOffset :: Shifted n -> Index (Shifted n) -> (Int, Int) Source # uncheckedSizeOffset :: Shifted n -> Index (Shifted n) -> (Int, Int) Source #
Ix n => Indexed (Range n) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (Range n) :: * Source # Methods indices :: Range n -> [Index (Range n)] Source # offset :: Range n -> Index (Range n) -> Int Source # uncheckedOffset :: Range n -> Index (Range n) -> Int Source # inBounds :: Range n -> Index (Range n) -> Bool Source # sizeOffset :: Range n -> Index (Range n) -> (Int, Int) Source # uncheckedSizeOffset :: Range n -> Index (Range n) -> (Int, Int) Source #
Integral n => Indexed (OneBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (OneBased n) :: * Source # Methods indices :: OneBased n -> [Index (OneBased n)] Source # offset :: OneBased n -> Index (OneBased n) -> Int Source # uncheckedOffset :: OneBased n -> Index (OneBased n) -> Int Source # inBounds :: OneBased n -> Index (OneBased n) -> Bool Source # sizeOffset :: OneBased n -> Index (OneBased n) -> (Int, Int) Source # uncheckedSizeOffset :: OneBased n -> Index (OneBased n) -> (Int, Int) Source #
Integral n => Indexed (ZeroBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (ZeroBased n) :: * Source # Methods indices :: ZeroBased n -> [Index (ZeroBased n)] Source # offset :: ZeroBased n -> Index (ZeroBased n) -> Int Source # uncheckedOffset :: ZeroBased n -> Index (ZeroBased n) -> Int Source # inBounds :: ZeroBased n -> Index (ZeroBased n) -> Bool Source # sizeOffset :: ZeroBased n -> Index (ZeroBased n) -> (Int, Int) Source # uncheckedSizeOffset :: ZeroBased n -> Index (ZeroBased n) -> (Int, Int) Source #
(Indexed sh0, Indexed sh1) => Indexed (sh0, sh1) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (sh0, sh1) :: * Source # Methods indices :: (sh0, sh1) -> [Index (sh0, sh1)] Source # offset :: (sh0, sh1) -> Index (sh0, sh1) -> Int Source # uncheckedOffset :: (sh0, sh1) -> Index (sh0, sh1) -> Int Source # inBounds :: (sh0, sh1) -> Index (sh0, sh1) -> Bool Source # sizeOffset :: (sh0, sh1) -> Index (sh0, sh1) -> (Int, Int) Source # uncheckedSizeOffset :: (sh0, sh1) -> Index (sh0, sh1) -> (Int, Int) Source #
(Indexed sh0, Indexed sh1) => Indexed (sh0 :+: sh1) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (sh0 :+: sh1) :: * Source # Methods indices :: (sh0 :+: sh1) -> [Index (sh0 :+: sh1)] Source # offset :: (sh0 :+: sh1) -> Index (sh0 :+: sh1) -> Int Source # uncheckedOffset :: (sh0 :+: sh1) -> Index (sh0 :+: sh1) -> Int Source # inBounds :: (sh0 :+: sh1) -> Index (sh0 :+: sh1) -> Bool Source # sizeOffset :: (sh0 :+: sh1) -> Index (sh0 :+: sh1) -> (Int, Int) Source # uncheckedSizeOffset :: (sh0 :+: sh1) -> Index (sh0 :+: sh1) -> (Int, Int) Source #
(Indexed sh0, Indexed sh1, Indexed sh2) => Indexed (sh0, sh1, sh2) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (sh0, sh1, sh2) :: * Source # Methods indices :: (sh0, sh1, sh2) -> [Index (sh0, sh1, sh2)] Source # offset :: (sh0, sh1, sh2) -> Index (sh0, sh1, sh2) -> Int Source # uncheckedOffset :: (sh0, sh1, sh2) -> Index (sh0, sh1, sh2) -> Int Source # inBounds :: (sh0, sh1, sh2) -> Index (sh0, sh1, sh2) -> Bool Source # sizeOffset :: (sh0, sh1, sh2) -> Index (sh0, sh1, sh2) -> (Int, Int) Source # uncheckedSizeOffset :: (sh0, sh1, sh2) -> Index (sh0, sh1, sh2) -> (Int, Int) Source #

class Indexed sh => InvIndexed sh where Source #

Minimal complete definition

indexFromOffset

Methods

indexFromOffset :: sh -> Int -> Index sh Source #

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

uncheckedIndexFromOffset :: sh -> Int -> Index sh Source #

Instances

InvIndexed () Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: () -> Int -> Index () Source # uncheckedIndexFromOffset :: () -> Int -> Index () Source #
Integral n => InvIndexed (Shifted n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: Shifted n -> Int -> Index (Shifted n) Source # uncheckedIndexFromOffset :: Shifted n -> Int -> Index (Shifted n) Source #
Ix n => InvIndexed (Range n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: Range n -> Int -> Index (Range n) Source # uncheckedIndexFromOffset :: Range n -> Int -> Index (Range n) Source #
Integral n => InvIndexed (OneBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: OneBased n -> Int -> Index (OneBased n) Source # uncheckedIndexFromOffset :: OneBased n -> Int -> Index (OneBased n) Source #
Integral n => InvIndexed (ZeroBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: ZeroBased n -> Int -> Index (ZeroBased n) Source # uncheckedIndexFromOffset :: ZeroBased n -> Int -> Index (ZeroBased n) Source #
(InvIndexed sh0, InvIndexed sh1) => InvIndexed (sh0, sh1) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: (sh0, sh1) -> Int -> Index (sh0, sh1) Source # uncheckedIndexFromOffset :: (sh0, sh1) -> Int -> Index (sh0, sh1) Source #
(InvIndexed sh0, InvIndexed sh1) => InvIndexed (sh0 :+: sh1) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: (sh0 :+: sh1) -> Int -> Index (sh0 :+: sh1) Source # uncheckedIndexFromOffset :: (sh0 :+: sh1) -> Int -> Index (sh0 :+: sh1) Source #
(InvIndexed sh0, InvIndexed sh1, InvIndexed sh2) => InvIndexed (sh0, sh1, sh2) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: (sh0, sh1, sh2) -> Int -> Index (sh0, sh1, sh2) Source # uncheckedIndexFromOffset :: (sh0, sh1, sh2) -> Int -> Index (sh0, sh1, sh2) Source #

newtype ZeroBased n Source #

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

Constructors

ZeroBased
Fields zeroBasedSize :: n

Instances

Functor ZeroBased Source #
Instance details Defined in Data.Array.Comfort.Shape Methods fmap :: (a -> b) -> ZeroBased a -> ZeroBased b # (<$) :: a -> ZeroBased b -> ZeroBased a #
Eq n => Eq (ZeroBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods (==) :: ZeroBased n -> ZeroBased n -> Bool # (/=) :: ZeroBased n -> ZeroBased n -> Bool #
Show n => Show (ZeroBased n) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: ZeroBased n -> Int -> Index (ZeroBased n) Source # uncheckedIndexFromOffset :: ZeroBased n -> Int -> Index (ZeroBased n) Source #
Integral n => Indexed (ZeroBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (ZeroBased n) :: * Source # Methods indices :: ZeroBased n -> [Index (ZeroBased n)] Source # offset :: ZeroBased n -> Index (ZeroBased n) -> Int Source # uncheckedOffset :: ZeroBased n -> Index (ZeroBased n) -> Int Source # inBounds :: ZeroBased n -> Index (ZeroBased n) -> Bool Source # sizeOffset :: ZeroBased n -> Index (ZeroBased n) -> (Int, Int) Source # uncheckedSizeOffset :: ZeroBased n -> Index (ZeroBased n) -> (Int, Int) Source #
Integral n => C (ZeroBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: ZeroBased n -> Int Source # uncheckedSize :: ZeroBased n -> Int Source #
type Index (ZeroBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape type Index (ZeroBased n) = n

newtype OneBased n Source #

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

Constructors

OneBased
Fields oneBasedSize :: n

Instances

Functor OneBased Source #
Instance details Defined in Data.Array.Comfort.Shape Methods fmap :: (a -> b) -> OneBased a -> OneBased b # (<$) :: a -> OneBased b -> OneBased a #
Eq n => Eq (OneBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods (==) :: OneBased n -> OneBased n -> Bool # (/=) :: OneBased n -> OneBased n -> Bool #
Show n => Show (OneBased n) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: OneBased n -> Int -> Index (OneBased n) Source # uncheckedIndexFromOffset :: OneBased n -> Int -> Index (OneBased n) Source #
Integral n => Indexed (OneBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (OneBased n) :: * Source # Methods indices :: OneBased n -> [Index (OneBased n)] Source # offset :: OneBased n -> Index (OneBased n) -> Int Source # uncheckedOffset :: OneBased n -> Index (OneBased n) -> Int Source # inBounds :: OneBased n -> Index (OneBased n) -> Bool Source # sizeOffset :: OneBased n -> Index (OneBased n) -> (Int, Int) Source # uncheckedSizeOffset :: OneBased n -> Index (OneBased n) -> (Int, Int) Source #
Integral n => C (OneBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: OneBased n -> Int Source # uncheckedSize :: OneBased n -> Int Source #
type Index (OneBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape type Index (OneBased n) = n

data Range n Source #

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 Source #
Instance details Defined in Data.Array.Comfort.Shape Methods fmap :: (a -> b) -> Range a -> Range b # (<$) :: a -> Range b -> Range a #
Eq n => Eq (Range n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods (==) :: Range n -> Range n -> Bool # (/=) :: Range n -> Range n -> Bool #
Show n => Show (Range n) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: Range n -> Int -> Index (Range n) Source # uncheckedIndexFromOffset :: Range n -> Int -> Index (Range n) Source #
Ix n => Indexed (Range n) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (Range n) :: * Source # Methods indices :: Range n -> [Index (Range n)] Source # offset :: Range n -> Index (Range n) -> Int Source # uncheckedOffset :: Range n -> Index (Range n) -> Int Source # inBounds :: Range n -> Index (Range n) -> Bool Source # sizeOffset :: Range n -> Index (Range n) -> (Int, Int) Source # uncheckedSizeOffset :: Range n -> Index (Range n) -> (Int, Int) Source #
Ix n => C (Range n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: Range n -> Int Source # uncheckedSize :: Range n -> Int Source #
type Index (Range n) Source #
Instance details Defined in Data.Array.Comfort.Shape type Index (Range n) = n

data Shifted n Source #

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

Constructors

Shifted
Fields shiftedOffset, shiftedSize :: n

Instances

Functor Shifted Source #
Instance details Defined in Data.Array.Comfort.Shape Methods fmap :: (a -> b) -> Shifted a -> Shifted b # (<$) :: a -> Shifted b -> Shifted a #
Eq n => Eq (Shifted n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods (==) :: Shifted n -> Shifted n -> Bool # (/=) :: Shifted n -> Shifted n -> Bool #
Show n => Show (Shifted n) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: Shifted n -> Int -> Index (Shifted n) Source # uncheckedIndexFromOffset :: Shifted n -> Int -> Index (Shifted n) Source #
Integral n => Indexed (Shifted n) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (Shifted n) :: * Source # Methods indices :: Shifted n -> [Index (Shifted n)] Source # offset :: Shifted n -> Index (Shifted n) -> Int Source # uncheckedOffset :: Shifted n -> Index (Shifted n) -> Int Source # inBounds :: Shifted n -> Index (Shifted n) -> Bool Source # sizeOffset :: Shifted n -> Index (Shifted n) -> (Int, Int) Source # uncheckedSizeOffset :: Shifted n -> Index (Shifted n) -> (Int, Int) Source #
Integral n => C (Shifted n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: Shifted n -> Int Source # uncheckedSize :: Shifted n -> Int Source #
type Index (Shifted n) Source #
Instance details Defined in Data.Array.Comfort.Shape type Index (Shifted n) = n

data sh0 :+: sh1 infixr 5 Source #

Constructors

sh0 :+: sh1 infixr 5

Instances

(Eq sh0, Eq sh1) => Eq (sh0 :+: sh1) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods (==) :: (sh0 :+: sh1) -> (sh0 :+: sh1) -> Bool # (/=) :: (sh0 :+: sh1) -> (sh0 :+: sh1) -> Bool #
(Show sh0, Show sh1) => Show (sh0 :+: sh1) Source #
Instance details 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) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: (sh0 :+: sh1) -> Int -> Index (sh0 :+: sh1) Source # uncheckedIndexFromOffset :: (sh0 :+: sh1) -> Int -> Index (sh0 :+: sh1) Source #
(Indexed sh0, Indexed sh1) => Indexed (sh0 :+: sh1) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (sh0 :+: sh1) :: * Source # Methods indices :: (sh0 :+: sh1) -> [Index (sh0 :+: sh1)] Source # offset :: (sh0 :+: sh1) -> Index (sh0 :+: sh1) -> Int Source # uncheckedOffset :: (sh0 :+: sh1) -> Index (sh0 :+: sh1) -> Int Source # inBounds :: (sh0 :+: sh1) -> Index (sh0 :+: sh1) -> Bool Source # sizeOffset :: (sh0 :+: sh1) -> Index (sh0 :+: sh1) -> (Int, Int) Source # uncheckedSizeOffset :: (sh0 :+: sh1) -> Index (sh0 :+: sh1) -> (Int, Int) Source #
(C sh0, C sh1) => C (sh0 :+: sh1) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: (sh0 :+: sh1) -> Int Source # uncheckedSize :: (sh0 :+: sh1) -> Int Source #
type Index (sh0 :+: sh1) Source #
Instance details Defined in Data.Array.Comfort.Shape type Index (sh0 :+: sh1) = Either (Index sh0) (Index sh1)