Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/sabakihq/go-board

A Go board data type.
https://github.com/sabakihq/go-board
baduk board-game datatype go strategy weiqi
Last synced: 3 months ago
JSON representation
A Go board data type.
Host: GitHub
URL: https://github.com/sabakihq/go-board
Owner: SabakiHQ
License: mit
Created: 2019-08-06T11:11:56.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2021-09-19T15:06:26.000Z (over 3 years ago)
Last Synced: 2024-11-08T15:51:05.777Z (3 months ago)
Topics: baduk, board-game, datatype, go, strategy, weiqi
Language: JavaScript
Homepage:
Size: 97.7 KB
Stars: 21
Watchers: 3
Forks: 12
Open Issues: 1
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project

README

        # @sabaki/go-board [![Build Status](https://travis-ci.org/SabakiHQ/go-board.svg?branch=master)](https://travis-ci.org/SabakiHQ/go-board)

A Go board data type.

## Installation

Use npm to install:

~~~

$ npm install @sabaki/go-board

~~~

## Usage

~~~js

const Board = require('@sabaki/go-board')

let board = new Board([

    [ 0, 0, 0,-1,-1,-1, 1, 0, 1, 1,-1,-1, 0,-1, 0,-1,-1, 1, 0],

    [ 0, 0,-1, 0,-1, 1, 1, 1, 0, 1,-1, 0,-1,-1,-1,-1, 1, 1, 0],

    [ 0, 0,-1,-1,-1, 1, 1, 0, 0, 1, 1,-1,-1, 1,-1, 1, 0, 1, 0],

    [ 0, 0, 0, 0,-1,-1, 1, 0, 1,-1, 1, 1, 1, 1, 1, 0, 1, 0, 0],

    [ 0, 0, 0, 0,-1, 0,-1, 1, 0, 0, 1, 1, 0, 0, 0, 1, 1, 1, 0],

    [ 0, 0,-1, 0, 0,-1,-1, 1, 0,-1,-1, 1,-1,-1, 0, 1, 0, 0, 1],

    [ 0, 0, 0,-1,-1, 1, 1, 1, 1, 1, 1, 1, 1,-1,-1,-1, 1, 1, 1],

    [ 0, 0,-1, 1, 1, 0, 1,-1,-1, 1, 0, 1,-1, 0, 1,-1,-1,-1, 1],

    [ 0, 0,-1,-1, 1, 1, 1, 0,-1, 1,-1,-1, 0,-1,-1, 1, 1, 1, 1],

    [ 0, 0,-1, 1, 1,-1,-1,-1,-1, 1, 1, 1,-1,-1,-1,-1, 1,-1,-1],

    [-1,-1,-1,-1, 1, 1, 1,-1, 0,-1, 1,-1,-1, 0,-1, 1, 1,-1, 0],

    [-1, 1,-1, 0,-1,-1,-1,-1,-1,-1, 1,-1, 0,-1,-1, 1,-1, 0,-1],

    [ 1, 1, 1, 1,-1, 1, 1, 1,-1, 1, 0, 1,-1, 0,-1, 1,-1,-1, 0],

    [ 0, 1,-1, 1, 1,-1,-1, 1,-1, 1, 1, 1,-1, 1,-1, 1, 1,-1, 1],

    [ 0, 0,-1, 1, 0, 0, 1, 1,-1,-1, 0, 1,-1, 1,-1, 1,-1, 0,-1],

    [ 0, 0, 1, 0, 1, 0, 1, 1, 1,-1,-1, 1,-1,-1, 1,-1,-1,-1, 0],

    [ 0, 0, 0, 0, 1, 1, 0, 1,-1, 0,-1,-1, 1, 1, 1, 1,-1,-1,-1],

    [ 0, 0, 1, 1,-1, 1, 1,-1, 0,-1,-1, 1, 1, 1, 1, 0, 1,-1, 1],

    [ 0, 0, 0, 1,-1,-1,-1,-1,-1, 0,-1,-1, 1, 1, 0, 1, 1, 1, 0]

])

let move = board.makeMove(1, [9, 4])

~~~

## API

### Sign Map

The board arrangement is represented by an array of arrays. Each of those subarrays represent one row, all containing the same number of integers. `-1` denotes a white stone, `1` a black stone, and `0` represents an empty vertex.

#### Example

~~~js

[[ 0, 0, 1, 0,-1,-1, 1, 0, 0],

 [ 1, 0, 1,-1,-1, 1, 1, 1, 0],

 [ 0, 0, 1,-1, 0, 1,-1,-1, 0],

 [ 1, 1, 1,-1,-1,-1, 1,-1, 0],

 [ 1,-1, 1, 1,-1, 1, 1, 1, 0],

 [-1,-1,-1,-1,-1, 1, 0, 0, 0],

 [ 0,-1,-1, 0,-1, 1, 1, 1, 1],

 [ 0, 0, 0, 0, 0,-1,-1,-1, 1],

 [ 0, 0, 0, 0, 0, 0, 0,-1, 0]]

~~~

### Vertex

Board positions are represented by a vertex, i.e. an array of the form `[x, y]` where `x` and `y` are non-negative integers, zero-based coordinates. `[0, 0]` denotes the upper left position of the board.

---

### `class Board`

#### Constructors

##### `new Board([signMap])`

