@ciao-lang/ts-ciao-interface

Version:

Simple Ciao interface for node.

57 lines • 14.3 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>Graphs — 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="DataStructuresAlgs.html">↑</a><a class="lpdoc-navbutton" href="keys.html">←</a><a class="lpdoc-navbutton" href="ugraphs.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="DataStructuresAlgs.html">PART VI - Data structures and algorithms</a> »<br/> </li><li><a href=""><strong>Graphs</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></ul></div><div class="lpdoc-main"><div id=""><h1>Graphs</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#graphs"></a> <strong>Author(s):</strong> <a class="lpdoc-idx-anchor" id="Francisco Bueno" href="ciaosearch.html#Francisco Bueno">Francisco Bueno</a>.<p> This module implements utilities for work with graphs<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(graphs)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="0" href="#dgraph_to_ugraph/2"><tt>dgraph_to_ugraph/2</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#dlgraph_to_lgraph/2"><tt>dlgraph_to_lgraph/2</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#edges_to_ugraph/2"><tt>edges_to_ugraph/2</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#edges_to_lgraph/2"><tt>edges_to_lgraph/2</tt></a>. <li><em>Regular Types:</em><br/><a class="lpdoc-idx-anchor" id="4" href="#dgraph/1"><tt>dgraph/1</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#dlgraph/1"><tt>dlgraph/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">REGTYPE</span><a class="lpdoc-idx-anchor" id="dgraph/1" href="ciaosearch.html#dgraph/1">dgraph/1</a></div><div class="lpdoc-deftext"><span class="lpdoc-usage-decl"><tt>dgraph(Graph)</tt> </span><p>A directed graph is a term <tt>graph(V,E)</tt> where <tt>V</tt> is a list of vertices and <tt>E</tt> is a list of edges (none necessarily sorted). Edges are pairs of vertices which are directed, i.e., <tt>(a,b)</tt> represents <tt>a->b</tt>. Two vertices <tt>a</tt> and <tt>b</tt> are equal only if <tt>a==b</tt>.<p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>dgraph(Graph)</tt> </span><p><span class="lpdoc-var">Graph</span> is a directed graph.</p><ul class="lpdoc-itemize-minus"></ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">REGTYPE</span><a class="lpdoc-idx-anchor" id="dlgraph/1" href="ciaosearch.html#dlgraph/1">dlgraph/1</a></div><div class="lpdoc-deftext"><span class="lpdoc-usage-decl"><tt>dlgraph(Graph)</tt> </span><p>A labeled directed graph is a directed graph where edges are triples of the form <tt>(a,l,b)</tt> where <tt>l</tt> is the label of the edge <tt>(a,b)</tt>.<p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>dlgraph(Graph)</tt> </span><p><span class="lpdoc-var">Graph</span> is a directed labeled graph.</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="dgraph_to_ugraph/2" href="ciaosearch.html#dgraph_to_ugraph/2">dgraph_to_ugraph/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>dgraph_to_ugraph(Graph,UGraph)</tt> </span><p>Converts <span class="lpdoc-var">Graph</span> to <span class="lpdoc-var">UGraph</span>.</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="6" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)</span><span><span class="lpdoc-var">Graph</span> is currently a term which is not a free variable. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="7" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)</span><span><span class="lpdoc-var">UGraph</span> is a free variable. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="8" href="#dgraph/1"><tt>graphs:dgraph/1</tt></a>)</span><span><span class="lpdoc-var">Graph</span> is a directed graph. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="9" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)</span><span><span class="lpdoc-var">UGraph</span> is a free variable. </span> <li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="10" href="#dgraph/1"><tt>graphs:dgraph/1</tt></a>)</span><span><span class="lpdoc-var">Graph</span> is a directed graph. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="11" href="ugraphs.html#ugraph/1"><tt>ugraphs:ugraph/1</tt></a>)</span><span><span class="lpdoc-var">UGraph</span> is an ugraph. </span> </ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="dlgraph_to_lgraph/2" href="ciaosearch.html#dlgraph_to_lgraph/2">dlgraph_to_lgraph/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>dlgraph_to_lgraph(Graph,LGraph)</tt> </span><p>Converts <span class="lpdoc-var">Edges</span> to <span class="lpdoc-var">LGraph</span>.</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="12" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)</span><span><span class="lpdoc-var">Graph</span> is currently a term which is not a free variable. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="13" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)</span><span><span class="lpdoc-var">LGraph</span> is a free variable. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="14" href="#dlgraph/1"><tt>graphs:dlgraph/1</tt></a>)</span><span><span class="lpdoc-var">Graph</span> is a directed labeled graph. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="15" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)</span><span><span class="lpdoc-var">LGraph</span> is a free variable. </span> <li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="16" href="#dlgraph/1"><tt>graphs:dlgraph/1</tt></a>)</span><span><span class="lpdoc-var">Graph</span> is a directed labeled graph. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="17" href="lgraphs.html#lgraph/2"><tt>lgraphs:lgraph/2</tt></a>)</span><span><span class="lpdoc-var">LGraph</span> is a labeled graph of <span class="lpdoc-var">term</span> terms. </span> </ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="edges_to_ugraph/2" href="ciaosearch.html#edges_to_ugraph/2">edges_to_ugraph/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>edges_to_ugraph(Edges,UGraph)</tt> </span><p>Converts <span class="lpdoc-var">Graph</span> to <span class="lpdoc-var">UGraph</span>.</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="18" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)</span><span><span class="lpdoc-var">Edges</span> is currently a term which is not a free variable. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="19" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)</span><span><span class="lpdoc-var">UGraph</span> is a free variable. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="20" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)</span><span><span class="lpdoc-var">Edges</span> is a list of <span class="lpdoc-var">pair</span>s. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="21" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)</span><span><span class="lpdoc-var">UGraph</span> is a free variable. </span> <li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="22" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)</span><span><span class="lpdoc-var">Edges</span> is a list of <span class="lpdoc-var">pair</span>s. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="23" href="ugraphs.html#ugraph/1"><tt>ugraphs:ugraph/1</tt></a>)</span><span><span class="lpdoc-var">UGraph</span> is an ugraph. </span> </ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="edges_to_lgraph/2" href="ciaosearch.html#edges_to_lgraph/2">edges_to_lgraph/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>edges_to_lgraph(Edges,LGraph)</tt> </span><p>Converts <span class="lpdoc-var">Edges</span> to <span class="lpdoc-var">LGraph</span>.</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="24" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)</span><span><span class="lpdoc-var">Edges</span> is currently a term which is not a free variable. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="25" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)</span><span><span class="lpdoc-var">LGraph</span> is a free variable. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="26" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)</span><span><span class="lpdoc-var">Edges</span> is a list of <span class="lpdoc-var">triple</span>s. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="27" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)</span><span><span class="lpdoc-var">LGraph</span> is a free variable. </span> <li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="28" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)</span><span><span class="lpdoc-var">Edges</span> is a list of <span class="lpdoc-var">triple</span>s. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="29" href="lgraphs.html#lgraph/2"><tt>lgraphs:lgraph/2</tt></a>)</span><span><span class="lpdoc-var">LGraph</span> is a labeled graph of <span class="lpdoc-var">term</span> terms. </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="pair/1" href="ciaosearch.html#pair/1">pair/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>pair(P)</tt> </span><p><span class="lpdoc-var">P</span> is a pair <tt>(_,_)</tt>.</p><ul class="lpdoc-itemize-minus"></ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">REGTYPE</span><a class="lpdoc-idx-anchor" id="triple/1" href="ciaosearch.html#triple/1">triple/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>triple(P)</tt> </span><p><span class="lpdoc-var">P</span> is a triple <tt>(_,_,_)</tt>.</p><ul class="lpdoc-itemize-minus"></ul></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>System library modules:</em><br/><a class="lpdoc-idx-anchor" id="30" href="sort.html"><tt>sort</tt></a>, <a class="lpdoc-idx-anchor" id="31" href="ugraphs.html"><tt>ugraphs</tt></a>, <a class="lpdoc-idx-anchor" id="32" href="lgraphs.html"><tt>lgraphs</tt></a>. <li><em>Packages:</em><br/><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="basicmodes_doc.html"><tt>basicmodes</tt></a>, <a class="lpdoc-idx-anchor" id="39" href="regtypes_doc.html"><tt>regtypes</tt></a>. </ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>