@gogen-solver/core

0.0.3-alpha.0 • Public • Published

@gogen-solver/core

The core algorithm to solve Gogen puzzles with. For more info about what a Gogen puzzle is, please see the README.md in the repo root.

Install

  • yarn:yarn add @gogen-solver/core
  • npm:npm install @gogen-solver/core

Usage:

Please see underneath for examples.

Constructor Description
Gogen(grid: array[], words: string[]) Creates a new puzzle instance.
Method Description
solve solve() solves the puzzle, assuming initialised with valid words and grid. The result is available in .grid.graph.

Example

This uses an example from London Evening Standard (26th Jan 2018):

const Gogen = require('@gogen-solver/core');

const words = [
    "BUG",
    "CLING",
    "DAMPING",
    "FOIL",
    "FOX",
    "HARM",
    "HAVOC",
    "JAM",
    "KEY",
    "PEW",
    "SQUINT",
    "YEW"
  ];

const grid = [
 ["Y", "_", "W", "_", "H"],
 ["_", "_", "_", "_", "_"],
 ["Q", "_", "X", "_", "D"],
 ["_", "_", "_", "_", "_"],
 ["T", "_", "G", "_", "C"]
];

const puzzle = new Gogen(grid, words);

puzzle.solve();
console.table(puzzle.grid.graph)

Package Sidebar

Install

npm i @gogen-solver/core

Weekly Downloads

1

Version

0.0.3-alpha.0

License

MIT

Unpacked Size

5.32 kB

Total Files

3

Last publish

Collaborators

  • elgoorf