Game.Goatee.Sgf.Tree

SGF data structures modelling the hierarchical game tree.

Documentation

data Collection

An SGF collection of game trees.

Constructors

Collection

Fields

collectionTrees :: [Node]

Instances

Show Collection

newtype CollectionWithDeepEquality

See NodeWithDeepEquality.

Constructors

CollectionWithDeepEquality

Fields

collectionWithDeepEquality :: Collection

Instances

Eq CollectionWithDeepEquality

Show CollectionWithDeepEquality

data Node

An SGF game tree node. Unlike in the SGF spec, we represent a game tree with nodes uniformly, rather than having the separation between sequences and nodes.

Constructors

Node

Fields

nodeProperties :: [Property]

nodeChildren :: [Node]

Instances

Show Node

newtype NodeWithDeepEquality

A wrapper around Node with an Eq instance that considers two nodes equal iff they contain the same properties (not necessarily in the same order), and if they contain children (in the same order) whose nodes are recursively equal.

This instance is not on Node directly because it is not the only obvious sense of equality (only comparing properties would be another one), and it's also potentially expensive.

Constructors

NodeWithDeepEquality

Fields

nodeWithDeepEquality :: Node

Instances

Eq NodeWithDeepEquality

emptyNode :: Node

A node with no properties and no children.

rootNode :: Maybe (Int, Int) -> Node

Returns a fresh root Node with AP set to Goatee and optionally with a board size set via SZ.

findProperty :: Descriptor a => a -> Node -> Maybe Property

Searches for a matching property in a node's property list.

findProperty' :: Descriptor a => a -> [Property] -> Maybe Property

Searches for a matching property in a property list.

findPropertyValue :: ValuedDescriptor a v => a -> Node -> Maybe v

Retrieves the value of a property in a node's property list.

findPropertyValue' :: ValuedDescriptor a v => a -> [Property] -> Maybe v

Retrieves the value of a property in a property list.

addProperty :: Property -> Node -> Node

Appends a property to a node's property list.

addChild :: Node -> Node -> Node

addChild child parent appends a child node to a node's child list.

addChildAt :: Int -> Node -> Node -> Node

addChildAt index child parent inserts a child node into a node's child list at the given index, shifting all nodes at or after the given index to the right. The index must be in the range [0, numberOfChildren].

validateNode :: Bool -> Bool -> Node -> [String]

Returns a list of validation errors for the current node, an empty list if no errors are detected.