- `signMap` [``](#sign-map) *(optional)* - Default: `[]`

##### `Board.fromDimensions(width[, height])`

- `width` ``

- `height` `` *(optional)* - Default: `width`

Returns a new `Board` instance with a [sign map](#sign-map) of the given dimensions that is filled with `0`.

#### Properties

##### `board.signMap`

[``](#sign-map) - The underlying sign map of the board.

##### `board.width`

`` - The board width.

##### `board.height`

`` - The board height.

#### Stone Arrangement Functions

##### `board.get(vertex)`

- `vertex` [``](#vertex)

Returns the sign at the given `vertex`.

##### `board.set(vertex, sign)`

- `vertex` [``](#vertex)

- `sign` `` - One of `-1`, `0`, or `1`

Sets the sign at the given `vertex`. No validity checks will be made. This function mutates the board and returns `this` to enable chaining.

##### `board.has(vertex)`

- `vertex` [``](#vertex)

Returns a boolean whether the given `vertex` is valid or can be found on the board.

##### `board.clear()`

Sets the sign of all vertices to `0`. This function mutates the board and returns `this` to enable chaining.

##### `board.makeMove(sign, vertex[, options])`

- `sign` `` - One of `-1`, `0`, or `1`

- `vertex` [``](#vertex)

- `options` `` *(optional)*

    - `preventOverwrite` `` - Default: `false`

    - `preventSuicide` `` - Default: `false`

    - `preventKo` `` - Default: `false`

Returns a new board instance that represents the board state after the player who corresponds to the given `sign` makes a move at `vertex`. The capture count will also be updated correctly. If `board` is [valid](#boardisvalid) then the new returned board instance will also be valid. This function will not mutate `board`. If `sign` is `0` or `vertex` not valid, this function will be equivalent to [`clone()`](#boardclone).

If `preventOverwrite` is set to `true`, this function will throw an error if the attempted move is on a vertex that is already occupied by a stone.

If `preventSuicide` is set to `true`, this function will throw an error if the attempted move is a suicide.

If `preventKo` is set to `true`, this function will throw an error if the attempted move repeats the position that led to `board`.

##### `board.analyzeMove(sign, vertex)`

- `sign` `` - One of `-1`, `0`, or `1`

- `vertex` [``](#vertex)

Analyzes the hypothetical move that the player who corresponds to the given `sign` would make at `vertex`. Returns an object with the following keys with boolean values:

- `pass` - Specifies if the move would be a pass (`sign` is `0` or `vertex` is not valid)

- `overwrite` - Specifies if the move would overwrite an occupied stone on the board

- `capturing` - Specifies if the move would capture some enemy stone

- `suicide` - Specifies if the move would end up in a suicide

- `ko` - Specifies if the move would repeat the position that led to `board`

#### Capture Count Functions

##### `board.getCaptures(sign)`

- `sign` `` - One of `-1` or `1`

Returns the number of stones that the player, who corresponds to the given `sign`, captured.

##### `board.setCaptures(sign, mutator)`

- `sign` `` - One of `-1` or `1`

- `mutator` ``

If `mutator` is a function of the following form

~~~js

(prevCaptures: ) -> 

~~~

we will update the capture count of the player who corresponds to the given `sign` according to the `mutator` function. If `mutator` is an integer, we will directly set the capture count to `mutator` instead. This function mutates the board and returns `this` to enable chaining.

#### Board Property Functions

##### `board.isSquare()`

Equivalent to `board.width === board.height`.

##### `board.isEmpty()`

Returns `true` if [`signMap`](#boardsignmap) contains `0` only, otherwise `false`.

##### `board.isValid()`

Returns `true` if all [chains](#boardgetchainvertex) have at least one liberty, otherwise `false`.

#### Topology Functions

##### `board.getDistance(vertex1, vertex2)`

- `vertex1` [``](#vertex)

- `vertex2` [``](#vertex)

Returns the [Manhattan distance](https://en.wikipedia.org/wiki/Taxicab_geometry) between the given vertices.

##### `board.getNeighbors(vertex)`

- `vertex` [``](#vertex)

Returns an array of [vertices](#vertex) on the board that are exactly [Manhattan distance](https://en.wikipedia.org/wiki/Taxicab_geometry) `1` away from the given `vertex`.

##### `board.getConnectedComponent(vertex, predicate)`

- `vertex` [``](#vertex)

- `predicate` ``

`predicate` is a function of the following form:

~~~js

(vertex: ) -> 

~~~

Returns a list of [vertices](#vertex) that fulfill `predicate` and connect to `vertex` through a string of vertices that all fulfill `predicate`.

##### `board.getChain(vertex)`

- `vertex` [``](#vertex)

Equivalent to `board.getConnectedComponent(vertex, v => board.get(v) === board.get(vertex))`.

##### `board.getRelatedChains(vertex)`

- `vertex` [``](#vertex)

Returns an array of [vertices](#vertex) of the same sign as `vertex` that belong to the same enemy area as `vertex`.

##### `board.getLiberties(vertex)`

- `vertex` [``](#vertex)

Returns an array of [vertices](#vertex) that represents the liberties of the chain that `vertex` belongs to.

##### `board.hasLiberties(vertex)`

- `vertex` [``](#vertex)

Equivalent to `board.getLiberties(vertex).length > 0`, but faster.

#### Helper Functions

##### `board.clone()`

Returns a new `Board` instance that is equivalent to `board`, but mutations to either of them will not affect one another.

##### `board.diff(otherBoard)`

- `board` [``](#class-board)

Returns an array of [vertices](#vertex) whose signs are not identical in `board` and `otherBoard`. If `otherBoard` has different dimensions from `board`, this will return `null`.

##### `board.stringifyVertex(vertex)`

- `vertex` [``](#vertex)

Returns a string that represents the given `vertex`. If `vertex` is invalid or not on the board, an empty string will be returned.

##### `board.parseVertex(coord)`

- `coord` ``

Returns a [vertex](#vertex) that the given `coord` represents. If `coord` is invalid or not on the board, `[-1, -1]` will be returned.

##### `board.getHandicapPlacement(count)`

- `count` ``

Returns a list of [vertices](#vertex) that represent the positions of black handicap stones.