Safe Haskell	None
Language	Haskell98

Data.Array.Comfort.Shape

Synopsis

class C sh where
- size :: sh -> Int
- uncheckedSize :: sh -> Int
class C sh => Indexed sh where
- type Index sh :: *
- indices :: sh -> [Index sh]
- offset :: sh -> Index sh -> Int
- uncheckedOffset :: sh -> Index sh -> Int
- inBounds :: sh -> Index sh -> Bool
- sizeOffset :: sh -> (Int, Index sh -> Int)
- uncheckedSizeOffset :: sh -> (Int, Index sh -> Int)
class Indexed sh => InvIndexed sh where
- indexFromOffset :: sh -> Int -> Index sh
- uncheckedIndexFromOffset :: sh -> Int -> Index sh
class (C sh, Eq sh) => Static sh where
- static :: sh
data Zero = Zero
newtype ZeroBased n = ZeroBased {
- zeroBasedSize :: n
}
zeroBasedSplit :: Real n => n -> ZeroBased n -> ZeroBased n :+: ZeroBased n
newtype OneBased n = OneBased {
- oneBasedSize :: n
}
data Range n = Range {
- rangeFrom, rangeTo :: n
}
data Shifted n = Shifted {
- shiftedOffset, shiftedSize :: n
}
data Enumeration n = Enumeration
newtype Deferred sh = Deferred sh
newtype DeferredIndex sh = DeferredIndex Int
deferIndex :: (Indexed sh, Index sh ~ ix) => sh -> ix -> DeferredIndex sh
revealIndex :: (InvIndexed sh, Index sh ~ ix) => sh -> DeferredIndex sh -> ix
data sh0 :+: sh1 = sh0 :+: sh1
data Triangular part size = Triangular {
- triangularPart :: part
- triangularSize :: size
}
data Lower = Lower
data Upper = Upper
type LowerTriangular = Triangular Lower
type UpperTriangular = Triangular Upper
lowerTriangular :: size -> LowerTriangular size
upperTriangular :: size -> UpperTriangular size
triangleSize :: Int -> Int
triangleRoot :: Floating a => a -> a

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 #
C Zero Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: Zero -> Int Source # uncheckedSize :: Zero -> Int Source #
Ord n => C (Set n) Source #	You can use an arbitrary `Set` of indices as shape. The array elements are ordered according to the index order in the `Set`.
Instance details Defined in Data.Array.Comfort.Shape Methods size :: Set n -> Int Source # uncheckedSize :: Set n -> Int Source #
C sh => C (Deferred sh) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: Deferred sh -> Int Source # uncheckedSize :: Deferred sh -> Int Source #
(Enum n, Bounded n) => C (Enumeration n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: Enumeration n -> Int Source # uncheckedSize :: Enumeration n -> 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 f => C (Shape f) Source #
Instance details Defined in Data.Array.Comfort.Container Methods size :: Shape f -> Int Source # uncheckedSize :: Shape f -> 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 #
(TriangularPart part, C size) => C (Triangular part size) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: Triangular part size -> Int Source # uncheckedSize :: Triangular part size -> 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 #
C sh => C (Tagged s sh) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: Tagged s sh -> Int Source # uncheckedSize :: Tagged s sh -> 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 -> (Int, Index sh -> Int) Source #

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

Instances

Indexed () Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index () :: Type Source # Methods indices :: () -> [Index ()] Source # offset :: () -> Index () -> Int Source # uncheckedOffset :: () -> Index () -> Int Source # inBounds :: () -> Index () -> Bool Source # sizeOffset :: () -> (Int, Index () -> Int) Source # uncheckedSizeOffset :: () -> (Int, Index () -> Int) Source #
Ord n => Indexed (Set n) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (Set n) :: Type Source # Methods indices :: Set n -> [Index (Set n)] Source # offset :: Set n -> Index (Set n) -> Int Source # uncheckedOffset :: Set n -> Index (Set n) -> Int Source # inBounds :: Set n -> Index (Set n) -> Bool Source # sizeOffset :: Set n -> (Int, Index (Set n) -> Int) Source # uncheckedSizeOffset :: Set n -> (Int, Index (Set n) -> Int) Source #
C sh => Indexed (Deferred sh) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (Deferred sh) :: Type Source # Methods indices :: Deferred sh -> [Index (Deferred sh)] Source # offset :: Deferred sh -> Index (Deferred sh) -> Int Source # uncheckedOffset :: Deferred sh -> Index (Deferred sh) -> Int Source # inBounds :: Deferred sh -> Index (Deferred sh) -> Bool Source # sizeOffset :: Deferred sh -> (Int, Index (Deferred sh) -> Int) Source # uncheckedSizeOffset :: Deferred sh -> (Int, Index (Deferred sh) -> Int) Source #
(Enum n, Bounded n) => Indexed (Enumeration n) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (Enumeration n) :: Type Source # Methods indices :: Enumeration n -> [Index (Enumeration n)] Source # offset :: Enumeration n -> Index (Enumeration n) -> Int Source # uncheckedOffset :: Enumeration n -> Index (Enumeration n) -> Int Source # inBounds :: Enumeration n -> Index (Enumeration n) -> Bool Source # sizeOffset :: Enumeration n -> (Int, Index (Enumeration n) -> Int) Source # uncheckedSizeOffset :: Enumeration n -> (Int, Index (Enumeration n) -> Int) Source #
Integral n => Indexed (Shifted n) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (Shifted n) :: Type 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 -> (Int, Index (Shifted n) -> Int) Source # uncheckedSizeOffset :: Shifted n -> (Int, Index (Shifted n) -> Int) Source #
Ix n => Indexed (Range n) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (Range n) :: Type 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 -> (Int, Index (Range n) -> Int) Source # uncheckedSizeOffset :: Range n -> (Int, Index (Range n) -> Int) Source #
Integral n => Indexed (OneBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (OneBased n) :: Type 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 -> (Int, Index (OneBased n) -> Int) Source # uncheckedSizeOffset :: OneBased n -> (Int, Index (OneBased n) -> Int) Source #
Integral n => Indexed (ZeroBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (ZeroBased n) :: Type 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 -> (Int, Index (ZeroBased n) -> Int) Source # uncheckedSizeOffset :: ZeroBased n -> (Int, Index (ZeroBased n) -> Int) Source #
(Indexed sh0, Indexed sh1) => Indexed (sh0, sh1) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (sh0, sh1) :: Type 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) -> (Int, Index (sh0, sh1) -> Int) Source # uncheckedSizeOffset :: (sh0, sh1) -> (Int, Index (sh0, sh1) -> Int) Source #
(Indexed sh0, Indexed sh1) => Indexed (sh0 :+: sh1) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (sh0 :+: sh1) :: Type 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) -> (Int, Index (sh0 :+: sh1) -> Int) Source # uncheckedSizeOffset :: (sh0 :+: sh1) -> (Int, Index (sh0 :+: sh1) -> Int) Source #
(TriangularPart part, Indexed size) => Indexed (Triangular part size) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (Triangular part size) :: Type Source # Methods indices :: Triangular part size -> [Index (Triangular part size)] Source # offset :: Triangular part size -> Index (Triangular part size) -> Int Source # uncheckedOffset :: Triangular part size -> Index (Triangular part size) -> Int Source # inBounds :: Triangular part size -> Index (Triangular part size) -> Bool Source # sizeOffset :: Triangular part size -> (Int, Index (Triangular part size) -> Int) Source # uncheckedSizeOffset :: Triangular part size -> (Int, Index (Triangular part size) -> 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) :: Type 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) -> (Int, Index (sh0, sh1, sh2) -> Int) Source # uncheckedSizeOffset :: (sh0, sh1, sh2) -> (Int, Index (sh0, sh1, sh2) -> Int) Source #
Indexed sh => Indexed (Tagged s sh) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (Tagged s sh) :: Type Source # Methods indices :: Tagged s sh -> [Index (Tagged s sh)] Source # offset :: Tagged s sh -> Index (Tagged s sh) -> Int Source # uncheckedOffset :: Tagged s sh -> Index (Tagged s sh) -> Int Source # inBounds :: Tagged s sh -> Index (Tagged s sh) -> Bool Source # sizeOffset :: Tagged s sh -> (Int, Index (Tagged s sh) -> Int) Source # uncheckedSizeOffset :: Tagged s sh -> (Int, Index (Tagged s sh) -> 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 #
Ord n => InvIndexed (Set n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: Set n -> Int -> Index (Set n) Source # uncheckedIndexFromOffset :: Set n -> Int -> Index (Set n) Source #
C sh => InvIndexed (Deferred sh) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: Deferred sh -> Int -> Index (Deferred sh) Source # uncheckedIndexFromOffset :: Deferred sh -> Int -> Index (Deferred sh) Source #
(Enum n, Bounded n) => InvIndexed (Enumeration n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: Enumeration n -> Int -> Index (Enumeration n) Source # uncheckedIndexFromOffset :: Enumeration n -> Int -> Index (Enumeration n) 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 #
(TriangularPart part, InvIndexed size) => InvIndexed (Triangular part size) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: Triangular part size -> Int -> Index (Triangular part size) Source # uncheckedIndexFromOffset :: Triangular part size -> Int -> Index (Triangular part size) 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 #
InvIndexed sh => InvIndexed (Tagged s sh) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: Tagged s sh -> Int -> Index (Tagged s sh) Source # uncheckedIndexFromOffset :: Tagged s sh -> Int -> Index (Tagged s sh) Source #

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

Methods

static :: sh Source #

Instances

Static () Source #
Instance details Defined in Data.Array.Comfort.Shape Methods static :: () Source #
Static Zero Source #
Instance details Defined in Data.Array.Comfort.Shape Methods static :: Zero Source #
Static sh => Static (Deferred sh) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods static :: Deferred sh Source #
(Enum n, Bounded n) => Static (Enumeration n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods static :: Enumeration n Source #
(Static sh0, Static sh1) => Static (sh0, sh1) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods static :: (sh0, sh1) Source #
(Static sh0, Static sh1) => Static (sh0 :+: sh1) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods static :: sh0 :+: sh1 Source #
(TriangularPart part, Static size) => Static (Triangular part size) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods static :: Triangular part size Source #
(Static sh0, Static sh1, Static sh2) => Static (sh0, sh1, sh2) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods static :: (sh0, sh1, sh2) Source #
Static sh => Static (Tagged s sh) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods static :: Tagged s sh Source #

data Zero Source #

Constructors

Zero

Instances

Eq Zero Source #
Instance details Defined in Data.Array.Comfort.Shape Methods (==) :: Zero -> Zero -> Bool # (/=) :: Zero -> Zero -> Bool #
Ord Zero Source #
Instance details 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 Source #
Instance details Defined in Data.Array.Comfort.Shape Methods showsPrec :: Int -> Zero -> ShowS # show :: Zero -> String # showList :: [Zero] -> ShowS #
Static Zero Source #
Instance details Defined in Data.Array.Comfort.Shape Methods static :: Zero Source #
C Zero Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: Zero -> Int Source # uncheckedSize :: Zero -> Int 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 #
Applicative ZeroBased Source #
Instance details 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) 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 () #
NFData n => NFData (ZeroBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods rnf :: ZeroBased n -> () #
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) :: Type 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 -> (Int, Index (ZeroBased n) -> Int) Source # uncheckedSizeOffset :: ZeroBased n -> (Int, Index (ZeroBased 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 #
type Index (ZeroBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape type Index (ZeroBased n) = n

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

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 #
Applicative OneBased Source #
Instance details 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) 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 () #
NFData n => NFData (OneBased n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods rnf :: OneBased n -> () #
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) :: Type 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 -> (Int, Index (OneBased n) -> Int) Source # uncheckedSizeOffset :: OneBased n -> (Int, Index (OneBased 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 #
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 () #
NFData n => NFData (Range n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods rnf :: Range n -> () #
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) :: Type 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 -> (Int, Index (Range n) -> Int) Source # uncheckedSizeOffset :: Range n -> (Int, Index (Range 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 #
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 () #
NFData n => NFData (Shifted n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods rnf :: Shifted n -> () #
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) :: Type 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 -> (Int, Index (Shifted n) -> Int) Source # uncheckedSizeOffset :: Shifted n -> (Int, Index (Shifted n) -> 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 Enumeration n Source #

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.

Constructors

Enumeration

Instances

Eq (Enumeration n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods (==) :: Enumeration n -> Enumeration n -> Bool # (/=) :: Enumeration n -> Enumeration n -> Bool #
Show (Enumeration n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods showsPrec :: Int -> Enumeration n -> ShowS # show :: Enumeration n -> String # showList :: [Enumeration n] -> ShowS #
Storable (Enumeration n) Source #
Instance details 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) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods rnf :: Enumeration n -> () #
(Enum n, Bounded n) => Static (Enumeration n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods static :: Enumeration n Source #
(Enum n, Bounded n) => InvIndexed (Enumeration n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: Enumeration n -> Int -> Index (Enumeration n) Source # uncheckedIndexFromOffset :: Enumeration n -> Int -> Index (Enumeration n) Source #
(Enum n, Bounded n) => Indexed (Enumeration n) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (Enumeration n) :: Type Source # Methods indices :: Enumeration n -> [Index (Enumeration n)] Source # offset :: Enumeration n -> Index (Enumeration n) -> Int Source # uncheckedOffset :: Enumeration n -> Index (Enumeration n) -> Int Source # inBounds :: Enumeration n -> Index (Enumeration n) -> Bool Source # sizeOffset :: Enumeration n -> (Int, Index (Enumeration n) -> Int) Source # uncheckedSizeOffset :: Enumeration n -> (Int, Index (Enumeration n) -> Int) Source #
(Enum n, Bounded n) => C (Enumeration n) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: Enumeration n -> Int Source # uncheckedSize :: Enumeration n -> Int Source #
type Index (Enumeration n) Source #
Instance details Defined in Data.Array.Comfort.Shape type Index (Enumeration n) = n

newtype Deferred sh Source #

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:

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

Constructors

Deferred sh

Instances

Eq sh => Eq (Deferred sh) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods (==) :: Deferred sh -> Deferred sh -> Bool # (/=) :: Deferred sh -> Deferred sh -> Bool #
Show sh => Show (Deferred sh) Source #
Instance details 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) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods rnf :: Deferred sh -> () #
Static sh => Static (Deferred sh) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods static :: Deferred sh Source #
C sh => InvIndexed (Deferred sh) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: Deferred sh -> Int -> Index (Deferred sh) Source # uncheckedIndexFromOffset :: Deferred sh -> Int -> Index (Deferred sh) Source #
C sh => Indexed (Deferred sh) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (Deferred sh) :: Type Source # Methods indices :: Deferred sh -> [Index (Deferred sh)] Source # offset :: Deferred sh -> Index (Deferred sh) -> Int Source # uncheckedOffset :: Deferred sh -> Index (Deferred sh) -> Int Source # inBounds :: Deferred sh -> Index (Deferred sh) -> Bool Source # sizeOffset :: Deferred sh -> (Int, Index (Deferred sh) -> Int) Source # uncheckedSizeOffset :: Deferred sh -> (Int, Index (Deferred sh) -> Int) Source #
C sh => C (Deferred sh) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: Deferred sh -> Int Source # uncheckedSize :: Deferred sh -> Int Source #
type Index (Deferred sh) Source #
Instance details Defined in Data.Array.Comfort.Shape type Index (Deferred sh) = DeferredIndex sh

newtype DeferredIndex sh Source #

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) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods (==) :: DeferredIndex sh -> DeferredIndex sh -> Bool # (/=) :: DeferredIndex sh -> DeferredIndex sh -> Bool #
Ord (DeferredIndex sh) Source #
Instance details 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) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods showsPrec :: Int -> DeferredIndex sh -> ShowS # show :: DeferredIndex sh -> String # showList :: [DeferredIndex sh] -> ShowS #
Storable (DeferredIndex sh) Source #
Instance details 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 Source #

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

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 #
(NFData sh0, NFData sh1) => NFData (sh0 :+: sh1) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods rnf :: (sh0 :+: sh1) -> () #
(Static sh0, Static sh1) => Static (sh0 :+: sh1) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods static :: 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 #
(Indexed sh0, Indexed sh1) => Indexed (sh0 :+: sh1) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (sh0 :+: sh1) :: Type 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) -> (Int, Index (sh0 :+: sh1) -> Int) Source # uncheckedSizeOffset :: (sh0 :+: sh1) -> (Int, Index (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 #
type Index (sh0 :+: sh1) Source #
Instance details Defined in Data.Array.Comfort.Shape type Index (sh0 :+: sh1) = Either (Index sh0) (Index sh1)

data Triangular part size Source #

Constructors

Triangular
Fields triangularPart :: part triangularSize :: size

Instances

(TriangularPart part, Eq size) => Eq (Triangular part size) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods rnf :: Triangular part size -> () #
(TriangularPart part, Static size) => Static (Triangular part size) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods static :: Triangular part size Source #
(TriangularPart part, InvIndexed size) => InvIndexed (Triangular part size) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods indexFromOffset :: Triangular part size -> Int -> Index (Triangular part size) Source # uncheckedIndexFromOffset :: Triangular part size -> Int -> Index (Triangular part size) Source #
(TriangularPart part, Indexed size) => Indexed (Triangular part size) Source #
Instance details Defined in Data.Array.Comfort.Shape Associated Types type Index (Triangular part size) :: Type Source # Methods indices :: Triangular part size -> [Index (Triangular part size)] Source # offset :: Triangular part size -> Index (Triangular part size) -> Int Source # uncheckedOffset :: Triangular part size -> Index (Triangular part size) -> Int Source # inBounds :: Triangular part size -> Index (Triangular part size) -> Bool Source # sizeOffset :: Triangular part size -> (Int, Index (Triangular part size) -> Int) Source # uncheckedSizeOffset :: Triangular part size -> (Int, Index (Triangular part size) -> Int) Source #
(TriangularPart part, C size) => C (Triangular part size) Source #
Instance details Defined in Data.Array.Comfort.Shape Methods size :: Triangular part size -> Int Source # uncheckedSize :: Triangular part size -> Int Source #
type Index (Triangular part size) Source #
Instance details Defined in Data.Array.Comfort.Shape type Index (Triangular part size) = (Index size, Index size)

data Lower Source #

Constructors

Lower

Instances

Eq Lower Source #
Instance details Defined in Data.Array.Comfort.Shape Methods (==) :: Lower -> Lower -> Bool # (/=) :: Lower -> Lower -> Bool #
Show Lower Source #
Instance details Defined in Data.Array.Comfort.Shape Methods showsPrec :: Int -> Lower -> ShowS # show :: Lower -> String # showList :: [Lower] -> ShowS #

data Upper Source #

Constructors

Upper

Instances

Eq Upper Source #
Instance details Defined in Data.Array.Comfort.Shape Methods (==) :: Upper -> Upper -> Bool # (/=) :: Upper -> Upper -> Bool #
Show Upper Source #
Instance details Defined in Data.Array.Comfort.Shape Methods showsPrec :: Int -> Upper -> ShowS # show :: Upper -> String # showList :: [Upper] -> ShowS #

type LowerTriangular = Triangular Lower Source #

type UpperTriangular = Triangular Upper Source #

lowerTriangular :: size -> LowerTriangular size Source #

upperTriangular :: size -> UpperTriangular size Source #

triangleSize :: Int -> Int Source #

triangleRoot :: Floating a => a -> a Source #