Copyright	(c) Amy de Buitléir 2012-2017
License	BSD-style
Maintainer	amy@nualeargais.ie
Stability	experimental
Portability	portable
Safe Haskell	Safe
Language	Haskell2010

Math.Geometry.Grid.Square

Contents

Unbounded grid with square tiles
Rectangular grid with square tiles
Toroidal grid with square tiles

Description

A regular arrangement of square tiles. The userguide, with illustrations, is available at https://github.com/mhwombat/grid/wiki. Also see Math.Geometry.Grid for examples of how to use this class.

Synopsis

data UnboundedSquareGrid = UnboundedSquareGrid
data RectSquareGrid
rectSquareGrid :: Int -> Int -> RectSquareGrid
data TorSquareGrid
torSquareGrid :: Int -> Int -> TorSquareGrid

Unbounded grid with square tiles

data UnboundedSquareGrid Source #

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 Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal Methods (==) :: UnboundedSquareGrid -> UnboundedSquareGrid -> Bool # (/=) :: UnboundedSquareGrid -> UnboundedSquareGrid -> Bool #
Show UnboundedSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal Methods showsPrec :: Int -> UnboundedSquareGrid -> ShowS # show :: UnboundedSquareGrid -> String # showList :: [UnboundedSquareGrid] -> ShowS #
Generic UnboundedSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal Associated Types type Rep UnboundedSquareGrid :: Type -> Type # Methods from :: UnboundedSquareGrid -> Rep UnboundedSquareGrid x # to :: Rep UnboundedSquareGrid x -> UnboundedSquareGrid #
Grid UnboundedSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal Associated Types type Index UnboundedSquareGrid :: Type Source # type Direction UnboundedSquareGrid :: Type Source # Methods indices :: UnboundedSquareGrid -> [Index UnboundedSquareGrid] Source # distance :: UnboundedSquareGrid -> Index UnboundedSquareGrid -> Index UnboundedSquareGrid -> Int Source # minDistance :: UnboundedSquareGrid -> [Index UnboundedSquareGrid] -> Index UnboundedSquareGrid -> Int Source # neighbours :: UnboundedSquareGrid -> Index UnboundedSquareGrid -> [Index UnboundedSquareGrid] Source # neighboursOfSet :: UnboundedSquareGrid -> [Index UnboundedSquareGrid] -> [Index UnboundedSquareGrid] Source # neighbour :: UnboundedSquareGrid -> Index UnboundedSquareGrid -> Direction UnboundedSquareGrid -> Maybe (Index UnboundedSquareGrid) Source # numNeighbours :: UnboundedSquareGrid -> Index UnboundedSquareGrid -> Int Source # contains :: UnboundedSquareGrid -> Index UnboundedSquareGrid -> Bool Source # tileCount :: UnboundedSquareGrid -> Int Source # null :: UnboundedSquareGrid -> Bool Source # nonNull :: UnboundedSquareGrid -> Bool Source # edges :: UnboundedSquareGrid -> [(Index UnboundedSquareGrid, Index UnboundedSquareGrid)] Source # viewpoint :: UnboundedSquareGrid -> Index UnboundedSquareGrid -> [(Index UnboundedSquareGrid, Int)] Source # isAdjacent :: UnboundedSquareGrid -> Index UnboundedSquareGrid -> Index UnboundedSquareGrid -> Bool Source # adjacentTilesToward :: UnboundedSquareGrid -> Index UnboundedSquareGrid -> Index UnboundedSquareGrid -> [Index UnboundedSquareGrid] Source # minimalPaths :: UnboundedSquareGrid -> Index UnboundedSquareGrid -> Index UnboundedSquareGrid -> [[Index UnboundedSquareGrid]] Source # directionTo :: UnboundedSquareGrid -> Index UnboundedSquareGrid -> Index UnboundedSquareGrid -> [Direction UnboundedSquareGrid] Source # defaultMinDistance :: UnboundedSquareGrid -> [Index UnboundedSquareGrid] -> Index UnboundedSquareGrid -> Int Source # defaultNeighbours :: UnboundedSquareGrid -> Index UnboundedSquareGrid -> [Index UnboundedSquareGrid] Source # defaultNeighboursOfSet :: UnboundedSquareGrid -> [Index UnboundedSquareGrid] -> [Index UnboundedSquareGrid] Source # defaultNeighbour :: UnboundedSquareGrid -> Index UnboundedSquareGrid -> Direction UnboundedSquareGrid -> Maybe (Index UnboundedSquareGrid) Source # defaultTileCount :: UnboundedSquareGrid -> Int Source # defaultEdges :: UnboundedSquareGrid -> [(Index UnboundedSquareGrid, Index UnboundedSquareGrid)] Source # defaultIsAdjacent :: UnboundedSquareGrid -> Index UnboundedSquareGrid -> Index UnboundedSquareGrid -> Bool Source # defaultAdjacentTilesToward :: UnboundedSquareGrid -> Index UnboundedSquareGrid -> Index UnboundedSquareGrid -> [Index UnboundedSquareGrid] Source # defaultMinimalPaths :: UnboundedSquareGrid -> Index UnboundedSquareGrid -> Index UnboundedSquareGrid -> [[Index UnboundedSquareGrid]] Source #
type Rep UnboundedSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal type Rep UnboundedSquareGrid = D1 (MetaData "UnboundedSquareGrid" "Math.Geometry.Grid.SquareInternal" "grid-7.8.11-FsZ2zB5sbxUIH1WQmshk4x" False) (C1 (MetaCons "UnboundedSquareGrid" PrefixI False) (U1 :: Type -> Type))
type Index UnboundedSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal type Index UnboundedSquareGrid = (Int, Int)
type Direction UnboundedSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal type Direction UnboundedSquareGrid = SquareDirection

