Math.Geometry.Grid.HexagonalInternal

A module containing private HexGrid internals. Most developers should use HexGrid instead. This module is subject to change without notice.

Documentation

data HexDirection

Constructors

West

Northwest

Northeast

East

Southeast

Southwest

Instances

Eq HexDirection

Methods

(==) :: HexDirection -> HexDirection -> Bool

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

Show HexDirection

Methods

showsPrec :: Int -> HexDirection -> ShowS

show :: HexDirection -> String

showList :: [HexDirection] -> ShowS

Generic HexDirection

Associated Types

type Rep HexDirection :: * -> *

Methods

from :: HexDirection -> Rep HexDirection x

to :: Rep HexDirection x -> HexDirection

type Rep HexDirection

type Rep HexDirection = D1 (MetaData "HexDirection" "Math.Geometry.Grid.HexagonalInternal" "grid-7.8.7-CFKohrrI2j32P86iD3824A" False) ((:+:) ((:+:) (C1 (MetaCons "West" PrefixI False) U1) ((:+:) (C1 (MetaCons "Northwest" PrefixI False) U1) (C1 (MetaCons "Northeast" PrefixI False) U1))) ((:+:) (C1 (MetaCons "East" PrefixI False) U1) ((:+:) (C1 (MetaCons "Southeast" PrefixI False) U1) (C1 (MetaCons "Southwest" PrefixI False) U1))))

data UnboundedHexGrid

An unbounded grid with hexagonal tiles The grid and its indexing scheme are illustrated in the user guide, available at https://github.com/mhwombat/grid/wiki.

Constructors

UnboundedHexGrid

Instances

Eq UnboundedHexGrid

Methods

(==) :: UnboundedHexGrid -> UnboundedHexGrid -> Bool

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

Show UnboundedHexGrid

Methods

showsPrec :: Int -> UnboundedHexGrid -> ShowS

show :: UnboundedHexGrid -> String

showList :: [UnboundedHexGrid] -> ShowS

Generic UnboundedHexGrid

Associated Types

type Rep UnboundedHexGrid :: * -> *

Methods

from :: UnboundedHexGrid -> Rep UnboundedHexGrid x

to :: Rep UnboundedHexGrid x -> UnboundedHexGrid

Grid UnboundedHexGrid

Associated Types

type Index UnboundedHexGrid :: *

type Direction UnboundedHexGrid :: *

Methods

indices :: UnboundedHexGrid -> [Index UnboundedHexGrid]

distance :: UnboundedHexGrid -> Index UnboundedHexGrid -> Index UnboundedHexGrid -> Int

minDistance :: UnboundedHexGrid -> [Index UnboundedHexGrid] -> Index UnboundedHexGrid -> Int

neighbours :: UnboundedHexGrid -> Index UnboundedHexGrid -> [Index UnboundedHexGrid]

neighboursOfSet :: UnboundedHexGrid -> [Index UnboundedHexGrid] -> [Index UnboundedHexGrid]

neighbour :: UnboundedHexGrid -> Index UnboundedHexGrid -> Direction UnboundedHexGrid -> Maybe (Index UnboundedHexGrid)

numNeighbours :: UnboundedHexGrid -> Index UnboundedHexGrid -> Int

contains :: UnboundedHexGrid -> Index UnboundedHexGrid -> Bool

tileCount :: UnboundedHexGrid -> Int

null :: UnboundedHexGrid -> Bool

nonNull :: UnboundedHexGrid -> Bool

edges :: UnboundedHexGrid -> [(Index UnboundedHexGrid, Index UnboundedHexGrid)]

viewpoint :: UnboundedHexGrid -> Index UnboundedHexGrid -> [(Index UnboundedHexGrid, Int)]

isAdjacent :: UnboundedHexGrid -> Index UnboundedHexGrid -> Index UnboundedHexGrid -> Bool

adjacentTilesToward :: UnboundedHexGrid -> Index UnboundedHexGrid -> Index UnboundedHexGrid -> [Index UnboundedHexGrid]

minimalPaths :: UnboundedHexGrid -> Index UnboundedHexGrid -> Index UnboundedHexGrid -> [[Index UnboundedHexGrid]]

directionTo :: UnboundedHexGrid -> Index UnboundedHexGrid -> Index UnboundedHexGrid -> [Direction UnboundedHexGrid]

