Vision.Primitive.Shape

Shapes are similar to what you could found in repa. Shape are used both for indexes and shapes.

To create a shape/index, use the ix1, ix2, ix3 ... helpers :

size = ix2 200 100

To pull values from a shape, use the Z and :. constructors :

Z :. h :. w = size

Documentation

class Eq sh => Shape sh where

Class of types that can be used as array shapes and indices.

Methods

shapeRank :: sh -> Int

Gets the number of dimensions in a shape.

shapeLength :: sh -> Int

Gets the total number of elements in an array of this shape.

shapeZero :: sh

Gives the first index of an array.

shapeSucc

Arguments

:: sh

Shape of the array.

-> sh

Index.

-> sh

Gives the successor of an index, given the shape of the array.

toLinearIndex

Arguments

:: sh

Shape of the array.

-> sh

Index into the array.

-> Int

Convert an index into its equivalent flat, linear, row-major version.

fromLinearIndex

Arguments

:: sh

Shape of the array.

-> Int

Index into linear representation.

-> sh

Inverse of toLinearIndex.

shapeList :: sh -> [sh]

Return the ascending list of indexes for the given shape.

inShape

Arguments

:: sh

Shape of the array.

-> sh

Index to check for.

-> Bool

Check whether an index is within a given shape.

Instances

Shape Z

Defined in Vision.Primitive.Shape

Methods

shapeRank :: Z -> Int

shapeLength :: Z -> Int

shapeZero :: Z

shapeSucc :: Z -> Z -> Z

toLinearIndex :: Z -> Z -> Int

fromLinearIndex :: Z -> Int -> Z

shapeList :: Z -> [Z]

inShape :: Z -> Z -> Bool

Shape sh => Shape (sh :. Int)

Defined in Vision.Primitive.Shape

Methods

shapeRank :: (sh :. Int) -> Int

shapeLength :: (sh :. Int) -> Int

shapeZero :: sh :. Int

shapeSucc :: (sh :. Int) -> (sh :. Int) -> sh :. Int

toLinearIndex :: (sh :. Int) -> (sh :. Int) -> Int

fromLinearIndex :: (sh :. Int) -> Int -> sh :. Int

shapeList :: (sh :. Int) -> [sh :. Int]

inShape :: (sh :. Int) -> (sh :. Int) -> Bool

data Z

An index of dimension zero.

Constructors

Z

Instances

Storable Z

Defined in Vision.Primitive.Shape

Methods

sizeOf :: Z -> Int

alignment :: Z -> Int

peekElemOff :: Ptr Z -> Int -> IO Z

pokeElemOff :: Ptr Z -> Int -> Z -> IO ()

peekByteOff :: Ptr b -> Int -> IO Z

pokeByteOff :: Ptr b -> Int -> Z -> IO ()

peek :: Ptr Z -> IO Z

poke :: Ptr Z -> Z -> IO ()

Read Z

Defined in Vision.Primitive.Shape

Methods

readsPrec :: Int -> ReadS Z

readList :: ReadS [Z]

readPrec :: ReadPrec Z

readListPrec :: ReadPrec [Z]

Show Z

Defined in Vision.Primitive.Shape

Methods

showsPrec :: Int -> Z -> ShowS

show :: Z -> String

showList :: [Z] -> ShowS

HistogramShape Z

Defined in Vision.Histogram

Methods

toBin :: Z -> Z -> Z -> Z

Shape Z

Defined in Vision.Primitive.Shape

Methods

shapeRank :: Z -> Int

shapeLength :: Z -> Int

shapeZero :: Z

shapeSucc :: Z -> Z -> Z

toLinearIndex :: Z -> Z -> Int

fromLinearIndex :: Z -> Int -> Z

shapeList :: Z -> [Z]

inShape :: Z -> Z -> Bool

Eq Z

Defined in Vision.Primitive.Shape

Methods

(==) :: Z -> Z -> Bool

(/=) :: Z -> Z -> Bool

Ord Z

Defined in Vision.Primitive.Shape

Methods

compare :: Z -> Z -> Ordering

(<) :: Z -> Z -> Bool

(<=) :: Z -> Z -> Bool

(>) :: Z -> Z -> Bool

(>=) :: Z -> Z -> Bool

max :: Z -> Z -> Z

min :: Z -> Z -> Z

