@ciao-lang/ts-ciao-interface

Version:

Simple Ciao interface for node.

59 lines • 13.9 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>Miscellaneous ISO Prolog 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="CompatProlog.html">↑</a><a class="lpdoc-navbutton" href="iso_char.html">←</a><a class="lpdoc-navbutton" href="iso_incomplete.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="CompatProlog.html">PART V - Compatibility</a> » </li><li><a href="">Miscellaneous ISO Prolog 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>Miscellaneous ISO Prolog predicates</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#iso_misc"></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="Jose F. Morales" href="ciaosearch.html#Jose F. Morales">Jose F. Morales</a>. This module implements some miscellaneous ISO Prolog predicates. <div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li>Library usage: <tt>:- use_module(library(iso_misc)).</tt><li>Exports: <ul class="lpdoc-itemize-minus"><li>Predicates: <a class="lpdoc-idx-anchor" id="0" href="#once/1"><tt>once/1</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#forall/2"><tt>forall/2</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#call_det/2"><tt>call_det/2</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#compound/1"><tt>compound/1</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#sub_atom/5"><tt>sub_atom/5</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#unify_with_occurs_check/2"><tt>unify_with_occurs_check/2</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="once/1" href="ciaosearch.html#once/1">once/1</a></div><div class="lpdoc-deftext"><tt>once(G)</tt> Finds the first solution of goal G (if any). <a class="lpdoc-idx-anchor" id="6" href="#once/1"><tt>once/1</tt></a> behaves as <a class="lpdoc-idx-anchor" id="7" href="hiord_rt.html#call/1"><tt>call/1</tt></a>, except that no further solutions are explored on backtracking.Usage:ISO <ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="8" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)G is a term which represents a goal, i.e., an atom or a structure. </ul> Meta-predicate with arguments: <tt>once(goal)</tt>. </div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="forall/2" href="ciaosearch.html#forall/2">forall/2</a></div><div class="lpdoc-deftext"><tt>forall(Generate,Test)</tt> <a class="lpdoc-idx-anchor" id="9" href="ciaosearch.html#Test"><tt>Test</tt></a> succeeds for all solutions to <a class="lpdoc-idx-anchor" id="10" href="ciaosearch.html#Generate"><tt>Generate</tt></a>Usage:<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="11" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)Generate is a term which represents a goal, i.e., an atom or a structure. (<a class="lpdoc-idx-anchor" id="12" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)Test is a term which represents a goal, i.e., an atom or a structure. </ul> Meta-predicate with arguments: <tt>forall(goal,goal)</tt>. </div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="call_det/2" href="ciaosearch.html#call_det/2">call_det/2</a></div><div class="lpdoc-deftext"><tt>call_det(G,Det)</tt> Call goal G and unify Det with <tt>true</tt> if no additional choice-points has been created, or <tt>false</tt> otherwiseUsage:<ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="13" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Det is an atom. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="14" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)G is a term which represents a goal, i.e., an atom or a structure. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="15" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Det is an atom. </ul> Meta-predicate with arguments: <tt>call_det(goal,?)</tt>. </div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="compound/1" href="ciaosearch.html#compound/1">compound/1</a></div><div class="lpdoc-deftext"><tt>compound(T)</tt> T is currently instantiated to a compound term.Usage:ISO <ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="16" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)T is any term. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="17" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)T is any term. (<a class="lpdoc-idx-anchor" id="18" href="basic_props.html#struct/1"><tt>basic_props:struct/1</tt></a>)T is a compound term. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="sub_atom/5" href="ciaosearch.html#sub_atom/5">sub_atom/5</a></div><div class="lpdoc-deftext"><tt>sub_atom(Atom,Before,Length,After,Sub_atom)</tt> Is true iff atom Atom can be broken into three pieces, AtomL, Sub_atom and AtomR such that Before is the number of characters of the name of AtomL, Length is the number of characters of the name of Sub_atom and After is the number of characters of the name of AtomRUsage:ISO <ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="19" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Before is an integer. (<a class="lpdoc-idx-anchor" id="20" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Length is an integer. (<a class="lpdoc-idx-anchor" id="21" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)After is an integer. (<a class="lpdoc-idx-anchor" id="22" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Sub_atom is an atom. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="23" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Atom is an atom. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="24" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Before is an integer. (<a class="lpdoc-idx-anchor" id="25" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Length is an integer. (<a class="lpdoc-idx-anchor" id="26" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)After is an integer. (<a class="lpdoc-idx-anchor" id="27" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Sub_atom is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="unify_with_occurs_check/2" href="ciaosearch.html#unify_with_occurs_check/2">unify_with_occurs_check/2</a></div><div class="lpdoc-deftext"><tt>unify_with_occurs_check(X,Y)</tt> Attempts to compute and apply a most general unifier of the two terms X and Y. Is true iff X and Y are unifiable.Usage:ISO <ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="28" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)X is any term. (<a class="lpdoc-idx-anchor" id="29" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Y is any term. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="30" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)X is any term. (<a class="lpdoc-idx-anchor" id="31" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Y is any term. </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="32" href="between.html"><tt>between</tt></a>. <li>Packages: <a class="lpdoc-idx-anchor" id="33" href="ciaosearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="34" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="35" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="36" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="37" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="38" href="isomodes_doc.html"><tt>isomodes</tt></a>. </ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>