defaultMinDistance :: UnboundedHexGrid -> [Index UnboundedHexGrid] -> Index UnboundedHexGrid -> Int

defaultNeighbours :: UnboundedHexGrid -> Index UnboundedHexGrid -> [Index UnboundedHexGrid]

defaultNeighboursOfSet :: UnboundedHexGrid -> [Index UnboundedHexGrid] -> [Index UnboundedHexGrid]

defaultNeighbour :: UnboundedHexGrid -> Index UnboundedHexGrid -> Direction UnboundedHexGrid -> Maybe (Index UnboundedHexGrid)

defaultTileCount :: UnboundedHexGrid -> Int

defaultEdges :: UnboundedHexGrid -> [(Index UnboundedHexGrid, Index UnboundedHexGrid)]

defaultIsAdjacent :: UnboundedHexGrid -> Index UnboundedHexGrid -> Index UnboundedHexGrid -> Bool

defaultAdjacentTilesToward :: UnboundedHexGrid -> Index UnboundedHexGrid -> Index UnboundedHexGrid -> [Index UnboundedHexGrid]

defaultMinimalPaths :: UnboundedHexGrid -> Index UnboundedHexGrid -> Index UnboundedHexGrid -> [[Index UnboundedHexGrid]]

type Rep UnboundedHexGrid

type Rep UnboundedHexGrid = D1 (MetaData "UnboundedHexGrid" "Math.Geometry.Grid.HexagonalInternal" "grid-7.8.7-CFKohrrI2j32P86iD3824A" False) (C1 (MetaCons "UnboundedHexGrid" PrefixI False) U1)

type Index UnboundedHexGrid

type Index UnboundedHexGrid = (Int, Int)

type Direction UnboundedHexGrid

type Direction UnboundedHexGrid = HexDirection

data HexHexGrid

A hexagonal grid with hexagonal tiles The grid and its indexing scheme are illustrated in the user guide, available at https://github.com/mhwombat/grid/wiki.

Constructors

HexHexGrid Int [(Int, Int)]

Instances

Eq HexHexGrid

Methods

(==) :: HexHexGrid -> HexHexGrid -> Bool

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

Show HexHexGrid

Methods

showsPrec :: Int -> HexHexGrid -> ShowS

show :: HexHexGrid -> String

showList :: [HexHexGrid] -> ShowS

Generic HexHexGrid

Associated Types

type Rep HexHexGrid :: * -> *

Methods

from :: HexHexGrid -> Rep HexHexGrid x

to :: Rep HexHexGrid x -> HexHexGrid

BoundedGrid HexHexGrid

Methods

tileSideCount :: HexHexGrid -> Int

boundary :: HexHexGrid -> [Index HexHexGrid]

isBoundary :: HexHexGrid -> Index HexHexGrid -> Bool

centre :: HexHexGrid -> [Index HexHexGrid]

isCentre :: HexHexGrid -> Index HexHexGrid -> Bool

defaultBoundary :: HexHexGrid -> [Index HexHexGrid]

defaultIsBoundary :: HexHexGrid -> Index HexHexGrid -> Bool

defaultCentre :: HexHexGrid -> [Index HexHexGrid]

defaultIsCentre :: HexHexGrid -> Index HexHexGrid -> Bool

FiniteGrid HexHexGrid

Associated Types

type Size HexHexGrid :: *

Methods

size :: HexHexGrid -> Size HexHexGrid

maxPossibleDistance :: HexHexGrid -> Int

Grid HexHexGrid

Associated Types

type Index HexHexGrid :: *

type Direction HexHexGrid :: *

Methods

indices :: HexHexGrid -> [Index HexHexGrid]

distance :: HexHexGrid -> Index HexHexGrid -> Index HexHexGrid -> Int

minDistance :: HexHexGrid -> [Index HexHexGrid] -> Index HexHexGrid -> Int

neighbours :: HexHexGrid -> Index HexHexGrid -> [Index HexHexGrid]

neighboursOfSet :: HexHexGrid -> [Index HexHexGrid] -> [Index HexHexGrid]

neighbour :: HexHexGrid -> Index HexHexGrid -> Direction HexHexGrid -> Maybe (Index HexHexGrid)

