Data.Dense.Index

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.

Shape class

type Layout f = f Int

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

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

Minimal complete definition

Nothing

Methods

shapeToIndex :: Layout f -> f Int -> Int

Convert a shape to its linear index using the Layout.

shapeFromIndex :: Layout f -> Int -> f Int

Convert a linear index to a shape the Layout.

shapeIntersect :: Layout f -> Layout f -> Layout f

Calculate the intersection of two shapes.

unsafeShapeStep :: Layout f -> f Int -> f Int

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

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

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

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

Increment a shape by one between the two bounds

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

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

shapeSize :: Layout f -> Int

The number of elements in a shape.

Instances

Shape V0

Defined in Data.Dense.Index

Methods

shapeToIndex :: Layout V0 -> V0 Int -> Int

shapeFromIndex :: Layout V0 -> Int -> V0 Int

shapeIntersect :: Layout V0 -> Layout V0 -> Layout V0

unsafeShapeStep :: Layout V0 -> V0 Int -> V0 Int

shapeStep :: Layout V0 -> V0 Int -> Maybe (V0 Int)

shapeStepBetween :: V0 Int -> Layout V0 -> V0 Int -> Maybe (V0 Int)

shapeInRange :: Layout V0 -> V0 Int -> Bool

shapeSize :: Layout V0 -> Int

Shape V4

Defined in Data.Dense.Index

Methods

shapeToIndex :: Layout V4 -> V4 Int -> Int

shapeFromIndex :: Layout V4 -> Int -> V4 Int

shapeIntersect :: Layout V4 -> Layout V4 -> Layout V4

unsafeShapeStep :: Layout V4 -> V4 Int -> V4 Int

shapeStep :: Layout V4 -> V4 Int -> Maybe (V4 Int)

shapeStepBetween :: V4 Int -> Layout V4 -> V4 Int -> Maybe (V4 Int)

shapeInRange :: Layout V4 -> V4 Int -> Bool

shapeSize :: Layout V4 -> Int

Shape V3

Defined in Data.Dense.Index

Methods

shapeToIndex :: Layout V3 -> V3 Int -> Int

shapeFromIndex :: Layout V3 -> Int -> V3 Int

shapeIntersect :: Layout V3 -> Layout V3 -> Layout V3

unsafeShapeStep :: Layout V3 -> V3 Int -> V3 Int

shapeStep :: Layout V3 -> V3 Int -> Maybe (V3 Int)

shapeStepBetween :: V3 Int -> Layout V3 -> V3 Int -> Maybe (V3 Int)

shapeInRange :: Layout V3 -> V3 Int -> Bool

shapeSize :: Layout V3 -> Int

Shape V2

Defined in Data.Dense.Index

Methods

shapeToIndex :: Layout V2 -> V2 Int -> Int

shapeFromIndex :: Layout V2 -> Int -> V2 Int

shapeIntersect :: Layout V2 -> Layout V2 -> Layout V2

unsafeShapeStep :: Layout V2 -> V2 Int -> V2 Int

shapeStep :: Layout V2 -> V2 Int -> Maybe (V2 Int)

shapeStepBetween :: V2 Int -> Layout V2 -> V2 Int -> Maybe (V2 Int)

shapeInRange :: Layout V2 -> V2 Int -> Bool

shapeSize :: Layout V2 -> Int

Shape V1

Defined in Data.Dense.Index

Methods

shapeToIndex :: Layout V1 -> V1 Int -> Int

shapeFromIndex :: Layout V1 -> Int -> V1 Int

shapeIntersect :: Layout V1 -> Layout V1 -> Layout V1

unsafeShapeStep :: Layout V1 -> V1 Int -> V1 Int

shapeStep :: Layout V1 -> V1 Int -> Maybe (V1 Int)

shapeStepBetween :: V1 Int -> Layout V1 -> V1 Int -> Maybe (V1 Int)

shapeInRange :: Layout V1 -> V1 Int -> Bool

