mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
125 lines
No EOL
8.7 KiB
HTML
125 lines
No EOL
8.7 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="previous" href="Containers.Char.html">
|
|
<link rel="next" href="Containers.Float.html">
|
|
<link rel="Up" href="Containers.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="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="CCParse" rel="Chapter" href="CCParse.html">
|
|
<link title="CCArray_slice" rel="Chapter" href="CCArray_slice.html">
|
|
<link title="CCListLabels" rel="Chapter" href="CCListLabels.html">
|
|
<link title="CCArrayLabels" rel="Chapter" href="CCArrayLabels.html">
|
|
<link title="CCEqual" rel="Chapter" href="CCEqual.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="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="CCWBTree" rel="Chapter" href="CCWBTree.html">
|
|
<link title="CCRAL" rel="Chapter" href="CCRAL.html">
|
|
<link title="CCImmutArray" rel="Chapter" href="CCImmutArray.html">
|
|
<link title="CCHet" rel="Chapter" href="CCHet.html">
|
|
<link title="CCZipper" rel="Chapter" href="CCZipper.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="CCUnix" rel="Chapter" href="CCUnix.html">
|
|
<link title="CCSexp" rel="Chapter" href="CCSexp.html">
|
|
<link title="CCSexp_lex" rel="Chapter" href="CCSexp_lex.html"><title>Containers doc : Containers.Equal</title>
|
|
</head>
|
|
<body>
|
|
<div class="navbar"><a class="pre" href="Containers.Char.html" title="Containers.Char">Previous</a>
|
|
<a class="up" href="Containers.html" title="Containers">Up</a>
|
|
<a class="post" href="Containers.Float.html" title="Containers.Float">Next</a>
|
|
</div>
|
|
<h1>Module <a href="type_Containers.Equal.html">Containers.Equal</a></h1>
|
|
|
|
<pre><span class="keyword">module</span> Equal: <code class="type"><a href="CCEqual.html">CCEqual</a></code></pre><hr width="100%">
|
|
|
|
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">'a</code> t</span> = <code class="type">'a -> 'a -> bool</code> </pre>
|
|
<div class="info ">
|
|
Equality function. Must be transitive, symmetric, and reflexive.<br>
|
|
</div>
|
|
|
|
|
|
<pre><span id="VALpoly"><span class="keyword">val</span> poly</span> : <code class="type">'a <a href="CCEqual.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Standard polymorphic equality<br>
|
|
</div>
|
|
|
|
<pre><span id="VALint"><span class="keyword">val</span> int</span> : <code class="type">int <a href="CCEqual.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALstring"><span class="keyword">val</span> string</span> : <code class="type">string <a href="CCEqual.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALbool"><span class="keyword">val</span> bool</span> : <code class="type">bool <a href="CCEqual.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALfloat"><span class="keyword">val</span> float</span> : <code class="type">float <a href="CCEqual.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALunit"><span class="keyword">val</span> unit</span> : <code class="type">unit <a href="CCEqual.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALlist"><span class="keyword">val</span> list</span> : <code class="type">'a <a href="CCEqual.html#TYPEt">t</a> -> 'a list <a href="CCEqual.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALarray"><span class="keyword">val</span> array</span> : <code class="type">'a <a href="CCEqual.html#TYPEt">t</a> -> 'a array <a href="CCEqual.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALoption"><span class="keyword">val</span> option</span> : <code class="type">'a <a href="CCEqual.html#TYPEt">t</a> -> 'a option <a href="CCEqual.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALpair"><span class="keyword">val</span> pair</span> : <code class="type">'a <a href="CCEqual.html#TYPEt">t</a> -> 'b <a href="CCEqual.html#TYPEt">t</a> -> ('a * 'b) <a href="CCEqual.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALtriple"><span class="keyword">val</span> triple</span> : <code class="type">'a <a href="CCEqual.html#TYPEt">t</a> -> 'b <a href="CCEqual.html#TYPEt">t</a> -> 'c <a href="CCEqual.html#TYPEt">t</a> -> ('a * 'b * 'c) <a href="CCEqual.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALmap"><span class="keyword">val</span> map</span> : <code class="type">('a -> 'b) -> 'b <a href="CCEqual.html#TYPEt">t</a> -> 'a <a href="CCEqual.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">map f eq</code> is the equality function that, given objects <code class="code">x</code> and <code class="code">y</code>,
|
|
projects <code class="code">x</code> and <code class="code">y</code> using <code class="code">f</code> (e.g. using a record field) and then
|
|
compares those projections with <code class="code">eq</code>.
|
|
Example:
|
|
<code class="code">map fst int</code> compares values of type <code class="code">(int * <span class="keywordsign">'</span>a)</code> by their
|
|
first component.<br>
|
|
</div>
|
|
|
|
<pre><span id="VAL(>|=)"><span class="keyword">val</span> (>|=)</span> : <code class="type">'b <a href="CCEqual.html#TYPEt">t</a> -> ('a -> 'b) -> 'a <a href="CCEqual.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Infix equivalent of <a href="CCEqual.html#VALmap"><code class="code"><span class="constructor">CCEqual</span>.map</code></a><br>
|
|
</div>
|
|
|
|
<pre><span class="keyword">module</span> <a href="CCEqual.Infix.html">Infix</a>: <code class="code"><span class="keyword">sig</span></code> <a href="CCEqual.Infix.html">..</a> <code class="code"><span class="keyword">end</span></code></pre></body></html> |