Copyright	(c) Christopher Chalmers
License	BSD3
Maintainer	Christopher Chalmers
Stability	provisional
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Data.Dense.Index

Contents

Shape class
HasLayout
Exceptions
Utilities

Description

This module provides a class for types that can be converted to and from linear indexes.

The default instances are defined in row-major order.

Synopsis

Shape class

type Layout f = f Int Source #

A Layout is the full size of an array. This alias is used to help distinguish between the layout of an array and an index (usually just l Int) in a type signature.

class (Eq1 f, Additive f, Traversable f) => Shape f where Source #

Class for types that can be converted to and from linear indexes.

Methods

shapeToIndex :: Layout f -> f Int -> Int Source #

Convert a shape to its linear index using the Layout.

shapeFromIndex :: Layout f -> Int -> f Int Source #

Convert a linear index to a shape the Layout.

shapeIntersect :: Layout f -> Layout f -> Layout f Source #

Calculate the intersection of two shapes.

unsafeShapeStep :: Layout f -> f Int -> f Int Source #

Increment a shape by one. It is assumed that the provided index is inRange.

shapeStep :: Layout f -> f Int -> Maybe (f Int) Source #

Increment a shape by one. It is assumed that the provided index is inRange.

shapeStepBetween :: f Int -> Layout f -> f Int -> Maybe (f Int) Source #

Increment a shape by one between the two bounds

shapeInRange :: Layout f -> f Int -> Bool Source #

inRange ex i checks i < ex for every coordinate of f.

shapeSize :: Layout f -> Int Source #

The number of elements in a shape.

Instances

Shape V4 Source #
Methods shapeToIndex :: Layout V4 -> V4 Int -> Int Source # shapeFromIndex :: Layout V4 -> Int -> V4 Int Source # shapeIntersect :: Layout V4 -> Layout V4 -> Layout V4 Source # unsafeShapeStep :: Layout V4 -> V4 Int -> V4 Int Source # shapeStep :: Layout V4 -> V4 Int -> Maybe (V4 Int) Source # shapeStepBetween :: V4 Int -> Layout V4 -> V4 Int -> Maybe (V4 Int) Source # shapeInRange :: Layout V4 -> V4 Int -> Bool Source # shapeSize :: Layout V4 -> Int Source #
Shape V3 Source #
Methods shapeToIndex :: Layout V3 -> V3 Int -> Int Source # shapeFromIndex :: Layout V3 -> Int -> V3 Int Source # shapeIntersect :: Layout V3 -> Layout V3 -> Layout V3 Source # unsafeShapeStep :: Layout V3 -> V3 Int -> V3 Int Source # shapeStep :: Layout V3 -> V3 Int -> Maybe (V3 Int) Source # shapeStepBetween :: V3 Int -> Layout V3 -> V3 Int -> Maybe (V3 Int) Source # shapeInRange :: Layout V3 -> V3 Int -> Bool Source # shapeSize :: Layout V3 -> Int Source #
Shape V2 Source #
Methods shapeToIndex :: Layout V2 -> V2 Int -> Int Source # shapeFromIndex :: Layout V2 -> Int -> V2 Int Source # shapeIntersect :: Layout V2 -> Layout V2 -> Layout V2 Source # unsafeShapeStep :: Layout V2 -> V2 Int -> V2 Int Source # shapeStep :: Layout V2 -> V2 Int -> Maybe (V2 Int) Source # shapeStepBetween :: V2 Int -> Layout V2 -> V2 Int -> Maybe (V2 Int) Source # shapeInRange :: Layout V2 -> V2 Int -> Bool Source # shapeSize :: Layout V2 -> Int Source #
Shape V1 Source #
Methods shapeToIndex :: Layout V1 -> V1 Int -> Int Source # shapeFromIndex :: Layout V1 -> Int -> V1 Int Source # shapeIntersect :: Layout V1 -> Layout V1 -> Layout V1 Source # unsafeShapeStep :: Layout V1 -> V1 Int -> V1 Int Source # shapeStep :: Layout V1 -> V1 Int -> Maybe (V1 Int) Source # shapeStepBetween :: V1 Int -> Layout V1 -> V1 Int -> Maybe (V1 Int) Source # shapeInRange :: Layout V1 -> V1 Int -> Bool Source # shapeSize :: Layout V1 -> Int Source #
Shape V0 Source #
Methods shapeToIndex :: Layout V0 -> V0 Int -> Int Source # shapeFromIndex :: Layout V0 -> Int -> V0 Int Source # shapeIntersect :: Layout V0 -> Layout V0 -> Layout V0 Source # unsafeShapeStep :: Layout V0 -> V0 Int -> V0 Int Source # shapeStep :: Layout V0 -> V0 Int -> Maybe (V0 Int) Source # shapeStepBetween :: V0 Int -> Layout V0 -> V0 Int -> Maybe (V0 Int) Source # shapeInRange :: Layout V0 -> V0 Int -> Bool Source # shapeSize :: Layout V0 -> Int Source #

