@ciao-lang/ts-ciao-interface

Version:

Simple Ciao interface for node.

37 lines • 10.7 kB

HTML

<!DOCTYPE HTML><html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1"/><meta name="theme-color" content="#273f79"/><link rel="stylesheet" href="lpdoc.css" type="text/css"/><script type="text/javascript" src="lpdoc.js"></script><title>Term checking utilities — The Ciao System v1.22</title></head><body><div class="lpdoc-page fixleftbar"><a href="#" id="sidebar-toggle-button" class="lpdoc-navbutton"><span id="sidebar-button-arrow">☰</span></a><div id="sidebar" class="lpdoc-sidebar"><div style="height: 40px; margin-left: auto; margin-right: auto"><img src="ciao-logo_autofig.png" width=auto height=100%></div><div class="lpdoc-nav"><span class="lpdoc-on-right"><a class="lpdoc-navbutton" href="ExtraLibs.html">↑</a><a class="lpdoc-navbutton" href="terms.html">←</a><a class="lpdoc-navbutton" href="terms_vars.html">→</a><a class="lpdoc-navbutton" href="ciaosearch.html">🔍</a></span><span><a href="ciaofulltoc.html">TOC</a></span></div><hr></hr><ul class="lpdoc-itemize-sectpath"><li><a href="ciao.html">The Ciao System</a> »<br/> </li><li><a href="ExtraLibs.html">PART VIII - Additional libraries</a> »<br/> </li><li><a href=""><strong>Term checking utilities</strong></a></li></ul><hr></hr><em>ON THIS PAGE</em><ul><li><a href="#Usage and interface">Usage and interface</a></li><li><a href="#Documentation on exports">Documentation on exports</a></li><li><a href="#Documentation on internals">Documentation on internals</a></li><li><a href="#Documentation on imports">Documentation on imports</a></li><li><a href="#Other information">Other information</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>Term checking utilities</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#terms_check"></a> <strong>Author(s):</strong> <a class="lpdoc-idx-anchor" id="The Ciao Development Team" href="ciaosearch.html#The Ciao Development Team">The Ciao Development Team</a>.<p> This module implements a basic set of term checking utilities.<br/><div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li><strong>Library usage:</strong><br/><tt>:- use_module(library(terms_check)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="0" href="#variant/2"><tt>variant/2</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#ask/2"><tt>ask/2</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#subsumes_term/2"><tt>subsumes_term/2</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#most_specific_generalization/3"><tt>most_specific_generalization/3</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#most_general_instance/3"><tt>most_general_instance/3</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#unifiable/3"><tt>unifiable/3</tt></a>. <li><em>Properties:</em><br/><a class="lpdoc-idx-anchor" id="6" href="#instance/2"><tt>instance/2</tt></a>. <li><em>Regular Types:</em><br/><a class="lpdoc-idx-anchor" id="7" href="#unifier/1"><tt>unifier/1</tt></a>. </ul></ul></div></div><div id="Documentation on exports"><h2>Documentation on exports</h2><div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="variant/2" href="ciaosearch.html#variant/2">variant/2</a></div><div class="lpdoc-deftext"><span class="lpdoc-usage-decl"><tt>variant(Term1,Term2)</tt> </span><p><span class="lpdoc-var">Term1</span> and <span class="lpdoc-var">Term2</span> are identical up to renaming.</div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="ask/2" href="ciaosearch.html#ask/2">ask/2</a></div><div class="lpdoc-deftext"><span class="lpdoc-usage-decl"><tt>ask(Term1,Term2)</tt> </span><p><span class="lpdoc-var">Term1</span> and <span class="lpdoc-var">Term2</span> unify without producing bindings for the variables of <span class="lpdoc-var">Term1</span>. I.e., <tt>instance(<span class="lpdoc-var">Term1</span>,<span class="lpdoc-var">Term2</span>)</tt> holds.</div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PROPERTY</span><a class="lpdoc-idx-anchor" id="instance/2" href="ciaosearch.html#instance/2">instance/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>instance(Term1,Term2)</tt> </span><p><span class="lpdoc-var">Term1</span> is an instance of <span class="lpdoc-var">Term2</span>.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties hold globally:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="8" href="basic_props.html#native/1"><tt>basic_props:native/1</tt></a>)</span><span>This predicate is understood natively by CiaoPP. </span> </ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="subsumes_term/2" href="ciaosearch.html#subsumes_term/2">subsumes_term/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><span class="lpdoc-on-right"><span class="lpdoc-iso">ISO</span></span><span><tt>subsumes_term(Term1,Term2)</tt></span> </span><p><span class="lpdoc-var">Term2</span> is an instance of <span class="lpdoc-var">Term1</span>.</p><ul class="lpdoc-itemize-minus"></ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="most_specific_generalization/3" href="ciaosearch.html#most_specific_generalization/3">most_specific_generalization/3</a></div><div class="lpdoc-deftext"><span class="lpdoc-usage-decl"><tt>most_specific_generalization(Term1,Term2,Term)</tt> </span><p><span class="lpdoc-var">Term</span> satisfies <tt>instance(<span class="lpdoc-var">Term1</span>,<span class="lpdoc-var">Term</span>)</tt> and <tt>instance(<span class="lpdoc-var">Term2</span>,<span class="lpdoc-var">Term</span>)</tt> and there is no term less general than <span class="lpdoc-var">Term</span> (modulo variants) that satisfies it.</div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="most_general_instance/3" href="ciaosearch.html#most_general_instance/3">most_general_instance/3</a></div><div class="lpdoc-deftext"><span class="lpdoc-usage-decl"><tt>most_general_instance(Term1,Term2,Term)</tt> </span><p><span class="lpdoc-var">Term</span> satisfies <tt>instance(<span class="lpdoc-var">Term</span>,<span class="lpdoc-var">Term1</span>)</tt> and <tt>instance(<span class="lpdoc-var">Term</span>,<span class="lpdoc-var">Term2</span>)</tt> and there is no term more general than <span class="lpdoc-var">Term</span> (modulo variants) that satisfies it.</div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">REGTYPE</span><a class="lpdoc-idx-anchor" id="unifier/1" href="ciaosearch.html#unifier/1">unifier/1</a></div><div class="lpdoc-deftext"><pre class="lpdoc-codeblock">unifier(Unifier) :- list(unifier_elem,Unifier). </pre><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>unifier(X)</tt> </span><p><span class="lpdoc-var">X</span> is a unifier.</p><ul class="lpdoc-itemize-minus"></ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="unifiable/3" href="ciaosearch.html#unifiable/3">unifiable/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>unifiable(X,Y,Unifier)</tt> </span><p>Unifies <span class="lpdoc-var">Unifier</span> with the most general unifier between the terms <span class="lpdoc-var">X</span> and <span class="lpdoc-var">Y</span>. Fails if such unifier does not exit.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="9" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)</span><span><span class="lpdoc-var">X</span> is any term. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="10" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)</span><span><span class="lpdoc-var">Y</span> is any term. </span> <li><em>The following properties hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="11" href="#unifier/1"><tt>terms_check:unifier/1</tt></a>)</span><span><span class="lpdoc-var">Unifier</span> is a unifier. </span> </ul></div></div><p> </div><div id="Documentation on internals"><h2>Documentation on internals</h2><div><div class="lpdoc-defname"><span class="lpdoc-predtag">REGTYPE</span><a class="lpdoc-idx-anchor" id="unifier_elem/1" href="ciaosearch.html#unifier_elem/1">unifier_elem/1</a></div><div class="lpdoc-deftext">A regular type, defined as follows:<pre class="lpdoc-codeblock">unifier_elem(X=Term) :- var(X), term(Term). </pre> </div></div><p> </div><div id="Documentation on imports"><h2>Documentation on imports</h2>This module has the following direct dependencies:<ul class="lpdoc-itemize-minus"><li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="12" href="noprelude_doc.html"><tt>noprelude</tt></a>, <a class="lpdoc-idx-anchor" id="13" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="14" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="15" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="16" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="17" href="regtypes_doc.html"><tt>regtypes</tt></a>, <a class="lpdoc-idx-anchor" id="18" href="ciaosearch.html#nortchecks"><tt>nortchecks</tt></a>. </ul></div><div id="Other information"><h2>Other information</h2> Currently, <a class="lpdoc-idx-anchor" id="19" href="#ask/2"><tt>ask/2</tt></a> and <a class="lpdoc-idx-anchor" id="20" href="#instance/2"><tt>instance/2</tt></a> are exactly the same. However, <a class="lpdoc-idx-anchor" id="21" href="#ask/2"><tt>ask/2</tt></a> is intended to be more general, since it is also applicable to constraint domains (although not yet implemented): i.e., for the particular case of Herbrand terms, <a class="lpdoc-idx-anchor" id="22" href="#ask/2"><tt>ask/2</tt></a> is just <a class="lpdoc-idx-anchor" id="23" href="#instance/2"><tt>instance/2</tt></a>.<br/></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>