Rectangular grid with square tiles

data RectSquareGrid Source #

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.

Instances

Eq RectSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal Methods (==) :: RectSquareGrid -> RectSquareGrid -> Bool # (/=) :: RectSquareGrid -> RectSquareGrid -> Bool #
Show RectSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal Methods showsPrec :: Int -> RectSquareGrid -> ShowS # show :: RectSquareGrid -> String # showList :: [RectSquareGrid] -> ShowS #
Generic RectSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal Associated Types type Rep RectSquareGrid :: Type -> Type # Methods from :: RectSquareGrid -> Rep RectSquareGrid x # to :: Rep RectSquareGrid x -> RectSquareGrid #
BoundedGrid RectSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal Methods tileSideCount :: RectSquareGrid -> Int Source # boundary :: RectSquareGrid -> [Index RectSquareGrid] Source # isBoundary :: RectSquareGrid -> Index RectSquareGrid -> Bool Source # centre :: RectSquareGrid -> [Index RectSquareGrid] Source # isCentre :: RectSquareGrid -> Index RectSquareGrid -> Bool Source # defaultBoundary :: RectSquareGrid -> [Index RectSquareGrid] Source # defaultIsBoundary :: RectSquareGrid -> Index RectSquareGrid -> Bool Source # defaultCentre :: RectSquareGrid -> [Index RectSquareGrid] Source # defaultIsCentre :: RectSquareGrid -> Index RectSquareGrid -> Bool Source #
FiniteGrid RectSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal Associated Types type Size RectSquareGrid :: Type Source # Methods size :: RectSquareGrid -> Size RectSquareGrid Source # maxPossibleDistance :: RectSquareGrid -> Int Source #
Grid RectSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal Associated Types type Index RectSquareGrid :: Type Source # type Direction RectSquareGrid :: Type Source # Methods indices :: RectSquareGrid -> [Index RectSquareGrid] Source # distance :: RectSquareGrid -> Index RectSquareGrid -> Index RectSquareGrid -> Int Source # minDistance :: RectSquareGrid -> [Index RectSquareGrid] -> Index RectSquareGrid -> Int Source # neighbours :: RectSquareGrid -> Index RectSquareGrid -> [Index RectSquareGrid] Source # neighboursOfSet :: RectSquareGrid -> [Index RectSquareGrid] -> [Index RectSquareGrid] Source # neighbour :: RectSquareGrid -> Index RectSquareGrid -> Direction RectSquareGrid -> Maybe (Index RectSquareGrid) Source # numNeighbours :: RectSquareGrid -> Index RectSquareGrid -> Int Source # contains :: RectSquareGrid -> Index RectSquareGrid -> Bool Source # tileCount :: RectSquareGrid -> Int Source # null :: RectSquareGrid -> Bool Source # nonNull :: RectSquareGrid -> Bool Source # edges :: RectSquareGrid -> [(Index RectSquareGrid, Index RectSquareGrid)] Source # viewpoint :: RectSquareGrid -> Index RectSquareGrid -> [(Index RectSquareGrid, Int)] Source # isAdjacent :: RectSquareGrid -> Index RectSquareGrid -> Index RectSquareGrid -> Bool Source # adjacentTilesToward :: RectSquareGrid -> Index RectSquareGrid -> Index RectSquareGrid -> [Index RectSquareGrid] Source # minimalPaths :: RectSquareGrid -> Index RectSquareGrid -> Index RectSquareGrid -> [[Index RectSquareGrid]] Source # directionTo :: RectSquareGrid -> Index RectSquareGrid -> Index RectSquareGrid -> [Direction RectSquareGrid] Source # defaultMinDistance :: RectSquareGrid -> [Index RectSquareGrid] -> Index RectSquareGrid -> Int Source # defaultNeighbours :: RectSquareGrid -> Index RectSquareGrid -> [Index RectSquareGrid] Source # defaultNeighboursOfSet :: RectSquareGrid -> [Index RectSquareGrid] -> [Index RectSquareGrid] Source # defaultNeighbour :: RectSquareGrid -> Index RectSquareGrid -> Direction RectSquareGrid -> Maybe (Index RectSquareGrid) Source # defaultTileCount :: RectSquareGrid -> Int Source # defaultEdges :: RectSquareGrid -> [(Index RectSquareGrid, Index RectSquareGrid)] Source # defaultIsAdjacent :: RectSquareGrid -> Index RectSquareGrid -> Index RectSquareGrid -> Bool Source # defaultAdjacentTilesToward :: RectSquareGrid -> Index RectSquareGrid -> Index RectSquareGrid -> [Index RectSquareGrid] Source # defaultMinimalPaths :: RectSquareGrid -> Index RectSquareGrid -> Index RectSquareGrid -> [[Index RectSquareGrid]] Source #
type Rep RectSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal type Rep RectSquareGrid = D1 (MetaData "RectSquareGrid" "Math.Geometry.Grid.SquareInternal" "grid-7.8.11-FsZ2zB5sbxUIH1WQmshk4x" False) (C1 (MetaCons "RectSquareGrid" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Int, Int)) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Int, Int)])))
type Size RectSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal type Size RectSquareGrid = (Int, Int)
type Index RectSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal type Index RectSquareGrid = (Int, Int)
type Direction RectSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal type Direction RectSquareGrid = SquareDirection