indexIso :: Shape f => Layout f -> Iso' (f Int) Int Source #

toIndex l and fromIndex l form two halfs of an isomorphism.

shapeIndexes :: Shape f => IndexedFold Int (Layout f) (f Int) Source #

indexes for a Shape.

shapeIndexesFrom :: Shape f => f Int -> IndexedFold Int (Layout f) (f Int) Source #

indexesFrom for a Shape.

shapeIndexesBetween :: Shape f => f Int -> f Int -> IndexedFold Int (Layout f) (f Int) Source #

indexesBetween for a Shape.

HasLayout

class Shape f => HasLayout f a | a -> f where Source #

Class of things that have a Layout. This means we can use the same functions for the various different arrays in the library.

Methods

layout :: Lens' a (Layout f) Source #

Lens onto the Layout of something.

layout :: a ~ f Int => (Layout f -> g (Layout f)) -> a -> g a Source #

Lens onto the Layout of something.

Instances

(~) * i Int => HasLayout V4 (V4 i) Source #
Methods layout :: Lens' (V4 i) (Layout V4) Source #
(~) * i Int => HasLayout V3 (V3 i) Source #
Methods layout :: Lens' (V3 i) (Layout V3) Source #
(~) * i Int => HasLayout V2 (V2 i) Source #
Methods layout :: Lens' (V2 i) (Layout V2) Source #
(~) * i Int => HasLayout V1 (V1 i) Source #
Methods layout :: Lens' (V1 i) (Layout V1) Source #
(~) * i Int => HasLayout V0 (V0 i) Source #
Methods layout :: Lens' (V0 i) (Layout V0) Source #
Shape f => HasLayout f (Focused f a) Source #	The `size` of the `layout` must remain the same or an error is thrown.
Methods layout :: Lens' (Focused f a) (Layout f) Source #
Shape f => HasLayout f (Delayed f a) Source #	The `size` of the `layout` must remain the same or an error is thrown.
Methods layout :: Lens' (Delayed f a) (Layout f) Source #
Shape f => HasLayout f (Array v f a) Source #	The `size` of the `layout` must remain the same or an error is thrown.
Methods layout :: Lens' (Array v f a) (Layout f) Source #
Shape f => HasLayout f (MArray v f s a) Source #
Methods layout :: Lens' (MArray v f s a) (Layout f) Source #

extent :: HasLayout f a => a -> f Int Source #

Get the extent of an array.

extent :: Array v f a    -> f Int
extent :: MArray v f s a -> f Int
extent :: Delayed f a    -> f Int
extent :: Focused f a    -> f Int

size :: HasLayout f a => a -> Int Source #

Get the total number of elements in an array.

size :: Array v f a    -> Int
size :: MArray v f s a -> Int
size :: Delayed f a    -> Int
size :: Focused f a    -> Int

indexes :: HasLayout f a => IndexedFold Int a (f Int) Source #

Indexed fold for all the indexes in the layout.

indexesBetween :: HasLayout f a => f Int -> f Int -> IndexedFold Int a (f Int) Source #

Indexed fold between the two indexes where the index is the linear index for the original layout.

