hg.stevelosh.com > docs.stevelosh.com

6a8c03807d06 

temperance: Update site.
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Sat, 20 Aug 2016 22:32:15 +0000
parents 15f1ecfc6d24
children accf86e5f952
branches/tags (none)
files temperance/reference/index.html

Changes

--- a/temperance/reference/index.html	Sat Aug 20 22:31:01 2016 +0000
+++ b/temperance/reference/index.html	Sat Aug 20 22:32:15 2016 +0000
@@ -12,86 +12,182 @@
         <div class="wrap">
             <header><h1><a href="..">Temperance</a></h1></header>
                 <div class="markdown">
-<h1 id="api-reference"><a href="">API Reference</a></h1><p>The following is a list of all user-facing parts of Bones.</p>
+<h1 id="api-reference"><a href="">API Reference</a></h1><p>The following is a list of all user-facing parts of Temperance.</p>
 <p>If there are backwards-incompatible changes to anything listed here, they will
 be noted in the changelog and the author will feel bad.</p>
 <p>Anything not listed here is subject to change at any time with no warning, so
 don't touch it.</p>
 <div class="toc">
 <ul>
-<li><a href="#package-bonespaip">Package BONES.PAIP</a><ul>
-<li><a href="#check-occurs-variable">*CHECK-OCCURS* (variable)</a></li>
-<li><a href="#clear-db-function">CLEAR-DB (function)</a></li>
+<li><a href="#package-temperancewam">Package TEMPERANCE.WAM</a><ul>
 <li><a href="#fact-macro">FACT (macro)</a></li>
-<li><a href="#fail-variable">FAIL (variable)</a></li>
-<li><a href="#no-bindings-variable">NO-BINDINGS (variable)</a></li>
+<li><a href="#facts-macro">FACTS (macro)</a></li>
+<li><a href="#finalize-logic-frame-function">FINALIZE-LOGIC-FRAME (function)</a></li>
+<li><a href="#invoke-fact-function">INVOKE-FACT (function)</a></li>
+<li><a href="#invoke-facts-function">INVOKE-FACTS (function)</a></li>
+<li><a href="#invoke-prove-function">INVOKE-PROVE (function)</a></li>
+<li><a href="#invoke-query-function">INVOKE-QUERY (function)</a></li>
+<li><a href="#invoke-query-all-function">INVOKE-QUERY-ALL (function)</a></li>
+<li><a href="#invoke-query-do-function">INVOKE-QUERY-DO (function)</a></li>
+<li><a href="#invoke-query-find-function">INVOKE-QUERY-FIND (function)</a></li>
+<li><a href="#invoke-query-map-function">INVOKE-QUERY-MAP (function)</a></li>
+<li><a href="#invoke-rule-function">INVOKE-RULE (function)</a></li>
+<li><a href="#make-database-function">MAKE-DATABASE (function)</a></li>
+<li><a href="#pop-logic-frame-function">POP-LOGIC-FRAME (function)</a></li>
+<li><a href="#prove-macro">PROVE (macro)</a></li>
+<li><a href="#push-logic-frame-function">PUSH-LOGIC-FRAME (function)</a></li>
+<li><a href="#push-logic-frame-with-macro">PUSH-LOGIC-FRAME-WITH (macro)</a></li>
 <li><a href="#query-macro">QUERY (macro)</a></li>
 <li><a href="#query-all-macro">QUERY-ALL (macro)</a></li>
-<li><a href="#query-one-macro">QUERY-ONE (macro)</a></li>
-<li><a href="#return-all-macro">RETURN-ALL (macro)</a></li>
-<li><a href="#return-one-macro">RETURN-ONE (macro)</a></li>
+<li><a href="#query-do-macro">QUERY-DO (macro)</a></li>
+<li><a href="#query-find-macro">QUERY-FIND (macro)</a></li>
+<li><a href="#query-map-macro">QUERY-MAP (macro)</a></li>
+<li><a href="#reset-database-function">RESET-DATABASE (function)</a></li>
 <li><a href="#rule-macro">RULE (macro)</a></li>
-<li><a href="#unify-function">UNIFY (function)</a></li>
+<li><a href="#with-database-macro">WITH-DATABASE (macro)</a></li>
+<li><a href="#with-fresh-database-macro">WITH-FRESH-DATABASE (macro)</a></li>
 </ul>
 </li>
 </ul></div>
