@ciao-lang/ts-ciao-interface

Version:

Simple Ciao interface for node.

94 lines • 22 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>Control constructs/predicates — The Ciao System v1.22</title></head><body><div class="lpdoc-page fixleftbar"><a href="#" id="sidebar-toggle-button" class="lpdoc-navbutton">☰</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"><a class="lpdoc-navbutton" href="BasicLang.html">↑</a><a class="lpdoc-navbutton" href="condcomp_doc.html">←</a><a class="lpdoc-navbutton" href="exceptions.html">→</a><a class="lpdoc-navbutton" href="ciaosearch.html">🔍</a><a href="ciaofulltoc.html">TOC</a></div><hr></hr><ul class="lpdoc-itemize-sectpath"><li><a href="ciao.html">The Ciao System</a> » </li><li><a href="BasicLang.html">PART II - The Ciao basic language</a> » </li><li><a href="">Control constructs/predicates</a></li></ul><hr></hr>ON THIS PAGE<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 imports">Documentation on imports</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>Control constructs/predicates</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#basiccontrol"></a> Author(s): <a class="lpdoc-idx-anchor" id="Daniel Cabeza" href="ciaosearch.html#Daniel Cabeza">Daniel Cabeza</a>, <a class="lpdoc-idx-anchor" id="Manuel Hermenegildo" href="ciaosearch.html#Manuel Hermenegildo">Manuel Hermenegildo</a>. This module contains the set of basic control predicates, except the predicates dealing with exceptions, which are in Exception and Signal handling. <div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li>Library usage: This module is imported by default (unless the <a class="lpdoc-idx-anchor" id="0" href="noprelude_doc.html"><tt>noprelude</tt></a> or <a class="lpdoc-idx-anchor" id="1" href="pure_doc.html"><tt>pure</tt></a> packages are used). <li>Exports: <ul class="lpdoc-itemize-minus"><li>Predicates: <a class="lpdoc-idx-anchor" id="2" href="#,/2"><tt>,/2</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#;/2"><tt>;/2</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#->/2"><tt>->/2</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#!/0"><tt>!/0</tt></a>, <a class="lpdoc-idx-anchor" id="6" href="#\+/1"><tt>\+/1</tt></a>, <a class="lpdoc-idx-anchor" id="7" href="#if/3"><tt>if/3</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="#true/0"><tt>true/0</tt></a>, <a class="lpdoc-idx-anchor" id="9" href="#fail/0"><tt>fail/0</tt></a>, <a class="lpdoc-idx-anchor" id="10" href="#repeat/0"><tt>repeat/0</tt></a>, <a class="lpdoc-idx-anchor" id="11" href="#false/0"><tt>false/0</tt></a>, <a class="lpdoc-idx-anchor" id="12" href="#otherwise/0"><tt>otherwise/0</tt></a>. </ul></ul></div></div><div id="Documentation on exports"><h2>Documentation on exports</h2><div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id=",/2" href="ciaosearch.html#,/2">,/2</a></div><div class="lpdoc-deftext"><tt>P,Q</tt> Conjunction (P and Q).Usage:ISO <ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="13" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)P is a term which represents a goal, i.e., an atom or a structure. (<a class="lpdoc-idx-anchor" id="14" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)Q is a term which represents a goal, i.e., an atom or a structure. </ul> Meta-predicate with arguments: <tt>goal,goal</tt>. </div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id=";/2" href="ciaosearch.html#;/2">;/2</a></div><div class="lpdoc-deftext"><tt>P;Q</tt> Disjunction (P or Q). Note that in Ciao <a class="lpdoc-idx-anchor" id="15" href="ciaosearch.html#|/2"><tt>|/2</tt></a> is not equivalent to <tt>;/2</tt>.Usage:ISO <ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="16" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)P is a term which represents a goal, i.e., an atom or a structure. (<a class="lpdoc-idx-anchor" id="17" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)Q is a term which represents a goal, i.e., an atom or a structure. </ul> Meta-predicate with arguments: <tt>goal;goal</tt>. </div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="->/2" href="ciaosearch.html#->/2">->/2</a></div><div class="lpdoc-deftext"><tt>P->Q</tt> If P then Q else fail, using first solution of P only. Also, <tt>(</tt>P <tt>-></tt> Q <tt>;</tt> R<tt>)</tt>, if P then Q else R, using first solution of P only. No cuts are allowed in P.Usage:ISO <ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="18" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)P is a term which represents a goal, i.e., an atom or a structure. (<a class="lpdoc-idx-anchor" id="19" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)Q is a term which represents a goal, i.e., an atom or a structure. </ul> Meta-predicate with arguments: <tt>goal->goal</tt>. </div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="!/0" href="ciaosearch.html#!/0">!/0</a></div><div class="lpdoc-deftext">Usage:ISO Commit to any choices taken in the current predicate.<ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="20" href="native_props_nfdet_doc.html#is_det/1"><tt>native_props:is_det/1</tt></a>)All calls of the form ! are deterministic. (<a class="lpdoc-idx-anchor" id="21" href="native_props_nfdet_doc.html#not_fails/1"><tt>native_props:not_fails/1</tt></a>)All the calls of the form ! do not fail. (<a class="lpdoc-idx-anchor" id="22" href="native_props_cardinality_doc.html#relations/2"><tt>native_props:relations/2</tt></a>)Goal ! produces 1 solutions. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="\+/1" href="ciaosearch.html#\+/1">\+/1</a></div><div class="lpdoc-deftext"><tt>\+P</tt> Goal P is not provable (negation by failure). Fails if P has a solution, and succeeds otherwise. No cuts are allowed in P.Usage:ISO <ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="23" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)P is a term which represents a goal, i.e., an atom or a structure. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="24" href="basic_props.html#native/2"><tt>basic_props:native/2</tt></a>)This predicate is understood natively by CiaoPP as not(X). (<a class="lpdoc-idx-anchor" id="25" href="native_props_nfdet_doc.html#is_det/1"><tt>native_props:is_det/1</tt></a>)All calls of the form \+P are deterministic. </ul> Meta-predicate with arguments: <tt>\+goal</tt>. </div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="if/3" href="ciaosearch.html#if/3">if/3</a></div><div class="lpdoc-deftext"><tt>if(P,Q,R)</tt> If P then Q else R, exploring all solutions of P. No cuts are allowed in P.Usage:<tt>if(A,B,C)</tt> <ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="26" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)A is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="27" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)B is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="28" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)C is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="29" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)A is a term which represents a goal, i.e., an atom or a structure. (<a class="lpdoc-idx-anchor" id="30" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)B is a term which represents a goal, i.e., an atom or a structure. (<a class="lpdoc-idx-anchor" id="31" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)C is a term which represents a goal, i.e., an atom or a structure. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="32" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)A is a term which represents a goal, i.e., an atom or a structure. (<a class="lpdoc-idx-anchor" id="33" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)B is a term which represents a goal, i.e., an atom or a structure. (<a class="lpdoc-idx-anchor" id="34" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)C is a term which represents a goal, i.e., an atom or a structure. </ul> Meta-predicate with arguments: <tt>if(goal,goal,goal)</tt>. </div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="true/0" href="ciaosearch.html#true/0">true/0</a></div><div class="lpdoc-deftext">Usage:ISO Succeed (noop).<ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="35" href="basic_props.html#native/1"><tt>basic_props:native/1</tt></a>)This predicate is understood natively by CiaoPP. (<a class="lpdoc-idx-anchor" id="36" href="basic_props.html#sideff/2"><tt>basic_props:sideff/2</tt></a>)true is side-effect free. (<a class="lpdoc-idx-anchor" id="37" href="native_props_nfdet_doc.html#is_det/1"><tt>native_props:is_det/1</tt></a>)All calls of the form true are deterministic. (<a class="lpdoc-idx-anchor" id="38" href="native_props_nfdet_doc.html#not_fails/1"><tt>native_props:not_fails/1</tt></a>)All the calls of the form true do not fail. (<a class="lpdoc-idx-anchor" id="39" href="native_props_cardinality_doc.html#relations/2"><tt>native_props:relations/2</tt></a>)Goal true produces 1 solutions. </ul> Other properties: <ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="40" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)true is evaluable at compile-time. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="fail/0" href="ciaosearch.html#fail/0">fail/0</a></div><div class="lpdoc-deftext">Usage:ISO Fail, backtrack immediately.<ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="41" href="basic_props.html#native/1"><tt>basic_props:native/1</tt></a>)This predicate is understood natively by CiaoPP. (<a class="lpdoc-idx-anchor" id="42" href="basic_props.html#sideff/2"><tt>basic_props:sideff/2</tt></a>)fail is side-effect free. (<a class="lpdoc-idx-anchor" id="43" href="native_props_nfdet_doc.html#is_det/1"><tt>native_props:is_det/1</tt></a>)All calls of the form fail are deterministic. (<a class="lpdoc-idx-anchor" id="44" href="native_props_nfdet_doc.html#fails/1"><tt>native_props:fails/1</tt></a>)Calls of the form fail fail. (<a class="lpdoc-idx-anchor" id="45" href="native_props_cardinality_doc.html#relations/2"><tt>native_props:relations/2</tt></a>)Goal fail produces 0 solutions. </ul> Other properties: <ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="46" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)fail is evaluable at compile-time. </ul><ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="47" href="basic_props.html#equiv/2"><tt>basic_props:equiv/2</tt></a>)fail is equivalent to fail. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="repeat/0" href="ciaosearch.html#repeat/0">repeat/0</a></div><div class="lpdoc-deftext">Usage:ISO Generates an infinite sequence of backtracking choices.<ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="48" href="basic_props.html#native/1"><tt>basic_props:native/1</tt></a>)This predicate is understood natively by CiaoPP. (<a class="lpdoc-idx-anchor" id="49" href="basic_props.html#sideff/2"><tt>basic_props:sideff/2</tt></a>)repeat is side-effect free. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="false/0" href="ciaosearch.html#false/0">false/0</a></div><div class="lpdoc-deftext"><ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="50" href="basic_props.html#sideff/2"><tt>basic_props:sideff/2</tt></a>)false is side-effect free. (<a class="lpdoc-idx-anchor" id="51" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)false is evaluable at compile-time. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="otherwise/0" href="ciaosearch.html#otherwise/0">otherwise/0</a></div><div class="lpdoc-deftext"><ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="52" href="basic_props.html#sideff/2"><tt>basic_props:sideff/2</tt></a>)otherwise is side-effect free. (<a class="lpdoc-idx-anchor" id="53" href="basic_props.html#eval/1"><tt>basic_props:eval/1</tt></a>)otherwise is evaluable at compile-time. </ul></div></div> </div><div id="Documentation on imports"><h2>Documentation on imports</h2>This module has the following direct dependencies:<ul class="lpdoc-itemize-minus"><li>System library modules: <a class="lpdoc-idx-anchor" id="54" href="ciaosearch.html#native_props"><tt>native_props</tt></a>, <a class="lpdoc-idx-anchor" id="55" href="debugger_doc.html"><tt>debugger</tt></a>. <li>Packages: <a class="lpdoc-idx-anchor" id="56" href="ciaosearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="57" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="58" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="59" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="60" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="61" href="ciaosearch.html#nortchecks"><tt>nortchecks</tt></a>, <a class="lpdoc-idx-anchor" id="62" href="isomodes_doc.html"><tt>isomodes</tt></a>, <a class="lpdoc-idx-anchor" id="63" href="ciaosearch.html#nativeprops"><tt>nativeprops</tt></a>. </ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>