Skip to content
Browse files

updated docs for the new data structures

  • Loading branch information...
1 parent 1ee6fdc commit cef9f9d6504752d4a0c9868503b11903c02a286f @substack committed
Showing with 13 additions and 12 deletions.
  1. +12 −11 README.markdown
  2. +1 −1 package.json
View
23 README.markdown
@@ -12,13 +12,13 @@ example
var test = require('tap').test;
var sigsolve = require('sigsolve');
-var pool = [
- [ 'a', 'b' ],
- [ 'b', 'x' ],
- [ 'x', 'z' ],
- [ 'c', 'z' ],
- [ 'c', 'd' ],
-];
+var pool = {
+ f : [ 'a', 'b' ],
+ g : [ 'b', 'x' ],
+ h : [ 'x', 'z' ],
+ i : [ 'c', 'z' ],
+ j : [ 'c', 'd' ],
+};
var solutions = sigsolve([ 'a', 'z' ], pool);
console.dir(solutions);
@@ -27,7 +27,7 @@ console.dir(solutions);
output:
```
-[ [ [ 'a', 'b' ], [ 'b', 'x' ], [ 'x', 'z' ] ] ]
+[ [ 'f', 'g', 'h' ] ]
```
methods
@@ -38,10 +38,11 @@ var sigsolve = require('sigsolve')
sigsolve(target, pool)
----------------------
-Given a type signature `target` and an array of type signatures `pool`,
+Given a type signature `target` and an object `pool` mapping function names to
+type signatures,
-return an array of type signature arrays that when composed have the same
-type signature as the `target`.
+return an array of function chain arrays that when composed have the same type
+signature as the `target`.
license
=======
View
2 package.json
@@ -1,7 +1,7 @@
{
"name" : "sigsolve",
"description" : "type signature satisfiability solver under function composition",
- "version" : "0.0.0",
+ "version" : "0.1.0",
"repository" : {
"type" : "git",
"url" : "git://github.com/substack/sigsolve.git"

0 comments on commit cef9f9d

Please sign in to comment.
Something went wrong with that request. Please try again.