mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
165 lines
No EOL
10 KiB
HTML
165 lines
No EOL
10 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<link rel="Start" href="index.html">
|
|
<link rel="Up" href="CCLevenshtein.html">
|
|
<link title="Index of types" rel=Appendix href="index_types.html">
|
|
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
|
|
<link title="Index of values" rel=Appendix href="index_values.html">
|
|
<link title="Index of class methods" rel=Appendix href="index_methods.html">
|
|
<link title="Index of class types" rel=Appendix href="index_class_types.html">
|
|
<link title="Index of modules" rel=Appendix href="index_modules.html">
|
|
<link title="Index of module types" rel=Appendix href="index_module_types.html">
|
|
<link title="CCVector" rel="Chapter" href="CCVector.html">
|
|
<link title="CCPrint" rel="Chapter" href="CCPrint.html">
|
|
<link title="CCError" rel="Chapter" href="CCError.html">
|
|
<link title="CCHeap" rel="Chapter" href="CCHeap.html">
|
|
<link title="CCList" rel="Chapter" href="CCList.html">
|
|
<link title="CCOpt" rel="Chapter" href="CCOpt.html">
|
|
<link title="CCPair" rel="Chapter" href="CCPair.html">
|
|
<link title="CCFun" rel="Chapter" href="CCFun.html">
|
|
<link title="CCHash" rel="Chapter" href="CCHash.html">
|
|
<link title="CCInt" rel="Chapter" href="CCInt.html">
|
|
<link title="CCBool" rel="Chapter" href="CCBool.html">
|
|
<link title="CCFloat" rel="Chapter" href="CCFloat.html">
|
|
<link title="CCArray" rel="Chapter" href="CCArray.html">
|
|
<link title="CCRef" rel="Chapter" href="CCRef.html">
|
|
<link title="CCSet" rel="Chapter" href="CCSet.html">
|
|
<link title="CCOrd" rel="Chapter" href="CCOrd.html">
|
|
<link title="CCRandom" rel="Chapter" href="CCRandom.html">
|
|
<link title="CCString" rel="Chapter" href="CCString.html">
|
|
<link title="CCHashtbl" rel="Chapter" href="CCHashtbl.html">
|
|
<link title="CCMap" rel="Chapter" href="CCMap.html">
|
|
<link title="CCFormat" rel="Chapter" href="CCFormat.html">
|
|
<link title="CCIO" rel="Chapter" href="CCIO.html">
|
|
<link title="CCInt64" rel="Chapter" href="CCInt64.html">
|
|
<link title="CCChar" rel="Chapter" href="CCChar.html">
|
|
<link title="CCResult" rel="Chapter" href="CCResult.html">
|
|
<link title="Containers" rel="Chapter" href="Containers.html">
|
|
<link title="CCKTree" rel="Chapter" href="CCKTree.html">
|
|
<link title="CCKList" rel="Chapter" href="CCKList.html">
|
|
<link title="CCLazy_list" rel="Chapter" href="CCLazy_list.html">
|
|
<link title="CCMultiMap" rel="Chapter" href="CCMultiMap.html">
|
|
<link title="CCMultiSet" rel="Chapter" href="CCMultiSet.html">
|
|
<link title="CCTrie" rel="Chapter" href="CCTrie.html">
|
|
<link title="CCFlatHashtbl" rel="Chapter" href="CCFlatHashtbl.html">
|
|
<link title="CCCache" rel="Chapter" href="CCCache.html">
|
|
<link title="CCPersistentHashtbl" rel="Chapter" href="CCPersistentHashtbl.html">
|
|
<link title="CCDeque" rel="Chapter" href="CCDeque.html">
|
|
<link title="CCFQueue" rel="Chapter" href="CCFQueue.html">
|
|
<link title="CCBV" rel="Chapter" href="CCBV.html">
|
|
<link title="CCMixtbl" rel="Chapter" href="CCMixtbl.html">
|
|
<link title="CCMixmap" rel="Chapter" href="CCMixmap.html">
|
|
<link title="CCRingBuffer" rel="Chapter" href="CCRingBuffer.html">
|
|
<link title="CCIntMap" rel="Chapter" href="CCIntMap.html">
|
|
<link title="CCPersistentArray" rel="Chapter" href="CCPersistentArray.html">
|
|
<link title="CCMixset" rel="Chapter" href="CCMixset.html">
|
|
<link title="CCHashconsedSet" rel="Chapter" href="CCHashconsedSet.html">
|
|
<link title="CCGraph" rel="Chapter" href="CCGraph.html">
|
|
<link title="CCHashSet" rel="Chapter" href="CCHashSet.html">
|
|
<link title="CCBitField" rel="Chapter" href="CCBitField.html">
|
|
<link title="CCHashTrie" rel="Chapter" href="CCHashTrie.html">
|
|
<link title="CCBloom" rel="Chapter" href="CCBloom.html">
|
|
<link title="CCWBTree" rel="Chapter" href="CCWBTree.html">
|
|
<link title="CCRAL" rel="Chapter" href="CCRAL.html">
|
|
<link title="CCAllocCache" rel="Chapter" href="CCAllocCache.html">
|
|
<link title="CCImmutArray" rel="Chapter" href="CCImmutArray.html">
|
|
<link title="CCHet" rel="Chapter" href="CCHet.html">
|
|
<link title="Containers_string" rel="Chapter" href="Containers_string.html">
|
|
<link title="CCKMP" rel="Chapter" href="CCKMP.html">
|
|
<link title="CCLevenshtein" rel="Chapter" href="CCLevenshtein.html">
|
|
<link title="CCApp_parse" rel="Chapter" href="CCApp_parse.html">
|
|
<link title="CCParse" rel="Chapter" href="CCParse.html">
|
|
<link title="CCBigstring" rel="Chapter" href="CCBigstring.html">
|
|
<link title="CCArray1" rel="Chapter" href="CCArray1.html">
|
|
<link title="CCPool" rel="Chapter" href="CCPool.html">
|
|
<link title="CCLock" rel="Chapter" href="CCLock.html">
|
|
<link title="CCSemaphore" rel="Chapter" href="CCSemaphore.html">
|
|
<link title="CCThread" rel="Chapter" href="CCThread.html">
|
|
<link title="CCBlockingQueue" rel="Chapter" href="CCBlockingQueue.html">
|
|
<link title="CCTimer" rel="Chapter" href="CCTimer.html">
|
|
<link title="Containers_advanced" rel="Chapter" href="Containers_advanced.html">
|
|
<link title="CCLinq" rel="Chapter" href="CCLinq.html">
|
|
<link title="CCBatch" rel="Chapter" href="CCBatch.html">
|
|
<link title="CCCat" rel="Chapter" href="CCCat.html">
|
|
<link title="CCMonadIO" rel="Chapter" href="CCMonadIO.html">
|
|
<link title="Containers_io_is_deprecated" rel="Chapter" href="Containers_io_is_deprecated.html">
|
|
<link title="CCUnix" rel="Chapter" href="CCUnix.html">
|
|
<link title="CCSexp" rel="Chapter" href="CCSexp.html">
|
|
<link title="CCSexpM" rel="Chapter" href="CCSexpM.html"><link title="Edit Distance" rel="Section" href="#6_EditDistance">
|
|
<link title="Automaton" rel="Section" href="#6_Automaton">
|
|
<link title="Index for one-to-many matching" rel="Section" href="#6_Indexforonetomanymatching">
|
|
<title>Containers doc : CCLevenshtein.Make</title>
|
|
</head>
|
|
<body>
|
|
<div class="navbar"> <a class="up" href="CCLevenshtein.html" title="CCLevenshtein">Up</a>
|
|
</div>
|
|
<h1>Functor <a href="type_CCLevenshtein.Make.html">CCLevenshtein.Make</a></h1>
|
|
|
|
<pre><span class="keyword">module</span> Make <code class="code">(</code><code class="code"><span class="constructor">Str</span></code><code class="code"> : </code><code class="type"><a href="CCLevenshtein.STRING.html">STRING</a></code><code class="code">) </code>: <code class="type"><a href="CCLevenshtein.S.html">S</a></code><code class="type">
|
|
with type string_ = Str.t
|
|
and type char_ = Str.char_</code></pre><table border="0" cellpadding="3" width="100%">
|
|
<tr>
|
|
<td align="left" valign="top" width="1%%"><b>Parameters: </b></td>
|
|
<td>
|
|
<table class="paramstable">
|
|
<tr>
|
|
<td align="center" valign="top" width="15%">
|
|
<code>Str</code></td>
|
|
<td align="center" valign="top">:</td>
|
|
<td><code class="type"><a href="CCLevenshtein.STRING.html">STRING</a></code>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr width="100%">
|
|
|
|
<pre><span id="TYPEchar_"><span class="keyword">type</span> <code class="type"></code>char_</span> </pre>
|
|
|
|
|
|
<pre><span id="TYPEstring_"><span class="keyword">type</span> <code class="type"></code>string_</span> </pre>
|
|
|
|
<br>
|
|
<h6 id="6_EditDistance">Edit Distance</h6><br>
|
|
|
|
<pre><span id="VALedit_distance"><span class="keyword">val</span> edit_distance</span> : <code class="type"><a href="CCLevenshtein.S.html#TYPEstring_">string_</a> -> <a href="CCLevenshtein.S.html#TYPEstring_">string_</a> -> int</code></pre><div class="info ">
|
|
Edition distance between two strings. This satisfies the classical
|
|
distance axioms: it is always positive, symmetric, and satisfies
|
|
the formula <code class="code">distance a b + distance b c >= distance a c</code><br>
|
|
</div>
|
|
<br>
|
|
<h6 id="6_Automaton">Automaton</h6>
|
|
An automaton, built from a string <code class="code">s</code> and a limit <code class="code">n</code>, that accepts
|
|
every string that is at distance at most <code class="code">n</code> from <code class="code">s</code>.<br>
|
|
|
|
<pre><span id="TYPEautomaton"><span class="keyword">type</span> <code class="type"></code>automaton</span> </pre>
|
|
<div class="info ">
|
|
Levenshtein automaton<br>
|
|
</div>
|
|
|
|
|
|
<pre><span id="VALof_string"><span class="keyword">val</span> of_string</span> : <code class="type">limit:int -> <a href="CCLevenshtein.S.html#TYPEstring_">string_</a> -> <a href="CCLevenshtein.S.html#TYPEautomaton">automaton</a></code></pre><div class="info ">
|
|
Build an automaton from a string, with a maximal distance <code class="code">limit</code>.
|
|
The automaton will accept strings whose <a href="CCLevenshtein.S.html#VALedit_distance"><code class="code"><span class="constructor">CCLevenshtein</span>.<span class="constructor">S</span>.edit_distance</code></a> to the
|
|
parameter is at most <code class="code">limit</code>.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALof_list"><span class="keyword">val</span> of_list</span> : <code class="type">limit:int -> <a href="CCLevenshtein.S.html#TYPEchar_">char_</a> list -> <a href="CCLevenshtein.S.html#TYPEautomaton">automaton</a></code></pre><div class="info ">
|
|
Build an automaton from a list, with a maximal distance <code class="code">limit</code><br>
|
|
</div>
|
|
|
|
<pre><span id="VALdebug_print"><span class="keyword">val</span> debug_print</span> : <code class="type">(Pervasives.out_channel -> <a href="CCLevenshtein.S.html#TYPEchar_">char_</a> -> unit) -><br> Pervasives.out_channel -> <a href="CCLevenshtein.S.html#TYPEautomaton">automaton</a> -> unit</code></pre><div class="info ">
|
|
Output the automaton's structure on the given channel.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALmatch_with"><span class="keyword">val</span> match_with</span> : <code class="type"><a href="CCLevenshtein.S.html#TYPEautomaton">automaton</a> -> <a href="CCLevenshtein.S.html#TYPEstring_">string_</a> -> bool</code></pre><div class="info ">
|
|
<code class="code">match_with a s</code> matches the string <code class="code">s</code> against <code class="code">a</code>, and returns
|
|
<code class="code"><span class="keyword">true</span></code> if the distance from <code class="code">s</code> to the word represented by <code class="code">a</code> is smaller
|
|
than the limit used to build <code class="code">a</code><br>
|
|
</div>
|
|
<br>
|
|
<h6 id="6_Indexforonetomanymatching">Index for one-to-many matching</h6><br>
|
|
|
|
<pre><span class="keyword">module</span> <a href="CCLevenshtein.S.Index.html">Index</a>: <code class="code"><span class="keyword">sig</span></code> <a href="CCLevenshtein.S.Index.html">..</a> <code class="code"><span class="keyword">end</span></code></pre></body></html> |