indexesFrom :: HasLayout f a => f Int -> IndexedFold Int a (f Int) Source #

Indexed fold starting starting from some point, where the index is the linear index for the original layout.

Exceptions

data ArrayException :: * #

Exceptions generated by array operations

Constructors

IndexOutOfBounds String

An attempt was made to index an array outside its declared bounds.

Instances

Eq ArrayException
Methods (==) :: ArrayException -> ArrayException -> Bool # (/=) :: ArrayException -> ArrayException -> Bool #
Ord ArrayException
Methods compare :: ArrayException -> ArrayException -> Ordering # (<) :: ArrayException -> ArrayException -> Bool # (<=) :: ArrayException -> ArrayException -> Bool # (>) :: ArrayException -> ArrayException -> Bool # (>=) :: ArrayException -> ArrayException -> Bool # max :: ArrayException -> ArrayException -> ArrayException # min :: ArrayException -> ArrayException -> ArrayException #
Show ArrayException
Methods showsPrec :: Int -> ArrayException -> ShowS # show :: ArrayException -> String # showList :: [ArrayException] -> ShowS #
Exception ArrayException
Methods toException :: ArrayException -> SomeException # fromException :: SomeException -> Maybe ArrayException # displayException :: ArrayException -> String #
AsArrayException ArrayException
Methods _ArrayException :: Prism' ArrayException ArrayException #

_IndexOutOfBounds :: AsArrayException t => Prism' t String #

An attempt was made to index an array outside its declared bounds.

_IndexOutOfBounds ≡ _ArrayException . _IndexOutOfBounds

_IndexOutOfBounds :: Prism' ArrayException String
_IndexOutOfBounds :: Prism' SomeException  String

boundsCheck :: Shape l => Layout l -> l Int -> a -> a Source #

boundsCheck l i performs a bounds check for index i and layout l. Throws an IndexOutOfBounds exception when out of range in the form (i, l). This can be caught with the _IndexOutOfBounds prism.

>>> boundsCheck (V2 3 5) (V2 1 4) "in range"
"in range"

>>> boundsCheck (V2 10 20) (V2 10 5) "in bounds"
"*** Exception: array index out of range: (V2 10 5, V2 10 20)

>>> catching _IndexOutOfBounds (boundsCheck (V1 2) (V1 2) (putStrLn "in range")) print
"(V1 2, V1 2)"

The output format is suitable to be read using the _Show prism:

>>> trying (_IndexOutOfBounds . _Show) (boundsCheck (V1 2) (V1 20) (putStrLn "in range")) :: IO (Either (V1 Int, V1 Int) ())
Left (V1 20,V1 2)

data SizeMissmatch Source #

Thrown when two sizes that should match, don't.

Constructors

SizeMissmatch String

Instances

Show SizeMissmatch Source #
Methods showsPrec :: Int -> SizeMissmatch -> ShowS # show :: SizeMissmatch -> String # showList :: [SizeMissmatch] -> ShowS #
Exception SizeMissmatch Source #
Methods toException :: SizeMissmatch -> SomeException # fromException :: SomeException -> Maybe SizeMissmatch # displayException :: SizeMissmatch -> String #
AsSizeMissmatch SizeMissmatch Source #
Methods _SizeMissmatch :: Prism' SizeMissmatch String Source #

class AsSizeMissmatch t where Source #

Exception thown from missmatching sizes.

Methods

_SizeMissmatch :: Prism' t String Source #

Extract information about an SizeMissmatch.

_SizeMissmatch :: Prism' SizeMissmatch String
_SizeMissmatch :: Prism' SomeException String

Instances

AsSizeMissmatch SomeException Source #
Methods _SizeMissmatch :: Prism' SomeException String Source #
AsSizeMissmatch SizeMissmatch Source #
Methods _SizeMissmatch :: Prism' SizeMissmatch String Source #

sizeMissmatch :: Int -> Int -> String -> a -> a Source #

Check the sizes are equal. If not, throw SizeMissmatch.

Utilities

showShape :: Shape f => f Int -> String Source #

Show a shape in the form VN i1 i2 .. iN where N is the length of the shape.