numNeighbours :: HexHexGrid -> Index HexHexGrid -> Int

contains :: HexHexGrid -> Index HexHexGrid -> Bool

tileCount :: HexHexGrid -> Int

null :: HexHexGrid -> Bool

nonNull :: HexHexGrid -> Bool

edges :: HexHexGrid -> [(Index HexHexGrid, Index HexHexGrid)]

viewpoint :: HexHexGrid -> Index HexHexGrid -> [(Index HexHexGrid, Int)]

isAdjacent :: HexHexGrid -> Index HexHexGrid -> Index HexHexGrid -> Bool

adjacentTilesToward :: HexHexGrid -> Index HexHexGrid -> Index HexHexGrid -> [Index HexHexGrid]

minimalPaths :: HexHexGrid -> Index HexHexGrid -> Index HexHexGrid -> [[Index HexHexGrid]]

directionTo :: HexHexGrid -> Index HexHexGrid -> Index HexHexGrid -> [Direction HexHexGrid]

defaultMinDistance :: HexHexGrid -> [Index HexHexGrid] -> Index HexHexGrid -> Int

defaultNeighbours :: HexHexGrid -> Index HexHexGrid -> [Index HexHexGrid]

defaultNeighboursOfSet :: HexHexGrid -> [Index HexHexGrid] -> [Index HexHexGrid]

defaultNeighbour :: HexHexGrid -> Index HexHexGrid -> Direction HexHexGrid -> Maybe (Index HexHexGrid)

defaultTileCount :: HexHexGrid -> Int

defaultEdges :: HexHexGrid -> [(Index HexHexGrid, Index HexHexGrid)]

defaultIsAdjacent :: HexHexGrid -> Index HexHexGrid -> Index HexHexGrid -> Bool

defaultAdjacentTilesToward :: HexHexGrid -> Index HexHexGrid -> Index HexHexGrid -> [Index HexHexGrid]

defaultMinimalPaths :: HexHexGrid -> Index HexHexGrid -> Index HexHexGrid -> [[Index HexHexGrid]]

type Rep HexHexGrid

type Rep HexHexGrid = D1 (MetaData "HexHexGrid" "Math.Geometry.Grid.HexagonalInternal" "grid-7.8.7-CFKohrrI2j32P86iD3824A" False) (C1 (MetaCons "HexHexGrid" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Int, Int)]))))

type Size HexHexGrid

type Size HexHexGrid = Int

type Index HexHexGrid

type Index HexHexGrid = (Int, Int)

type Direction HexHexGrid

type Direction HexHexGrid = HexDirection

hexHexGrid :: Int -> HexHexGrid

hexHexGrid s returns a grid of hexagonal shape, with sides of length s, using hexagonal tiles. If s is nonnegative, the resulting grid will have 3*s*(s-1) + 1 tiles. Otherwise, the resulting grid will be null and the list of indices will be null.

data ParaHexGrid

A parallelogramatical grid with hexagonal tiles The grid and its indexing scheme are illustrated in the user guide, available at https://github.com/mhwombat/grid/wiki.

Constructors

ParaHexGrid (Int, Int) [(Int, Int)]

Instances

Eq ParaHexGrid

Methods

(==) :: ParaHexGrid -> ParaHexGrid -> Bool

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

Show ParaHexGrid

Methods

showsPrec :: Int -> ParaHexGrid -> ShowS

show :: ParaHexGrid -> String

showList :: [ParaHexGrid] -> ShowS

Generic ParaHexGrid

Associated Types

type Rep ParaHexGrid :: * -> *

Methods

from :: ParaHexGrid -> Rep ParaHexGrid x

to :: Rep ParaHexGrid x -> ParaHexGrid

BoundedGrid ParaHexGrid

Methods

tileSideCount :: ParaHexGrid -> Int

boundary :: ParaHexGrid -> [Index ParaHexGrid]

isBoundary :: ParaHexGrid -> Index ParaHexGrid -> Bool

centre :: ParaHexGrid -> [Index ParaHexGrid]

isCentre :: ParaHexGrid -> Index ParaHexGrid -> Bool

defaultBoundary :: ParaHexGrid -> [Index ParaHexGrid]

defaultIsBoundary :: ParaHexGrid -> Index ParaHexGrid -> Bool

