finitedomain
v3.0.0
Published
A fast feature rich finite domain solver
Downloads
91
Maintainers
Readme
finitedomain
Finite domain constraint solver, originally based on FD.js.
This is very much a WIP.
API is bound to change, consider yourself warned.
Installing
npm install finitedomain
Usage
Find all numbers between 10 and 20 that are bigger than 14 and smaller than 17 and not 16. Contrived? Nah.
import Solver from 'finitedomain';
let solver = new Solver();
solver.decl('A', [10, 20]);
solver.gt('A', 14);
solver.lt('A', 17);
solver.neq('A', 16);
solver.solve();
console.log(solver.solutions); // -> [{A: 15}]
For other details see the extensive test suite.
Tasks
There are a few grunt tasks and bash scripts hooked up to npm. This repo also uses git hooks for pre- and post commit hooks.
As a general rule, ./build
is used for any temporary output, including code coverage reports and temporary build files when producing a dist.
Then ./dist
only contains final builds (./dist/finitedomain.dist.min.js
and for some tasks ./dist/browser.js
).
Note that both ./build
and ./dist
are cleared at the start of almost every (grunt) task.
(These tasks obviously require an npm install
)
Grunt tasks:
grunt clean
: removes./dist
and./build
grunt build
: a direct alias fordist
grunt dist
: lint, test, build, and minify to produce a real dist buildgrunt distq
: create a dist but skip linting, testing, and code coveragegrunt distperf
: same asgrunt distq
but also copies the dist to./dist/browser.js
, can be used in conjunction ofdistheat
anddistbug
while maintaining the same path tobrowser.js
.grunt distheat
: creates a dist but instead of minification as the last step it beautifies. Used for HeatFiler, a count based heatmap profiler. Copies tobrowser.js
.grunt distbug
: creates a build without removing test artifacts or minification. In case you need proper stack traces in other projects.grunt coverage
: runs all tests in the code coverage toolgrunt test
: runs linting and all testsgrunt testq
: runs tests without lintinggrunt watch:q
: runsdistq
whenever a file changesgrunt watch:b
: runsdistbug
whenever a file changesgrunt watch:p
: runsdistperf
whenever a file changes
Bash / npm scripts:
npm run lint
: run eslint with dist config (slightly stricter than dev). Exits non-zero if it fails.npm run lintdev
: run eslint with dev config (allowsconsole.log
,debugger
, etc). No non-zero exit for failures.npm run lintfix
: runs eslint in the fix mode