@ciao-lang/ts-ciao-interface

Version:

Simple Ciao interface for node.

59 lines (52 loc) • 11.4 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>A fuzzy search and word metric library — 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="strings.html">←</a><a class="lpdoc-navbutton" href="diff.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>A fuzzy search and word metric library</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 imports">Documentation on imports</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>A fuzzy search and word metric library</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#fuzzy_search"></a> <strong>Author(s):</strong> <a class="lpdoc-idx-anchor" id="Isabel Garcia-Contreras" href="ciaosearch.html#Isabel Garcia-Contreras">Isabel Garcia-Contreras</a>.<p> The <a class="lpdoc-idx-anchor" id="0" href=""><tt>fuzzy_search</tt></a> library provides a set of predicates which calculate distance between words implementing <a href="https://en.wikipedia.org/wiki/Levenshtein_distance">levenshtein</a> distance and <a href="https://en.wikipedia.org/wiki/Damerau%E2%80%93Levenshtein_distance">damerau-levenshtein</a> distance.<p>This is a simple example:<p><pre class="lpdoc-codeblock">?- levenshtein_dist(append, apend, D). D = 1 ? yes ?- levenshtein_dist(append, appedn, D). D = 2 ? yes ?- ?- damerau_lev_dist(length, lenght, D). D = 1 ? yes ?- </pre><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(fuzzy_search)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="1" href="#levenshtein_dist/3"><tt>levenshtein_dist/3</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#damerau_lev_dist/3"><tt>damerau_lev_dist/3</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#fuzzy_search/5"><tt>fuzzy_search/5</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="levenshtein_dist/3" href="ciaosearch.html#levenshtein_dist/3">levenshtein_dist/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>levenshtein_dist(Word1,Word2,Distance)</tt> </span><p>Computes the levenshtein <span class="lpdoc-var">Distance</span> between <span class="lpdoc-var">Word1</span> and <span class="lpdoc-var">Word2</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="4" href="term_typing.html#atom/1"><tt>term_typing:atom/1</tt></a>)</span><span><span class="lpdoc-var">Word1</span> is currently instantiated to an atom. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="5" href="term_typing.html#atom/1"><tt>term_typing:atom/1</tt></a>)</span><span><span class="lpdoc-var">Word2</span> is currently instantiated to an atom. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="6" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)</span><span><span class="lpdoc-var">Distance</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="7" href="term_typing.html#atom/1"><tt>term_typing:atom/1</tt></a>)</span><span><span class="lpdoc-var">Word1</span> is currently instantiated to an atom. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="8" href="term_typing.html#atom/1"><tt>term_typing:atom/1</tt></a>)</span><span><span class="lpdoc-var">Word2</span> is currently instantiated to an atom. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="9" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)</span><span><span class="lpdoc-var">Distance</span> is a number. </span> </ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="damerau_lev_dist/3" href="ciaosearch.html#damerau_lev_dist/3">damerau_lev_dist/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>damerau_lev_dist(Word1,Word2,Distance)</tt> </span><p>Computes the Damerau-Levenshtein <span class="lpdoc-var">Distance</span> between <span class="lpdoc-var">Word1</span> and <span class="lpdoc-var">Word2</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="10" href="term_typing.html#atom/1"><tt>term_typing:atom/1</tt></a>)</span><span><span class="lpdoc-var">Word1</span> is currently instantiated to an atom. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="11" href="term_typing.html#atom/1"><tt>term_typing:atom/1</tt></a>)</span><span><span class="lpdoc-var">Word2</span> is currently instantiated to an atom. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="12" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)</span><span><span class="lpdoc-var">Distance</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="13" href="term_typing.html#atom/1"><tt>term_typing:atom/1</tt></a>)</span><span><span class="lpdoc-var">Word1</span> is currently instantiated to an atom. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="14" href="term_typing.html#atom/1"><tt>term_typing:atom/1</tt></a>)</span><span><span class="lpdoc-var">Word2</span> is currently instantiated to an atom. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="15" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)</span><span><span class="lpdoc-var">Distance</span> is a number. </span> </ul></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="fuzzy_search/5" href="ciaosearch.html#fuzzy_search/5">fuzzy_search/5</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>fuzzy_search(Word,Generator,Metric,MaxDistance,Suggestion)</tt> </span><p>Proposes atoms generated by <span class="lpdoc-var">Generator</span> which have <span class="lpdoc-var">MaxDistance</span> differences with <span class="lpdoc-var">Word</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="16" href="term_typing.html#atom/1"><tt>term_typing:atom/1</tt></a>)</span><span><span class="lpdoc-var">Word</span> is currently instantiated to an atom. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="17" href="term_typing.html#atom/1"><tt>term_typing:atom/1</tt></a>)</span><span><span class="lpdoc-var">Generator</span> is currently instantiated to an atom. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="18" href="term_typing.html#atom/1"><tt>term_typing:atom/1</tt></a>)</span><span><span class="lpdoc-var">Metric</span> is currently instantiated to an atom. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="19" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)</span><span><span class="lpdoc-var">MaxDistance</span> is a number. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="20" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)</span><span><span class="lpdoc-var">Suggestion</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="21" href="term_typing.html#atom/1"><tt>term_typing:atom/1</tt></a>)</span><span><span class="lpdoc-var">Word</span> is currently instantiated to an atom. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="22" href="term_typing.html#atom/1"><tt>term_typing:atom/1</tt></a>)</span><span><span class="lpdoc-var">Generator</span> is currently instantiated to an atom. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="23" href="term_typing.html#atom/1"><tt>term_typing:atom/1</tt></a>)</span><span><span class="lpdoc-var">Metric</span> is currently instantiated to an atom. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="24" href="basic_props.html#num/1"><tt>basic_props:num/1</tt></a>)</span><span><span class="lpdoc-var">MaxDistance</span> is a number. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="25" href="term_typing.html#atom/1"><tt>term_typing:atom/1</tt></a>)</span><span><span class="lpdoc-var">Suggestion</span> is currently instantiated to an atom. </span> </ul> <em>Meta-predicate</em> with arguments: <tt>fuzzy_search(?,pred(1),pred(3),?,?)</tt>.<br/></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="26" href="lists.html"><tt>lists</tt></a>, <a class="lpdoc-idx-anchor" id="27" href="hiordlib.html"><tt>hiordlib</tt></a>. <li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="28" href="ciaosearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="29" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="30" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="31" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="32" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="33" href="ciaosearch.html#hiord"><tt>hiord</tt></a>. </ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>