Test.Massiv.Core.Index

Documentation

newtype DimIx ix

Dimension that is always within bounds of an index

Constructors

DimIx Dim

Instances

Show (DimIx ix)

Defined in Test.Massiv.Core.Index

Methods

showsPrec :: Int -> DimIx ix -> ShowS

show :: DimIx ix -> String

showList :: [DimIx ix] -> ShowS

Index ix => Arbitrary (DimIx ix)

Defined in Test.Massiv.Core.Index

Methods

arbitrary :: Gen (DimIx ix)

shrink :: DimIx ix -> [DimIx ix]

newtype SzNE ix

Size that will result in a non-empty array.

prop > (neSz :: Sz1) -> totalElem (unSzNE neSz) > 0 prop > (neSz :: Sz2) -> totalElem (unSzNE neSz) > 0 prop > (neSz :: Sz3) -> totalElem (unSzNE neSz) > 0 prop > (neSz :: Sz4) -> totalElem (unSzNE neSz) > 0 prop > (neSz :: Sz5) -> totalElem (unSzNE neSz) > 0

Constructors

SzNE

Fields

• unSzNE :: Sz ix

Instances

Index ix => Show (SzNE ix)

Defined in Test.Massiv.Core.Index

Methods

showsPrec :: Int -> SzNE ix -> ShowS

show :: SzNE ix -> String

showList :: [SzNE ix] -> ShowS

(Index ix, Arbitrary ix) => Arbitrary (SzNE ix)

Defined in Test.Massiv.Core.Index

Methods

arbitrary :: Gen (SzNE ix)

shrink :: SzNE ix -> [SzNE ix]

data SzIx ix

Non-empty size together with an index that is within bounds of that index.

Constructors

SzIx (Sz ix) ix

Instances

Index ix => Show (SzIx ix)

Defined in Test.Massiv.Core.Index

Methods

showsPrec :: Int -> SzIx ix -> ShowS

show :: SzIx ix -> String

showList :: [SzIx ix] -> ShowS

(Index ix, Arbitrary ix) => Arbitrary (SzIx ix)

Defined in Test.Massiv.Core.Index

Methods

arbitrary :: Gen (SzIx ix)

shrink :: SzIx ix -> [SzIx ix]

newtype SzTiny ix

Constructors

SzTiny

Fields

• unSzTiny :: Sz ix

Instances

Eq ix => Eq (SzTiny ix)

Defined in Test.Massiv.Core.Index

Methods

(==) :: SzTiny ix -> SzTiny ix -> Bool

(/=) :: SzTiny ix -> SzTiny ix -> Bool

Index ix => Show (SzTiny ix)

Defined in Test.Massiv.Core.Index

Methods

showsPrec :: Int -> SzTiny ix -> ShowS

show :: SzTiny ix -> String

showList :: [SzTiny ix] -> ShowS

(Arbitrary ix, Index ix) => Arbitrary (SzTiny ix)

Defined in Test.Massiv.Core.Index

Methods

arbitrary :: Gen (SzTiny ix)

shrink :: SzTiny ix -> [SzTiny ix]

ixToList :: Index ix => ix -> [Int]

Convert an index to a list

Since: 0.1.0

arbitraryIx1 :: Gen Int

Generators are quadratic in QuickCheck. Unlike built-in Arbitrary instance for Int, this one generates smaller integers

Since: 0.1.0

toIx :: forall ix' ix. (Dimensions ix' ~ Dimensions ix, Index ix', Index ix) => ix -> ix'

A fairly slow way to convert from one arbitrary index to another of the same dimension

Since: 0.1.0

Specs

Index

specIx1 :: Spec

ixSpec :: forall ix. (Typeable (Lower ix), Arbitrary (Lower ix), Typeable ix, Index ix, Arbitrary ix, IsIndexDimension ix (Dimensions ix)) => Spec

ix2UpSpec :: forall ix. (Index ix, Index (Lower ix), Arbitrary ix, Arbitrary (Lower ix), Typeable (Lower ix)) => Spec

ixNumSpec :: forall ix. (Typeable ix, Num ix, Index ix, Arbitrary ix) => Spec

Spec that validates the Num instance for any `Index ix => ix`

Size

szNumSpec :: forall ix. (Typeable ix, Num ix, Index ix, Arbitrary ix) => Spec

Spec that validates the Num instance for any `Index ix => Sz ix`

szSpec :: forall ix. (Index ix, Arbitrary ix) => Spec

Re-exports

module Data.Massiv.Core.Index

Orphan instances

Function Ix2

Methods

function :: (Ix2 -> b) -> Ix2 :-> b

Function Ix3

Methods

function :: (Ix3 -> b) -> Ix3 :-> b

Function Ix4

Methods

function :: (Ix4 -> b) -> Ix4 :-> b

Function Ix5

Methods

function :: (Ix5 -> b) -> Ix5 :-> b

Arbitrary Ix2

Methods

arbitrary :: Gen Ix2

shrink :: Ix2 -> [Ix2]

Arbitrary Ix3

Methods

arbitrary :: Gen Ix3

shrink :: Ix3 -> [Ix3]

Arbitrary Ix4

Methods

arbitrary :: Gen Ix4

shrink :: Ix4 -> [Ix4]

Arbitrary Ix5

Methods

arbitrary :: Gen Ix5

shrink :: Ix5 -> [Ix5]

Arbitrary Dim

Methods

arbitrary :: Gen Dim

shrink :: Dim -> [Dim]

Arbitrary Ix0

Methods

arbitrary :: Gen Ix0

shrink :: Ix0 -> [Ix0]

CoArbitrary Ix2

Methods

coarbitrary :: Ix2 -> Gen b -> Gen b

CoArbitrary Ix3

Methods

coarbitrary :: Ix3 -> Gen b -> Gen b

CoArbitrary Ix4

Methods

coarbitrary :: Ix4 -> Gen b -> Gen b

CoArbitrary Ix5

Methods

coarbitrary :: Ix5 -> Gen b -> Gen b

Arbitrary e => Arbitrary (Border e)

Methods

arbitrary :: Gen (Border e)

shrink :: Border e -> [Border e]

(Index ix, Arbitrary ix) => Arbitrary (Stride ix)

Methods

arbitrary :: Gen (Stride ix)

shrink :: Stride ix -> [Stride ix]

(Index ix, Arbitrary ix) => Arbitrary (Sz ix)

Methods

arbitrary :: Gen (Sz ix)

shrink :: Sz ix -> [Sz ix]