docs/03-reference.markdown @ f1ef8f905a1d
Split functor cells into separate functor and arity cells This lets us keep everything we need for unification right in the contiguous main store array. It also makes GC a bit easier to deal with, because all the references to things outside the WAM are kept in basically one place.
| author | Steve Losh <steve@stevelosh.com> |
|---|---|
| date | Sat, 16 Jul 2016 01:34:04 +0000 |
| parents | dfba7d90a8a5 |
| children | 66c01894e34c |
# API Reference The following is a list of all user-facing parts of Bones. If there are backwards-incompatible changes to anything listed here, they will be noted in the changelog and the author will feel bad. Anything not listed here is subject to change at any time with no warning, so don't touch it. [TOC] ## Package `BONES.PAIP` Test? ### `*CHECK-OCCURS*` (variable) Whether to perform an occurs check. ### `CLEAR-DB` (function) (CLEAR-DB) ### `FACT` (macro) (FACT &REST BODY) ### `FAIL` (variable) Failure to unify ### `NO-BINDINGS` (variable) A succesful unification, with no bindings. ### `QUERY` (macro) (QUERY &REST GOALS) Perform the query interactively. ### `QUERY-ALL` (macro) (QUERY-ALL &REST GOALS) Perform the query and automatically show all results. ### `QUERY-ONE` (macro) (QUERY-ONE &REST GOALS) Perform the query and just show the first result. ### `RETURN-ALL` (macro) (RETURN-ALL &REST GOALS) ### `RETURN-ONE` (macro) (RETURN-ONE &REST GOALS) ### `RULE` (macro) (RULE &REST CLAUSE) ### `UNIFY` (function) (UNIFY X Y &OPTIONAL (BINDINGS NO-BINDINGS)) Unify the two terms and return bindings necessary to do so (or FAIL).