Git Product home page Git Product logo

deadstones's Introduction

@sabaki/deadstones Build Status

Simple Monte Carlo algorithm to determine dead stones on a Go board.

Installation

Use npm to install:

$ npm install @sabaki/deadstones

To use this module, require it as follows:

const deadstones = require('@sabaki/deadstones')

This module supports fetching the WASM file via fetch on the web if no node environment is found. Use a bundler like webpack and call the following method right after import or require:

deadstones.useFetch('./path/to/deadstones_bg.wasm')

Building

Make sure you have the Rust toolchain installed via rustup. This project uses the native WASM target which you can acquire with:

$ rustup target add wasm32-unknown-unknown

Make sure you have wasm-pack, Node.js 8 or higher, and npm installed. Clone this repository and install its dependencies with npm:

$ git clone https://github.com/SabakiHQ/deadstones
$ cd deadstones
$ npm install

To build WASM binaries and to start tests, use the following commands:

$ npm run build
$ npm test

API

Board Data

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

[[ 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 an array of the form [x, y] where x and y are non-negative integers, zero-based coordinates of the vertex. [0, 0] denotes the top left position of the board.

This module exposes four functions:

async deadstones.guess(data[, options])

  • data - Board data
  • options <Object> (optional)
    • finished <boolean> (optional) - Default: false

      If set true, deadstones will assume that player areas have been completely surrounded, yielding better results.

    • iterations <integer> (optional) - Default: 100

      The number of random playthroughs to make.

Returns an array of vertices that Sabaki thinks are dead.

async deadstones.getProbabilityMap(data, iterations)

  • data - Board data
  • iterations <integer> - The number of random playthroughs to make.

Returns an array of arrays of the same size as data. Each entry is a number between -1 and 1 and corresponds to a vertex. A number closer to -1 is more likely controlled by white and a number closer to 1 is more likely controlled by black.

async deadstones.playTillEnd(data, sign)

  • data - Board data
  • sign -1 | 1 - White player corresponds to -1, black player is represented by 1.

Makes random alternating moves, starting with the player determined by sign, until only eye filling moves can be made. Then all eyes that are left will be filled with the corresponding color. This final board arrangement data will be returned.

async deadstones.getFloatingStones(data)

A fast function that returns an array of vertices of stones that are inside enemy territory and do not surround more than one point of territory themselves.

deadstones's People

Contributors

yishn avatar adamreisnz avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.