mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
156 lines
No EOL
12 KiB
HTML
156 lines
No EOL
12 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="next" href="CCArray1.Int.html">
|
|
<link rel="Up" href="CCArray1.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="Operations" rel="Section" href="#6_Operations">
|
|
<title>Containers doc : CCArray1.Bool</title>
|
|
</head>
|
|
<body>
|
|
<div class="navbar"> <a class="up" href="CCArray1.html" title="CCArray1">Up</a>
|
|
<a class="post" href="CCArray1.Int.html" title="CCArray1.Int">Next</a>
|
|
</div>
|
|
<h1>Module <a href="type_CCArray1.Bool.html">CCArray1.Bool</a></h1>
|
|
|
|
<pre><span class="keyword">module</span> Bool: <code class="code"><span class="keyword">sig</span></code> <a href="CCArray1.Bool.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><hr width="100%">
|
|
|
|
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">('b, [< `R | `W ])</code> t</span> = <code class="type">(int, 'b, [< `R | `W ] as 'a) <a href="CCArray1.html#TYPEarray_">CCArray1.array_</a></code> </pre>
|
|
<div class="info ">
|
|
A simple bitvector based on some integral type <code class="code"><span class="keywordsign">'</span>b</code><br>
|
|
</div>
|
|
|
|
|
|
<pre><span id="VALget"><span class="keyword">val</span> get</span> : <code class="type">('a, [< `R | `W > `R ]) <a href="CCArray1.Bool.html#TYPEt">t</a> -> int -> bool</code></pre>
|
|
<pre><span id="VALset"><span class="keyword">val</span> set</span> : <code class="type">('a, [< `R | `W > `W ]) <a href="CCArray1.Bool.html#TYPEt">t</a> -> int -> bool -> unit</code></pre>
|
|
<pre><span id="VALzeroes"><span class="keyword">val</span> zeroes</span> : <code class="type">int -> (Bigarray.int8_unsigned_elt, [< `R | `W ]) <a href="CCArray1.Bool.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALones"><span class="keyword">val</span> ones</span> : <code class="type">int -> (Bigarray.int8_unsigned_elt, [< `R | `W ]) <a href="CCArray1.Bool.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALiter_zeroes"><span class="keyword">val</span> iter_zeroes</span> : <code class="type">f:(int -> unit) -> ('a, [< `R | `W > `R ]) <a href="CCArray1.Bool.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
|
|
<code class="code">iter_ones ~f a</code> calls <code class="code">f i</code> for every index <code class="code">i</code> such that <code class="code">get a i = <span class="keyword">false</span></code><br>
|
|
</div>
|
|
|
|
<pre><span id="VALiter_ones"><span class="keyword">val</span> iter_ones</span> : <code class="type">f:(int -> unit) -> ('a, [< `R | `W > `R ]) <a href="CCArray1.Bool.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
|
|
<code class="code">iter_ones ~f a</code> calls <code class="code">f i</code> for every index <code class="code">i</code> such that <code class="code">get a i = <span class="keyword">true</span></code><br>
|
|
</div>
|
|
|
|
<pre><span id="VALcardinal"><span class="keyword">val</span> cardinal</span> : <code class="type">('a, [< `R | `W > `R ]) <a href="CCArray1.Bool.html#TYPEt">t</a> -> int</code></pre><div class="info ">
|
|
Number of ones<br>
|
|
</div>
|
|
|
|
<pre><span id="VALpp"><span class="keyword">val</span> pp</span> : <code class="type">('a, [< `R | `W > `R ]) <a href="CCArray1.Bool.html#TYPEt">t</a> <a href="CCArray1.html#TYPEprinter">CCArray1.printer</a></code></pre><div class="info ">
|
|
Print the bitvector nicely<br>
|
|
</div>
|
|
<br>
|
|
<h6 id="6_Operations">Operations</h6><br>
|
|
|
|
<pre><span id="VALor_"><span class="keyword">val</span> or_</span> : <code class="type">?res:('b, [< `R | `W > `W ] as 'a) <a href="CCArray1.Bool.html#TYPEt">t</a> -><br> ('b, [< `R | `W > `R ]) <a href="CCArray1.Bool.html#TYPEt">t</a> -><br> ('b, [< `R | `W > `R ]) <a href="CCArray1.Bool.html#TYPEt">t</a> -> ('b, 'a) <a href="CCArray1.Bool.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">or_ a b ~into</code> puts the boolean "or" of <code class="code">a</code> and <code class="code">b</code> in <code class="code">into</code>
|
|
expects <code class="code">length into = max (length a) (length b)</code><br>
|
|
<b>Raises</b> <code>WrongDimension</code> if dimensions do not match<br>
|
|
</div>
|
|
|
|
<pre><span id="VALand_"><span class="keyword">val</span> and_</span> : <code class="type">?res:('b, [< `R | `W > `W ] as 'a) <a href="CCArray1.Bool.html#TYPEt">t</a> -><br> ('b, [< `R | `W > `R ]) <a href="CCArray1.Bool.html#TYPEt">t</a> -><br> ('b, [< `R | `W > `R ]) <a href="CCArray1.Bool.html#TYPEt">t</a> -> ('b, 'a) <a href="CCArray1.Bool.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Boolean conjunction. See <code class="code"><span class="keyword">or</span></code> for the parameters<br>
|
|
</div>
|
|
|
|
<pre><span id="VALnot_"><span class="keyword">val</span> not_</span> : <code class="type">?res:('b, [< `R | `W > `W ] as 'a) <a href="CCArray1.Bool.html#TYPEt">t</a> -><br> ('b, [< `R | `W > `R ]) <a href="CCArray1.Bool.html#TYPEt">t</a> -> ('b, 'a) <a href="CCArray1.Bool.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Boolean negation (negation of a 0 becomes a 1)<br>
|
|
</div>
|
|
|
|
<pre><span id="VALmix"><span class="keyword">val</span> mix</span> : <code class="type">?res:('b, [< `R | `W > `W ] as 'a) <a href="CCArray1.Bool.html#TYPEt">t</a> -><br> ('b, [< `R | `W > `R ]) <a href="CCArray1.Bool.html#TYPEt">t</a> -><br> ('b, [< `R | `W > `R ]) <a href="CCArray1.Bool.html#TYPEt">t</a> -> ('b, 'a) <a href="CCArray1.Bool.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">mix a b ~into</code> assumes <code class="code">length a + length b = length into</code> and
|
|
mixes (interleaves) bits of <code class="code">a</code> and <code class="code">b</code> in <code class="code">into</code>.<br>
|
|
<b>Raises</b> <code>WrongDimension</code> if dimensions do not match<br>
|
|
</div>
|
|
|
|
<pre><span id="VALconvolution"><span class="keyword">val</span> convolution</span> : <code class="type">?res:('b, [< `R | `W > `W ] as 'a) <a href="CCArray1.Bool.html#TYPEt">t</a> -><br> ('b, [< `R | `W > `R ]) <a href="CCArray1.Bool.html#TYPEt">t</a> -><br> by:('b, [< `R | `W > `R ]) <a href="CCArray1.Bool.html#TYPEt">t</a> -> ('b, 'a) <a href="CCArray1.Bool.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">convolution a ~by:b ~into</code> assumes <code class="code">length into = length a >= length b</code>
|
|
and computes the boolean convolution of <code class="code">a</code> by <code class="code">b</code><br>
|
|
<b>Raises</b> <code>WrongDimension</code> if dimensions do not match<br>
|
|
</div>
|
|
</body></html> |