shapeSize :: Layout V1 -> Int

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

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

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

indexes for a Shape.

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

indexesFrom for a Shape.

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

indexesBetween for a Shape.

HasLayout

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

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

Minimal complete definition

Nothing

Methods

layout :: Lens' a (Layout f)

Lens onto the Layout of something.

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

Instances

i ~ Int => HasLayout V0 (V0 i)

Defined in Data.Dense.Index

Methods

layout :: Lens' (V0 i) (Layout V0)

i ~ Int => HasLayout V4 (V4 i)

Defined in Data.Dense.Index

Methods

layout :: Lens' (V4 i) (Layout V4)

i ~ Int => HasLayout V3 (V3 i)

Defined in Data.Dense.Index

Methods

layout :: Lens' (V3 i) (Layout V3)

i ~ Int => HasLayout V2 (V2 i)

Defined in Data.Dense.Index

Methods

layout :: Lens' (V2 i) (Layout V2)

i ~ Int => HasLayout V1 (V1 i)

Defined in Data.Dense.Index

Methods

layout :: Lens' (V1 i) (Layout V1)

Shape f => HasLayout f (Focused f a)

The size of the layout must remain the same or an error is thrown.

Defined in Data.Dense.Base

Methods

layout :: Lens' (Focused f a) (Layout f)

Shape f => HasLayout f (Delayed f a)

The size of the layout must remain the same or an error is thrown.

Defined in Data.Dense.Base

Methods

layout :: Lens' (Delayed f a) (Layout f)

Shape f => HasLayout f (Array v f a)

The size of the layout must remain the same or an error is thrown.

Defined in Data.Dense.Base

Methods

layout :: Lens' (Array v f a) (Layout f)

Shape f => HasLayout f (MArray v f s a)

Defined in Data.Dense.Mutable

Methods

layout :: Lens' (MArray v f s a) (Layout f)

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

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

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)

Indexed fold for all the indexes in the layout.

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

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)

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

Since: base-4.2.0.0

Defined in GHC.IO.Exception

Methods

(==) :: ArrayException -> ArrayException -> Bool

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

Ord ArrayException

Since: base-4.2.0.0

Defined in GHC.IO.Exception

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

Since: base-4.1.0.0

Defined in GHC.IO.Exception

Methods

showsPrec :: Int -> ArrayException -> ShowS

show :: ArrayException -> String

showList :: [ArrayException] -> ShowS

Exception ArrayException

Since: base-4.1.0.0

Defined in GHC.IO.Exception

Methods

toException :: ArrayException -> SomeException

fromException :: SomeException -> Maybe ArrayException

displayException :: ArrayException -> String

AsArrayException ArrayException

Defined in Control.Exception.Lens

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

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

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

Constructors

SizeMissmatch String

Instances

Show SizeMissmatch

Defined in Data.Dense.Index

Methods

showsPrec :: Int -> SizeMissmatch -> ShowS

show :: SizeMissmatch -> String

showList :: [SizeMissmatch] -> ShowS

Exception SizeMissmatch

Defined in Data.Dense.Index

Methods

toException :: SizeMissmatch -> SomeException

fromException :: SomeException -> Maybe SizeMissmatch

displayException :: SizeMissmatch -> String

AsSizeMissmatch SizeMissmatch

Defined in Data.Dense.Index

Methods

_SizeMissmatch :: Prism' SizeMissmatch String

class AsSizeMissmatch t where

Exception thown from missmatching sizes.

Methods

_SizeMissmatch :: Prism' t String

Extract information about an SizeMissmatch.

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

Instances

AsSizeMissmatch SomeException

Defined in Data.Dense.Index

Methods

_SizeMissmatch :: Prism' SomeException String

AsSizeMissmatch SizeMissmatch

Defined in Data.Dense.Index

Methods

_SizeMissmatch :: Prism' SizeMissmatch String

sizeMissmatch :: Int -> Int -> String -> a -> a

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

Utilities

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

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