-<h2 id="package-bonespaip">Package <code>BONES.PAIP</code></h2>
-<p>Test?</p>
-<h3 id="check-occurs-variable"><code>*CHECK-OCCURS*</code> (variable)</h3>
-<p>Whether to perform an occurs check.</p>
-<h3 id="clear-db-function"><code>CLEAR-DB</code> (function)</h3>
-<div class="codehilite"><pre>(CLEAR-DB)
+<h2 id="package-temperancewam">Package <code>TEMPERANCE.WAM</code></h2>
+<h3 id="fact-macro"><code>FACT</code> (macro)</h3>
+<div class="codehilite"><pre>(FACT FACT)
+</pre></div>
+
+
+<h3 id="facts-macro"><code>FACTS</code> (macro)</h3>
+<div class="codehilite"><pre>(FACTS
+  &amp;BODY
+  FACTS)
+</pre></div>
+
+
+<h3 id="finalize-logic-frame-function"><code>FINALIZE-LOGIC-FRAME</code> (function)</h3>
+<div class="codehilite"><pre>(FINALIZE-LOGIC-FRAME)
 </pre></div>
 
 
-<h3 id="fact-macro"><code>FACT</code> (macro)</h3>
-<div class="codehilite"><pre>(FACT &amp;REST BODY)
+<h3 id="invoke-fact-function"><code>INVOKE-FACT</code> (function)</h3>
+<div class="codehilite"><pre>(INVOKE-FACT FACT)
+</pre></div>
+
+
+<h3 id="invoke-facts-function"><code>INVOKE-FACTS</code> (function)</h3>
+<div class="codehilite"><pre>(INVOKE-FACTS &amp;REST FACTS)
+</pre></div>
+
+
+<h3 id="invoke-prove-function"><code>INVOKE-PROVE</code> (function)</h3>
+<div class="codehilite"><pre>(INVOKE-PROVE &amp;REST TERMS438)
+</pre></div>
+
+
+<h3 id="invoke-query-function"><code>INVOKE-QUERY</code> (function)</h3>
+<div class="codehilite"><pre>(INVOKE-QUERY &amp;REST TERMS262)
+</pre></div>
+
+
+<h3 id="invoke-query-all-function"><code>INVOKE-QUERY-ALL</code> (function)</h3>
+<div class="codehilite"><pre>(INVOKE-QUERY-ALL &amp;REST TERMS296)
 </pre></div>
 
 
-<h3 id="fail-variable"><code>FAIL</code> (variable)</h3>
-<p>Failure to unify</p>
-<h3 id="no-bindings-variable"><code>NO-BINDINGS</code> (variable)</h3>
-<p>A succesful unification, with no bindings.</p>
-<h3 id="query-macro"><code>QUERY</code> (macro)</h3>
-<div class="codehilite"><pre>(QUERY &amp;REST GOALS)
+<h3 id="invoke-query-do-function"><code>INVOKE-QUERY-DO</code> (function)</h3>
+<div class="codehilite"><pre>(INVOKE-QUERY-DO FUNCTION &amp;REST TERMS366)
+</pre></div>
+
+
+<h3 id="invoke-query-find-function"><code>INVOKE-QUERY-FIND</code> (function)</h3>
+<div class="codehilite"><pre>(INVOKE-QUERY-FIND PREDICATE &amp;REST TERMS402)
+</pre></div>
+
+
+<h3 id="invoke-query-map-function"><code>INVOKE-QUERY-MAP</code> (function)</h3>
+<div class="codehilite"><pre>(INVOKE-QUERY-MAP FUNCTION &amp;REST TERMS330)
 </pre></div>
 
 
