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

Copyright (c) Amy de Buitléir 2012-2014 BSD-style amy@nualeargais.ie experimental portable Safe-Inferred Haskell98

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

 Eq UnboundedSquareGrid Show UnboundedSquareGrid Generic UnboundedSquareGrid Grid UnboundedSquareGrid type Rep UnboundedSquareGrid type Index UnboundedSquareGrid = (Int, Int) type Direction UnboundedSquareGrid = SquareDirection

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)]

Instances

 Eq RectSquareGrid Show RectSquareGrid Generic RectSquareGrid BoundedGrid RectSquareGrid FiniteGrid RectSquareGrid Grid RectSquareGrid type Rep RectSquareGrid type Size RectSquareGrid = (Int, Int) type Index RectSquareGrid = (Int, Int) type Direction RectSquareGrid = SquareDirection

`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)]

Instances

 Eq TorSquareGrid Show TorSquareGrid Generic TorSquareGrid WrappedGrid TorSquareGrid FiniteGrid TorSquareGrid Grid TorSquareGrid type Rep TorSquareGrid type Size TorSquareGrid = (Int, Int) type Index TorSquareGrid = (Int, Int) type Direction TorSquareGrid = SquareDirection

`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.