grid-6.1: Tools for working with regular grids (graphs, lattices).

Portability portable experimental amy@nualeargais.ie Safe-Inferred

Math.Geometry.Grid.SquareInternal

Description

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

Synopsis

# Documentation

Constructors

 North East South West

Instances

 Eq SquareDirection Show SquareDirection

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

Constructors

 UnboundedSquareGrid

Instances

 Show UnboundedSquareGrid Grid UnboundedSquareGrid

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

Constructors

 RectSquareGrid (Int, Int) [(Int, Int)]

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

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

Constructors

 TorSquareGrid (Int, Int) [(Int, Int)]

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