Data.Array.Comfort.Shape.Static

Documentation

>>> import qualified Data.Array.Comfort.Shape.Static as Static
>>> import qualified Data.Array.Comfort.Shape as Shape
>>> 
>>> import qualified Type.Data.Num.Unary.Literal as TypeNum
>>> import qualified Type.Data.Num.Unary as Unary

newtype ZeroBased n

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

>>> Shape.indices (Static.ZeroBased (Unary.unary TypeNum.u0))
[]
>>> Shape.indices (Static.ZeroBased (Unary.unary TypeNum.u1))
[i0]
>>> Shape.indices (Static.ZeroBased (Unary.unary TypeNum.u7))
[i0,i1,i2,i3,i4,i5,i6]

Constructors

ZeroBased

Fields

• zeroBasedSize :: Proxy (Un n)

Instances

Eq (ZeroBased n)

Defined in Data.Array.Comfort.Shape.Static

Methods

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

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

Natural n => Show (ZeroBased n)

Defined in Data.Array.Comfort.Shape.Static

Methods

showsPrec :: Int -> ZeroBased n -> ShowS

show :: ZeroBased n -> String

showList :: [ZeroBased n] -> ShowS

Natural n => C (ZeroBased n)

Defined in Data.Array.Comfort.Shape.Static

Methods

size :: ZeroBased n -> Int

Natural n => Indexed (ZeroBased n)

Defined in Data.Array.Comfort.Shape.Static

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)

Natural n => InvIndexed (ZeroBased n)

Defined in Data.Array.Comfort.Shape.Static

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

Natural n => Static (ZeroBased n)

Defined in Data.Array.Comfort.Shape.Static

Methods

static :: ZeroBased n

type Index (ZeroBased n)

Defined in Data.Array.Comfort.Shape.Static

type Index (ZeroBased n) = Index n

vector :: (Natural n, Storable a) => T n a -> Array (ZeroBased n) a