Portability	portable
Stability	experimental
Maintainer	amy@nualeargais.ie
Safe Haskell	Safe-Inferred

Math.Geometry.Grid.OctagonalInternal

Description

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

Synopsis

Documentation

data OctDirection Source

Constructors

West
Northwest
North
Northeast
East
Southeast
South
Southwest

Instances

Eq OctDirection
Show OctDirection

data UnboundedOctGrid Source

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

Constructors

UnboundedOctGrid

Instances

Show UnboundedOctGrid
Grid UnboundedOctGrid

data RectOctGrid Source

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

Constructors

RectOctGrid (Int, Int) [(Int, Int)]

Instances

Eq RectOctGrid
Show RectOctGrid
BoundedGrid RectOctGrid
FiniteGrid RectOctGrid
Grid RectOctGrid

rectOctGrid :: Int -> Int -> RectOctGrid Source

rectOctGrid r c produces a rectangular grid with r rows and c columns, using octagonal 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.

data TorOctGrid Source

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

Constructors

TorOctGrid (Int, Int) [(Int, Int)]

Instances

Eq TorOctGrid
Show TorOctGrid
WrappedGrid TorOctGrid
FiniteGrid TorOctGrid
Grid TorOctGrid

torOctGrid :: Int -> Int -> TorOctGrid Source

torOctGrid r c returns a toroidal grid with r rows and c columns, using octagonal 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.