mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
160 lines
No EOL
9.5 KiB
HTML
160 lines
No EOL
9.5 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="CCHashSet.html">
|
|
<link rel="next" href="CCHashTrie.html">
|
|
<link rel="Up" href="index.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"><title>Containers doc : CCBitField</title>
|
|
</head>
|
|
<body>
|
|
<div class="navbar"><a class="pre" href="CCHashSet.html" title="CCHashSet">Previous</a>
|
|
<a class="up" href="index.html" title="Index">Up</a>
|
|
<a class="post" href="CCHashTrie.html" title="CCHashTrie">Next</a>
|
|
</div>
|
|
<h1>Module <a href="type_CCBitField.html">CCBitField</a></h1>
|
|
|
|
<pre><span class="keyword">module</span> CCBitField: <code class="code"><span class="keyword">sig</span></code> <a href="CCBitField.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
|
|
<h1 id="1_BitField">Bit Field</h1>
|
|
<p>
|
|
|
|
This module defines efficient bitfields
|
|
up to 30 or 62 bits (depending on the architecture) in
|
|
a relatively type-safe way.
|
|
<p>
|
|
|
|
<pre class="codepre"><code class="code"><span class="keyword">module</span> <span class="constructor">B</span> = <span class="constructor">CCBitField</span>.<span class="constructor">Make</span>(<span class="keyword">struct</span> <span class="keyword">end</span>);;<br>
|
|
<br>
|
|
<span class="keywordsign">#</span>install_printer <span class="constructor">B</span>.pp;;<br>
|
|
<br>
|
|
<span class="keyword">module</span> <span class="constructor">X</span> = (<span class="keyword">val</span> <span class="constructor">B</span>.int ~name:<span class="string">"x"</span> ~width:3 ());;<br>
|
|
<span class="keyword">module</span> <span class="constructor">Y</span> = (<span class="keyword">val</span> <span class="constructor">B</span>.int ~name:<span class="string">"y"</span> ~width:2 ());;<br>
|
|
<span class="keyword">module</span> <span class="constructor">Z</span> = (<span class="keyword">val</span> <span class="constructor">B</span>.bool ~name:<span class="string">"z"</span> ());;<br>
|
|
<br>
|
|
<span class="keyword">let</span> f = <span class="constructor">B</span>.empty |> <span class="constructor">X</span>.set 3 |> <span class="constructor">Y</span>.set 1;;<br>
|
|
<br>
|
|
<span class="constructor">Z</span>.get f ;;<br>
|
|
<br>
|
|
f |> <span class="constructor">Z</span>.set <span class="keyword">true</span> |> <span class="constructor">Z</span>.get ;;<br>
|
|
<br>
|
|
<span class="constructor">Format</span>.printf <span class="string">"f: %a@."</span> <span class="constructor">B</span>.pp f;;<br>
|
|
<br>
|
|
</code></pre>
|
|
<p>
|
|
|
|
<b>status: experimental</b><br>
|
|
<b>Since</b> 0.13<br>
|
|
</div>
|
|
<hr width="100%">
|
|
|
|
<pre><span id="EXCEPTIONTooManyFields"><span class="keyword">exception</span> TooManyFields</span></pre>
|
|
<div class="info ">
|
|
Raised when too many fields are packed into one bitfield<br>
|
|
</div>
|
|
|
|
<pre><span id="EXCEPTIONFrozen"><span class="keyword">exception</span> Frozen</span></pre>
|
|
<div class="info ">
|
|
Raised when a frozen bitfield is modified<br>
|
|
</div>
|
|
|
|
<pre><span class="keyword">module type</span> <a href="CCBitField.EMPTY.html">EMPTY</a> = <code class="code"><span class="keyword">sig</span></code> <a href="CCBitField.EMPTY.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
|
|
Used for generativity on versions of OCaml older than 4.02
|
|
</div>
|
|
|
|
<pre><span id="VALmax_width"><span class="keyword">val</span> max_width</span> : <code class="type">int</code></pre><div class="info ">
|
|
System-dependent maximum width for a bitfield, typically 30 or 62<br>
|
|
</div>
|
|
|
|
<pre><span class="keyword">module type</span> <a href="CCBitField.S.html">S</a> = <code class="code"><span class="keyword">sig</span></code> <a href="CCBitField.S.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
|
|
Bitfield Signature
|
|
</div>
|
|
|
|
<pre><span class="keyword">module</span> <a href="CCBitField.Make.html">Make</a> <code class="code">(</code><code class="code"><span class="constructor">X</span></code><code class="code"> : </code><code class="type"><a href="CCBitField.EMPTY.html">EMPTY</a></code><code class="code">) </code>: <code class="type"><a href="CCBitField.S.html">S</a></code><code class="type"> </code></pre><div class="info">
|
|
Create a new bitfield type
|
|
</div>
|
|
</body></html> |