rectSquareGrid :: Int -> Int -> RectSquareGrid Source #

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.

Toroidal grid with square tiles

data TorSquareGrid Source #

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.

Instances

Eq TorSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal Methods (==) :: TorSquareGrid -> TorSquareGrid -> Bool # (/=) :: TorSquareGrid -> TorSquareGrid -> Bool #
Show TorSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal Methods showsPrec :: Int -> TorSquareGrid -> ShowS # show :: TorSquareGrid -> String # showList :: [TorSquareGrid] -> ShowS #
Generic TorSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal Associated Types type Rep TorSquareGrid :: Type -> Type # Methods from :: TorSquareGrid -> Rep TorSquareGrid x # to :: Rep TorSquareGrid x -> TorSquareGrid #
WrappedGrid TorSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal Methods normalise :: TorSquareGrid -> Index TorSquareGrid -> Index TorSquareGrid Source # denormalise :: TorSquareGrid -> Index TorSquareGrid -> [Index TorSquareGrid] Source #
FiniteGrid TorSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal Associated Types type Size TorSquareGrid :: Type Source # Methods size :: TorSquareGrid -> Size TorSquareGrid Source # maxPossibleDistance :: TorSquareGrid -> Int Source #
Grid TorSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal Associated Types type Index TorSquareGrid :: Type Source # type Direction TorSquareGrid :: Type Source # Methods indices :: TorSquareGrid -> [Index TorSquareGrid] Source # distance :: TorSquareGrid -> Index TorSquareGrid -> Index TorSquareGrid -> Int Source # minDistance :: TorSquareGrid -> [Index TorSquareGrid] -> Index TorSquareGrid -> Int Source # neighbours :: TorSquareGrid -> Index TorSquareGrid -> [Index TorSquareGrid] Source # neighboursOfSet :: TorSquareGrid -> [Index TorSquareGrid] -> [Index TorSquareGrid] Source # neighbour :: TorSquareGrid -> Index TorSquareGrid -> Direction TorSquareGrid -> Maybe (Index TorSquareGrid) Source # numNeighbours :: TorSquareGrid -> Index TorSquareGrid -> Int Source # contains :: TorSquareGrid -> Index TorSquareGrid -> Bool Source # tileCount :: TorSquareGrid -> Int Source # null :: TorSquareGrid -> Bool Source # nonNull :: TorSquareGrid -> Bool Source # edges :: TorSquareGrid -> [(Index TorSquareGrid, Index TorSquareGrid)] Source # viewpoint :: TorSquareGrid -> Index TorSquareGrid -> [(Index TorSquareGrid, Int)] Source # isAdjacent :: TorSquareGrid -> Index TorSquareGrid -> Index TorSquareGrid -> Bool Source # adjacentTilesToward :: TorSquareGrid -> Index TorSquareGrid -> Index TorSquareGrid -> [Index TorSquareGrid] Source # minimalPaths :: TorSquareGrid -> Index TorSquareGrid -> Index TorSquareGrid -> [[Index TorSquareGrid]] Source # directionTo :: TorSquareGrid -> Index TorSquareGrid -> Index TorSquareGrid -> [Direction TorSquareGrid] Source # defaultMinDistance :: TorSquareGrid -> [Index TorSquareGrid] -> Index TorSquareGrid -> Int Source # defaultNeighbours :: TorSquareGrid -> Index TorSquareGrid -> [Index TorSquareGrid] Source # defaultNeighboursOfSet :: TorSquareGrid -> [Index TorSquareGrid] -> [Index TorSquareGrid] Source # defaultNeighbour :: TorSquareGrid -> Index TorSquareGrid -> Direction TorSquareGrid -> Maybe (Index TorSquareGrid) Source # defaultTileCount :: TorSquareGrid -> Int Source # defaultEdges :: TorSquareGrid -> [(Index TorSquareGrid, Index TorSquareGrid)] Source # defaultIsAdjacent :: TorSquareGrid -> Index TorSquareGrid -> Index TorSquareGrid -> Bool Source # defaultAdjacentTilesToward :: TorSquareGrid -> Index TorSquareGrid -> Index TorSquareGrid -> [Index TorSquareGrid] Source # defaultMinimalPaths :: TorSquareGrid -> Index TorSquareGrid -> Index TorSquareGrid -> [[Index TorSquareGrid]] Source #
type Rep TorSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal type Rep TorSquareGrid = D1 (MetaData "TorSquareGrid" "Math.Geometry.Grid.SquareInternal" "grid-7.8.11-FsZ2zB5sbxUIH1WQmshk4x" False) (C1 (MetaCons "TorSquareGrid" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Int, Int)) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Int, Int)])))
type Size TorSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal type Size TorSquareGrid = (Int, Int)
type Index TorSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal type Index TorSquareGrid = (Int, Int)
type Direction TorSquareGrid Source #
Instance details Defined in Math.Geometry.Grid.SquareInternal type Direction TorSquareGrid = SquareDirection

torSquareGrid :: Int -> Int -> TorSquareGrid Source #

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.