-<p>Perform the query interactively.</p>
-<h3 id="query-all-macro"><code>QUERY-ALL</code> (macro)</h3>
-<div class="codehilite"><pre>(QUERY-ALL &amp;REST GOALS)
+<h3 id="invoke-rule-function"><code>INVOKE-RULE</code> (function)</h3>
+<div class="codehilite"><pre>(INVOKE-RULE HEAD &amp;REST BODY)
+</pre></div>
+
+
+<h3 id="make-database-function"><code>MAKE-DATABASE</code> (function)</h3>
+<div class="codehilite"><pre>(MAKE-DATABASE)
+</pre></div>
+
+
+<h3 id="pop-logic-frame-function"><code>POP-LOGIC-FRAME</code> (function)</h3>
+<div class="codehilite"><pre>(POP-LOGIC-FRAME)
+</pre></div>
+
+
+<h3 id="prove-macro"><code>PROVE</code> (macro)</h3>
+<div class="codehilite"><pre>(PROVE &amp;REST TERMS)
 </pre></div>
 
 
-<p>Perform the query and automatically show all results.</p>
-<h3 id="query-one-macro"><code>QUERY-ONE</code> (macro)</h3>
-<div class="codehilite"><pre>(QUERY-ONE &amp;REST GOALS)
+<h3 id="push-logic-frame-function"><code>PUSH-LOGIC-FRAME</code> (function)</h3>
+<div class="codehilite"><pre>(PUSH-LOGIC-FRAME)
+</pre></div>
+
+
+<h3 id="push-logic-frame-with-macro"><code>PUSH-LOGIC-FRAME-WITH</code> (macro)</h3>
+<div class="codehilite"><pre>(PUSH-LOGIC-FRAME-WITH
+  &amp;BODY
+  BODY)
+</pre></div>
+
+
+<h3 id="query-macro"><code>QUERY</code> (macro)</h3>
+<div class="codehilite"><pre>(QUERY &amp;REST TERMS)
 </pre></div>
 
 
-<p>Perform the query and just show the first result.</p>
-<h3 id="return-all-macro"><code>RETURN-ALL</code> (macro)</h3>
-<div class="codehilite"><pre>(RETURN-ALL &amp;REST GOALS)
+<h3 id="query-all-macro"><code>QUERY-ALL</code> (macro)</h3>
+<div class="codehilite"><pre>(QUERY-ALL &amp;REST TERMS)
+</pre></div>
+
+
+<h3 id="query-do-macro"><code>QUERY-DO</code> (macro)</h3>
+<div class="codehilite"><pre>(QUERY-DO FUNCTION &amp;REST TERMS)
 </pre></div>
 
 
-<h3 id="return-one-macro"><code>RETURN-ONE</code> (macro)</h3>
-<div class="codehilite"><pre>(RETURN-ONE &amp;REST GOALS)
+<h3 id="query-find-macro"><code>QUERY-FIND</code> (macro)</h3>
+<div class="codehilite"><pre>(QUERY-FIND PREDICATE &amp;REST TERMS)
+</pre></div>
+
+
+<h3 id="query-map-macro"><code>QUERY-MAP</code> (macro)</h3>
+<div class="codehilite"><pre>(QUERY-MAP FUNCTION &amp;REST TERMS)
+</pre></div>
+
+
+<h3 id="reset-database-function"><code>RESET-DATABASE</code> (function)</h3>
+<div class="codehilite"><pre>(RESET-DATABASE)
 </pre></div>
 
 
 <h3 id="rule-macro"><code>RULE</code> (macro)</h3>
-<div class="codehilite"><pre>(RULE &amp;REST CLAUSE)
+<div class="codehilite"><pre>(RULE HEAD
+  &amp;BODY
+  BODY)
 </pre></div>
 
 
-<h3 id="unify-function"><code>UNIFY</code> (function)</h3>
-<div class="codehilite"><pre>(UNIFY X Y &amp;OPTIONAL (BINDINGS NO-BINDINGS))
+<h3 id="with-database-macro"><code>WITH-DATABASE</code> (macro)</h3>
+<div class="codehilite"><pre>(WITH-DATABASE DATABASE
+  &amp;BODY
+  BODY)
 </pre></div>
 
 
-<p>Unify the two terms and return bindings necessary to do so (or FAIL).</p>
+<h3 id="with-fresh-database-macro"><code>WITH-FRESH-DATABASE</code> (macro)</h3>
+<div class="codehilite"><pre>(WITH-FRESH-DATABASE
+  &amp;BODY
+  BODY)
+</pre></div>
                 </div>
             <footer><p><i>Made with Lisp and love by <a href="http://stevelosh.com/">Steve Losh</a> in Reykjavík, Iceland.</i></p>
 <script>