BishBosh.Notation.Notation

AUTHOR

Dr. Alistair Ward

DESCRIPTION

• The common basis for standard notations.
• CAVEAT: this module is only concerned with the representation of x & y coordinates, not any additional move-feature like enpassant, promotion or castling.

Types

Type-synonyms

type CoordinatePairI = (X, Y)

A numeric representation of some coordinates in the standard notation.

Data-types

data Notation

The parameters defining a generic chess-notation.

Functions

encode :: Notation -> Coordinates -> (ShowS, ShowS)

Encodes the ordinate & abscissa.

mkMaybeCoordinates :: Notation -> CoordinatePairC -> Maybe Coordinates

• Attempt to construct coordinates from the specified characters.
• A check that the specified characters are in the permissible bounds is performed before conversion incase the numeric type has a narrower range than Char.

showsCoordinates :: Notation -> Coordinates -> ShowS

Shows the specified coordinates.

readsCoordinates :: Notation -> ReadS Coordinates

Reads coordinates.

Constructors

mkNotation :: CoordinatePairC -> Notation

Smart constructor.

Predicates

inXRange :: Notation -> Char -> Bool

Whether the specified character falls within a standard notation's range.

inYRange :: Notation -> Char -> Bool

Whether the specified character falls within a standard notation's range.