Unbox Z

Defined in Vision.Primitive.Shape

Vector Vector Z

Defined in Vision.Primitive.Shape

Methods

basicUnsafeFreeze :: Mutable Vector s Z -> ST s (Vector Z)

basicUnsafeThaw :: Vector Z -> ST s (Mutable Vector s Z)

basicLength :: Vector Z -> Int

basicUnsafeSlice :: Int -> Int -> Vector Z -> Vector Z

basicUnsafeIndexM :: Vector Z -> Int -> Box Z

basicUnsafeCopy :: Mutable Vector s Z -> Vector Z -> ST s ()

elemseq :: Vector Z -> Z -> b -> b

MVector MVector Z

Defined in Vision.Primitive.Shape

Methods

basicLength :: MVector s Z -> Int

basicUnsafeSlice :: Int -> Int -> MVector s Z -> MVector s Z

basicOverlaps :: MVector s Z -> MVector s Z -> Bool

basicUnsafeNew :: Int -> ST s (MVector s Z)

basicInitialize :: MVector s Z -> ST s ()

basicUnsafeReplicate :: Int -> Z -> ST s (MVector s Z)

basicUnsafeRead :: MVector s Z -> Int -> ST s Z

basicUnsafeWrite :: MVector s Z -> Int -> Z -> ST s ()

basicClear :: MVector s Z -> ST s ()

basicSet :: MVector s Z -> Z -> ST s ()

basicUnsafeCopy :: MVector s Z -> MVector s Z -> ST s ()

basicUnsafeMove :: MVector s Z -> MVector s Z -> ST s ()

basicUnsafeGrow :: MVector s Z -> Int -> ST s (MVector s Z)

newtype Vector Z

Defined in Vision.Primitive.Shape

newtype Vector Z = V_Z (Vector ())

newtype MVector s Z

Defined in Vision.Primitive.Shape

newtype MVector s Z = MV_Z (MVector s ())

data tail :. head infixl 3

Our index type, used for both shapes and indices.

Constructors

!tail :. !head infixl 3

Instances

(Unbox t, Unbox h) => Vector Vector (t :. h)

Defined in Vision.Primitive.Shape

Methods

basicUnsafeFreeze :: Mutable Vector s (t :. h) -> ST s (Vector (t :. h))

basicUnsafeThaw :: Vector (t :. h) -> ST s (Mutable Vector s (t :. h))

basicLength :: Vector (t :. h) -> Int

basicUnsafeSlice :: Int -> Int -> Vector (t :. h) -> Vector (t :. h)

basicUnsafeIndexM :: Vector (t :. h) -> Int -> Box (t :. h)

basicUnsafeCopy :: Mutable Vector s (t :. h) -> Vector (t :. h) -> ST s ()

elemseq :: Vector (t :. h) -> (t :. h) -> b -> b

(Unbox t, Unbox h) => MVector MVector (t :. h)

Defined in Vision.Primitive.Shape

Methods

basicLength :: MVector s (t :. h) -> Int

basicUnsafeSlice :: Int -> Int -> MVector s (t :. h) -> MVector s (t :. h)

basicOverlaps :: MVector s (t :. h) -> MVector s (t :. h) -> Bool

basicUnsafeNew :: Int -> ST s (MVector s (t :. h))

basicInitialize :: MVector s (t :. h) -> ST s ()

basicUnsafeReplicate :: Int -> (t :. h) -> ST s (MVector s (t :. h))

basicUnsafeRead :: MVector s (t :. h) -> Int -> ST s (t :. h)

basicUnsafeWrite :: MVector s (t :. h) -> Int -> (t :. h) -> ST s ()

basicClear :: MVector s (t :. h) -> ST s ()

basicSet :: MVector s (t :. h) -> (t :. h) -> ST s ()

basicUnsafeCopy :: MVector s (t :. h) -> MVector s (t :. h) -> ST s ()

basicUnsafeMove :: MVector s (t :. h) -> MVector s (t :. h) -> ST s ()

basicUnsafeGrow :: MVector s (t :. h) -> Int -> ST s (MVector s (t :. h))

Storable sh => Storable (sh :. Int)

Defined in Vision.Primitive.Shape

Methods

sizeOf :: (sh :. Int) -> Int

alignment :: (sh :. Int) -> Int

