SizedGrid.Coord.Class

Documentation

class (1 <= CoordSized c, KnownNat (CoordSized c)) => IsCoord c where

Everything that can be uses as a Coordinate. The only required function is asOrdinal and the type instance of CoordSized: the rest can be derived automatically.

This is kind * -> Constraint for ease of use later. There is some argument that it should be of kind (Nat -> *) -> Constraint and we could remove CoordSized, but that has other complications

Minimal complete definition

asOrdinal

Associated Types

type CoordSized c :: Nat

The maximum number of values that a Coord can take

Methods

asOrdinal :: Iso' c (Ordinal (CoordSized c))

As each coord represents a finite number of states, it must be isomorphic to an Ordinal

zeroPosition :: c

The origin. If c is an instance of Monoid, this should be mempty

zeroPosition :: Monoid c => c

The origin. If c is an instance of Monoid, this should be mempty

sCoordSized :: proxy c -> Proxy (CoordSized c)

Retrive a Proxy of the size

maxCoordSize :: proxy c -> Integer

The largest possible number expressable

Instances

((<=) 1 n, KnownNat n) => IsCoord (Ordinal n)

Associated Types

type CoordSized (Ordinal n) :: Nat

Methods

asOrdinal :: Iso' (Ordinal n) (Ordinal (CoordSized (Ordinal n)))

zeroPosition :: Ordinal n

sCoordSized :: proxy (Ordinal n) -> Proxy Nat (CoordSized (Ordinal n))

maxCoordSize :: proxy (Ordinal n) -> Integer

((<=) 1 n, KnownNat n) => IsCoord (Periodic n)

Associated Types

type CoordSized (Periodic n) :: Nat

Methods

asOrdinal :: Iso' (Periodic n) (Ordinal (CoordSized (Periodic n)))

zeroPosition :: Periodic n

sCoordSized :: proxy (Periodic n) -> Proxy Nat (CoordSized (Periodic n))

maxCoordSize :: proxy (Periodic n) -> Integer

((<=) 1 n, KnownNat n) => IsCoord (HardWrap n)

Associated Types

type CoordSized (HardWrap n) :: Nat

Methods

asOrdinal :: Iso' (HardWrap n) (Ordinal (CoordSized (HardWrap n)))

zeroPosition :: HardWrap n

sCoordSized :: proxy (HardWrap n) -> Proxy Nat (CoordSized (HardWrap n))

maxCoordSize :: proxy (HardWrap n) -> Integer

allCoordLike :: IsCoord c => [c]

Enumerate all possible values of a coord, in order