@ciao-lang/ts-ciao-interface

Version:

Simple Ciao interface for node.

123 lines (120 loc) • 24.6 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>Aggregates: gathering predicate solutions — 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="ExtendLang.html">↑</a><a class="lpdoc-navbutton" href="odd.html">←</a><a class="lpdoc-navbutton" href="datafacts_doc.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="ExtendLang.html">PART IV - Language extensions</a> » </li><li><a href="">Aggregates: gathering predicate solutions</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>Aggregates: gathering predicate solutions</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#aggregates"></a> Author(s): <a class="lpdoc-idx-anchor" id="Richard A. O'Keefe" href="ciaosearch.html#Richard A. O'Keefe">Richard A. O'Keefe (first version)</a>, <a class="lpdoc-idx-anchor" id="David H.D. Warren" href="ciaosearch.html#David H.D. Warren">David H.D. Warren (first version)</a>, <a class="lpdoc-idx-anchor" id="Mats Carlsson" href="ciaosearch.html#Mats Carlsson">Mats Carlsson (changes)</a>, <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 implements the standard solution aggregation predicates.When there are many solutions to a problem, and when all those solutions are required to be collected together, this can be achieved by repeatedly backtracking and gradually building up a list of the solutions. The following built-in predicates are provided to automate this process. <div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li>Library usage: <tt>:- use_module(library(aggregates)).</tt><li>Exports: <ul class="lpdoc-itemize-minus"><li>Predicates: <a class="lpdoc-idx-anchor" id="0" href="#setof/3"><tt>setof/3</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#bagof/3"><tt>bagof/3</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#findall/3"><tt>findall/3</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#findall/4"><tt>findall/4</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#findnsols/4"><tt>findnsols/4</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#findnsols/5"><tt>findnsols/5</tt></a>, <a class="lpdoc-idx-anchor" id="6" href="#^/2"><tt>^/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="setof/3" href="ciaosearch.html#setof/3">setof/3</a></div><div class="lpdoc-deftext"><tt>setof(Template,Generator,Set)</tt> Finds the Set of instances of the Template satisfying Generator. The set is in ascending order (see <a href="term_compare.html">Comparing terms</a> for a definition of this order) without duplicates, and is non-empty. If there are no solutions, <tt>setof</tt> fails. <tt>setof</tt> may succeed in more than one way, binding free variables in Generator to different values. This can be avoided by using existential quantifiers on the free variables in front of Generator, using <a class="lpdoc-idx-anchor" id="7" href="#^/2"><tt>^/2</tt></a>. For example, given the clauses: <pre class="lpdoc-codeblock">father(bill, tom). father(bill, ann). father(bill, john). father(harry, july). father(harry, daniel). </pre> The following query produces two alternative solutions via backtracking: <pre class="lpdoc-codeblock">?- setof(X,father(F,X),Sons). F = bill, Sons = [ann,john,tom] ? ; F = harry, Sons = [daniel,july] ? ; no ?- </pre>Usage:ISO <ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="8" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)Set is a list. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="9" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Template is any term. (<a class="lpdoc-idx-anchor" id="10" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)Generator 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="11" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Template is any term. (<a class="lpdoc-idx-anchor" id="12" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)Set is a list. <li>The following properties should hold globally: (<a class="lpdoc-idx-anchor" id="13" href="basic_props.html#not_further_inst/2"><tt>basic_props:not_further_inst/2</tt></a>)Template is not further instantiated. </ul> Meta-predicate with arguments: <tt>setof(?,goal,?)</tt>. Other properties: <tt>setof(X,Y,Z)</tt> <ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="14" href="basic_props.html#native/2"><tt>basic_props:native/2</tt></a>)This predicate is understood natively by CiaoPP as findall(X,Y,Z). </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="bagof/3" href="ciaosearch.html#bagof/3">bagof/3</a></div><div class="lpdoc-deftext"><tt>bagof(Template,Generator,Bag)</tt> Finds all the instances of the Template produced by the Generator, and returns them in the Bag in the order in which they were found. If the Generator contains free variables which are not bound in the Template, it assumes that this is like any other Prolog question and that you want bindings for those variables. This can be avoided by using existential quantifiers on the free variables in front of the Generator, using <a class="lpdoc-idx-anchor" id="15" href="#^/2"><tt>^/2</tt></a>.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#list/1"><tt>basic_props:list/1</tt></a>)Bag is a list. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="17" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Template is any term. (<a class="lpdoc-idx-anchor" id="18" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)Generator 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="19" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Template is any term. (<a class="lpdoc-idx-anchor" id="20" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)Bag is a list. <li>The following properties should hold globally: (<a class="lpdoc-idx-anchor" id="21" href="basic_props.html#not_further_inst/2"><tt>basic_props:not_further_inst/2</tt></a>)Template is not further instantiated. </ul> Meta-predicate with arguments: <tt>bagof(?,goal,?)</tt>. Other properties: <tt>bagof(X,Y,Z)</tt> <ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="22" href="basic_props.html#native/2"><tt>basic_props:native/2</tt></a>)This predicate is understood natively by CiaoPP as findall(X,Y,Z). </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="findall/3" href="ciaosearch.html#findall/3">findall/3</a></div><div class="lpdoc-deftext"><tt>findall(Template,Generator,List)</tt> A special case of bagof, where all free variables in the Generator are taken to be existentially quantified. Faster than the other aggregation predicates.Usage:ISO <ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="23" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)List is a list. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="24" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Template is any term. (<a class="lpdoc-idx-anchor" id="25" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)Generator 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="26" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Template is any term. (<a class="lpdoc-idx-anchor" id="27" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)List is a list. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="28" href="basic_props.html#not_further_inst/2"><tt>basic_props:not_further_inst/2</tt></a>)Template is not further instantiated. (<a class="lpdoc-idx-anchor" id="29" 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="30" href="native_props_nfdet_doc.html#not_fails/1"><tt>native_props:not_fails/1</tt></a>)All the calls of the form findall(Template,Generator,List) do not fail. (<a class="lpdoc-idx-anchor" id="31" href="native_props_nfdet_doc.html#is_det/1"><tt>native_props:is_det/1</tt></a>)All calls of the form findall(Template,Generator,List) are deterministic. </ul> Meta-predicate with arguments: <tt>findall(?,goal,?)</tt>. </div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="findall/4" href="ciaosearch.html#findall/4">findall/4</a></div><div class="lpdoc-deftext">Usage:As <a class="lpdoc-idx-anchor" id="32" href="#findall/3"><tt>findall/3</tt></a>, but returning in Tail the tail of List (findall(Template, Generator, List, Tail)).<ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="33" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Arg3 is any term. (<a class="lpdoc-idx-anchor" id="34" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Arg4 is any term. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="35" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Arg1 is any term. (<a class="lpdoc-idx-anchor" id="36" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)Arg2 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="37" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Arg1 is any term. (<a class="lpdoc-idx-anchor" id="38" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Arg3 is any term. (<a class="lpdoc-idx-anchor" id="39" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Arg4 is any term. <li>The following properties should hold globally: (<a class="lpdoc-idx-anchor" id="40" href="basic_props.html#not_further_inst/2"><tt>basic_props:not_further_inst/2</tt></a>)Arg1 is not further instantiated. </ul> Meta-predicate with arguments: <tt>findall(?,goal,?,?)</tt>. </div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="findnsols/4" href="ciaosearch.html#findnsols/4">findnsols/4</a></div><div class="lpdoc-deftext"><tt>findnsols(N,Template,Generator,List)</tt> As <a class="lpdoc-idx-anchor" id="41" href="#findall/3"><tt>findall/3</tt></a>, but generating at most N solutions of Generator. Thus, the length of List will not be greater than N. If N=<0, returns directly an empty list. This predicate is especially useful if Generator may have an infinite number of solutions.Usage:<ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="42" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)List is a list. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="43" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)N is an integer. (<a class="lpdoc-idx-anchor" id="44" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Template is any term. (<a class="lpdoc-idx-anchor" id="45" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)Generator 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="46" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Template is any term. (<a class="lpdoc-idx-anchor" id="47" href="basic_props.html#list/1"><tt>basic_props:list/1</tt></a>)List is a list. <li>The following properties should hold globally: (<a class="lpdoc-idx-anchor" id="48" href="basic_props.html#not_further_inst/2"><tt>basic_props:not_further_inst/2</tt></a>)Template is not further instantiated. </ul> Meta-predicate with arguments: <tt>findnsols(?,?,goal,?)</tt>. </div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="findnsols/5" href="ciaosearch.html#findnsols/5">findnsols/5</a></div><div class="lpdoc-deftext"><tt>findnsols(N,Template,Generator,List,Tail)</tt> As <a class="lpdoc-idx-anchor" id="49" href="#findnsols/4"><tt>findnsols/4</tt></a>, but returning in Tail the tail of List.Usage:<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="50" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)N is an integer. (<a class="lpdoc-idx-anchor" id="51" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Template is any term. (<a class="lpdoc-idx-anchor" id="52" href="basic_props.html#cgoal/1"><tt>basic_props:cgoal/1</tt></a>)Generator 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="53" href="basic_props.html#term/1"><tt>basic_props:term/1</tt></a>)Template is any term. <li>The following properties should hold globally: (<a class="lpdoc-idx-anchor" id="54" href="basic_props.html#not_further_inst/2"><tt>basic_props:not_further_inst/2</tt></a>)Template is not further instantiated. </ul> Meta-predicate with arguments: <tt>findnsols(?,?,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">Usage:<tt>X^P</tt> Existential quantification: X is existentially quantified in P. E.g., in <tt>A^p(A,B)</tt>, <tt>A</tt> is existentially quantified. Used only within <a class="lpdoc-idx-anchor" id="55" href="ciaosearch.html#aggregation predicates">aggregation predicates</a>. In all other contexts, simply, execute the procedure call P.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="56" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)X is a free variable. (<a class="lpdoc-idx-anchor" id="57" 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. </ul> Meta-predicate with arguments: <tt>? ^goal</tt>. Other properties: <tt>_X^Y</tt> <ul class="lpdoc-itemize-minus"><li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="58" href="basic_props.html#native/2"><tt>basic_props:native/2</tt></a>)This predicate is understood natively by CiaoPP as call(Y). </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="59" href="ciaosearch.html#native_props"><tt>native_props</tt></a>, <a class="lpdoc-idx-anchor" id="60" href="datafacts_rt.html"><tt>datafacts_rt</tt></a>, <a class="lpdoc-idx-anchor" id="61" href="sort.html"><tt>sort</tt></a>, <a class="lpdoc-idx-anchor" id="62" href="lists.html"><tt>lists</tt></a>. <li>Packages: <a class="lpdoc-idx-anchor" id="63" href="ciaosearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="64" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="65" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="66" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="67" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="68" href="ciaosearch.html#nortchecks"><tt>nortchecks</tt></a>, <a class="lpdoc-idx-anchor" id="69" href="isomodes_doc.html"><tt>isomodes</tt></a>, <a class="lpdoc-idx-anchor" id="70" href="ciaosearch.html#nativeprops"><tt>nativeprops</tt></a>, <a class="lpdoc-idx-anchor" id="71" href="ciaosearch.html#hiord"><tt>hiord</tt></a>, <a class="lpdoc-idx-anchor" id="72" href="datafacts_doc.html"><tt>datafacts</tt></a>. </ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>