peekElemOff :: Ptr (sh :. Int) -> Int -> IO (sh :. Int)

pokeElemOff :: Ptr (sh :. Int) -> Int -> (sh :. Int) -> IO ()

peekByteOff :: Ptr b -> Int -> IO (sh :. Int)

pokeByteOff :: Ptr b -> Int -> (sh :. Int) -> IO ()

peek :: Ptr (sh :. Int) -> IO (sh :. Int)

poke :: Ptr (sh :. Int) -> (sh :. Int) -> IO ()

(Read tail, Read head) => Read (tail :. head)

Defined in Vision.Primitive.Shape

Methods

readsPrec :: Int -> ReadS (tail :. head)

readList :: ReadS [tail :. head]

readPrec :: ReadPrec (tail :. head)

readListPrec :: ReadPrec [tail :. head]

(Show tail, Show head) => Show (tail :. head)

Defined in Vision.Primitive.Shape

Methods

showsPrec :: Int -> (tail :. head) -> ShowS

show :: (tail :. head) -> String

showList :: [tail :. head] -> ShowS

HistogramShape sh => HistogramShape (sh :. Int)

Defined in Vision.Histogram

Methods

toBin :: (sh :. Int) -> (sh :. Int) -> (sh :. Int) -> sh :. Int

Shape sh => Shape (sh :. Int)

Defined in Vision.Primitive.Shape

Methods

shapeRank :: (sh :. Int) -> Int

shapeLength :: (sh :. Int) -> Int

shapeZero :: sh :. Int

shapeSucc :: (sh :. Int) -> (sh :. Int) -> sh :. Int

toLinearIndex :: (sh :. Int) -> (sh :. Int) -> Int

fromLinearIndex :: (sh :. Int) -> Int -> sh :. Int

shapeList :: (sh :. Int) -> [sh :. Int]

inShape :: (sh :. Int) -> (sh :. Int) -> Bool

(Eq tail, Eq head) => Eq (tail :. head)

Defined in Vision.Primitive.Shape

Methods

(==) :: (tail :. head) -> (tail :. head) -> Bool

(/=) :: (tail :. head) -> (tail :. head) -> Bool

(Ord tail, Ord head) => Ord (tail :. head)

Defined in Vision.Primitive.Shape

Methods

compare :: (tail :. head) -> (tail :. head) -> Ordering

(<) :: (tail :. head) -> (tail :. head) -> Bool

(<=) :: (tail :. head) -> (tail :. head) -> Bool

(>) :: (tail :. head) -> (tail :. head) -> Bool

(>=) :: (tail :. head) -> (tail :. head) -> Bool

max :: (tail :. head) -> (tail :. head) -> tail :. head

min :: (tail :. head) -> (tail :. head) -> tail :. head

(Unbox t, Unbox h) => Unbox (t :. h)

Defined in Vision.Primitive.Shape

newtype MVector s (t :. h)

Defined in Vision.Primitive.Shape

newtype MVector s (t :. h) = MV_Dim (MVector s (t, h))

newtype Vector (t :. h)

Defined in Vision.Primitive.Shape

newtype Vector (t :. h) = V_Dim (Vector (t, h))

Common dimensions.

type DIM0 = Z

type DIM1 = DIM0 :. Int

type DIM2 = DIM1 :. Int

type DIM3 = DIM2 :. Int

type DIM4 = DIM3 :. Int

type DIM5 = DIM4 :. Int

type DIM6 = DIM5 :. Int

type DIM7 = DIM6 :. Int

type DIM8 = DIM7 :. Int

type DIM9 = DIM8 :. Int

Helpers

ix1 :: Int -> DIM1

Helper for index construction.

Use this instead of explicit constructors like (Z :. (x :: Int)) The this is sometimes needed to ensure that x is constrained to be in Int.

ix2 :: Int -> Int -> DIM2

ix3 :: Int -> Int -> Int -> DIM3

ix4 :: Int -> Int -> Int -> Int -> DIM4

ix5 :: Int -> Int -> Int -> Int -> Int -> DIM5

ix6 :: Int -> Int -> Int -> Int -> Int -> Int -> DIM6

ix7 :: Int -> Int -> Int -> Int -> Int -> Int -> Int -> DIM7

ix8 :: Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> DIM8

ix9 :: Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> DIM9