defaultCentre :: ParaHexGrid -> [Index ParaHexGrid]

defaultIsCentre :: ParaHexGrid -> Index ParaHexGrid -> Bool

FiniteGrid ParaHexGrid

Associated Types

type Size ParaHexGrid :: *

Methods

size :: ParaHexGrid -> Size ParaHexGrid

maxPossibleDistance :: ParaHexGrid -> Int

Grid ParaHexGrid

Associated Types

type Index ParaHexGrid :: *

type Direction ParaHexGrid :: *

Methods

indices :: ParaHexGrid -> [Index ParaHexGrid]

distance :: ParaHexGrid -> Index ParaHexGrid -> Index ParaHexGrid -> Int

minDistance :: ParaHexGrid -> [Index ParaHexGrid] -> Index ParaHexGrid -> Int

neighbours :: ParaHexGrid -> Index ParaHexGrid -> [Index ParaHexGrid]

neighboursOfSet :: ParaHexGrid -> [Index ParaHexGrid] -> [Index ParaHexGrid]

neighbour :: ParaHexGrid -> Index ParaHexGrid -> Direction ParaHexGrid -> Maybe (Index ParaHexGrid)

numNeighbours :: ParaHexGrid -> Index ParaHexGrid -> Int

contains :: ParaHexGrid -> Index ParaHexGrid -> Bool

tileCount :: ParaHexGrid -> Int

null :: ParaHexGrid -> Bool

nonNull :: ParaHexGrid -> Bool

edges :: ParaHexGrid -> [(Index ParaHexGrid, Index ParaHexGrid)]

viewpoint :: ParaHexGrid -> Index ParaHexGrid -> [(Index ParaHexGrid, Int)]

isAdjacent :: ParaHexGrid -> Index ParaHexGrid -> Index ParaHexGrid -> Bool

adjacentTilesToward :: ParaHexGrid -> Index ParaHexGrid -> Index ParaHexGrid -> [Index ParaHexGrid]

minimalPaths :: ParaHexGrid -> Index ParaHexGrid -> Index ParaHexGrid -> [[Index ParaHexGrid]]

directionTo :: ParaHexGrid -> Index ParaHexGrid -> Index ParaHexGrid -> [Direction ParaHexGrid]

defaultMinDistance :: ParaHexGrid -> [Index ParaHexGrid] -> Index ParaHexGrid -> Int

defaultNeighbours :: ParaHexGrid -> Index ParaHexGrid -> [Index ParaHexGrid]

defaultNeighboursOfSet :: ParaHexGrid -> [Index ParaHexGrid] -> [Index ParaHexGrid]

defaultNeighbour :: ParaHexGrid -> Index ParaHexGrid -> Direction ParaHexGrid -> Maybe (Index ParaHexGrid)

defaultTileCount :: ParaHexGrid -> Int

defaultEdges :: ParaHexGrid -> [(Index ParaHexGrid, Index ParaHexGrid)]

defaultIsAdjacent :: ParaHexGrid -> Index ParaHexGrid -> Index ParaHexGrid -> Bool

defaultAdjacentTilesToward :: ParaHexGrid -> Index ParaHexGrid -> Index ParaHexGrid -> [Index ParaHexGrid]

defaultMinimalPaths :: ParaHexGrid -> Index ParaHexGrid -> Index ParaHexGrid -> [[Index ParaHexGrid]]

type Rep ParaHexGrid

type Rep ParaHexGrid = D1 (MetaData "ParaHexGrid" "Math.Geometry.Grid.HexagonalInternal" "grid-7.8.7-CFKohrrI2j32P86iD3824A" False) (C1 (MetaCons "ParaHexGrid" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Int, Int))) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Int, Int)]))))

type Size ParaHexGrid

type Size ParaHexGrid = (Int, Int)

type Index ParaHexGrid

type Index ParaHexGrid = (Int, Int)

type Direction ParaHexGrid

type Direction ParaHexGrid = HexDirection

paraHexGrid :: Int -> Int -> ParaHexGrid

paraHexGrid r c returns a grid in the shape of a parallelogram with r rows and c columns, using hexagonal tiles. If r and c are both nonnegative, the resulting grid will have r*c tiles. Otherwise, the resulting grid will be null and the list of indices will be null.