simon/ocaml-containers
1
0
Fork 0
mirror of https://github.com/c-cube/ocaml-containers.git synced 2025-12-06 03:05:28 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
ocaml-containers/3.12/containers/Containers/index.html
Simon Cruanes 08ba10786d
doc for 3.12
2023-06-01 16:44:06 -04:00

2 lines
No EOL
17 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Containers (containers.Containers)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">containers</a> &#x00BB; Containers</nav><header class="odoc-preamble"><h1>Module <code><span>Containers</span></code></h1><p>Drop-In replacement to Stdlib</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Array"><a href="#module-Array" class="anchor"></a><code><span><span class="keyword">module</span> Array</span><span> = <a href="../CCArray/index.html">CCArray</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Bool"><a href="#module-Bool" class="anchor"></a><code><span><span class="keyword">module</span> Bool</span><span> = <a href="../CCBool/index.html">CCBool</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Byte_buffer"><a href="#module-Byte_buffer" class="anchor"></a><code><span><span class="keyword">module</span> Byte_buffer</span><span> = <a href="../CCByte_buffer/index.html">CCByte_buffer</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Char"><a href="#module-Char" class="anchor"></a><code><span><span class="keyword">module</span> Char</span><span> = <a href="../CCChar/index.html">CCChar</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Equal"><a href="#module-Equal" class="anchor"></a><code><span><span class="keyword">module</span> Equal</span><span> = <a href="../CCEqual/index.html">CCEqual</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Either"><a href="#module-Either" class="anchor"></a><code><span><span class="keyword">module</span> Either</span><span> = <a href="../CCEither/index.html">CCEither</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Float"><a href="#module-Float" class="anchor"></a><code><span><span class="keyword">module</span> Float</span><span> = <a href="../CCFloat/index.html">CCFloat</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Format"><a href="#module-Format" class="anchor"></a><code><span><span class="keyword">module</span> Format</span><span> = <a href="../CCFormat/index.html">CCFormat</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Fun"><a href="#module-Fun" class="anchor"></a><code><span><span class="keyword">module</span> Fun</span><span> = <a href="../CCFun/index.html">CCFun</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Hash"><a href="#module-Hash" class="anchor"></a><code><span><span class="keyword">module</span> Hash</span><span> = <a href="../CCHash/index.html">CCHash</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Hashtbl"><a href="#module-Hashtbl" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Hashtbl/index.html">Hashtbl</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Heap"><a href="#module-Heap" class="anchor"></a><code><span><span class="keyword">module</span> Heap</span><span> = <a href="../CCHeap/index.html">CCHeap</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Int"><a href="#module-Int" class="anchor"></a><code><span><span class="keyword">module</span> Int</span><span> = <a href="../CCInt/index.html">CCInt</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Int32"><a href="#module-Int32" class="anchor"></a><code><span><span class="keyword">module</span> Int32</span><span> = <a href="../CCInt32/index.html">CCInt32</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Int64"><a href="#module-Int64" class="anchor"></a><code><span><span class="keyword">module</span> Int64</span><span> = <a href="../CCInt64/index.html">CCInt64</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-IO"><a href="#module-IO" class="anchor"></a><code><span><span class="keyword">module</span> IO</span><span> = <a href="../CCIO/index.html">CCIO</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-List"><a href="#module-List" class="anchor"></a><code><span><span class="keyword">module</span> List</span><span> = <a href="../CCList/index.html">CCList</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Map"><a href="#module-Map" class="anchor"></a><code><span><span class="keyword">module</span> Map</span><span> = <a href="../CCMap/index.html">CCMap</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Nativeint"><a href="#module-Nativeint" class="anchor"></a><code><span><span class="keyword">module</span> Nativeint</span><span> = <a href="../CCNativeint/index.html">CCNativeint</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Option"><a href="#module-Option" class="anchor"></a><code><span><span class="keyword">module</span> Option</span><span> = <a href="../CCOption/index.html">CCOption</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Ord"><a href="#module-Ord" class="anchor"></a><code><span><span class="keyword">module</span> Ord</span><span> = <a href="../CCOrd/index.html">CCOrd</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Pair"><a href="#module-Pair" class="anchor"></a><code><span><span class="keyword">module</span> Pair</span><span> = <a href="../CCPair/index.html">CCPair</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Parse"><a href="#module-Parse" class="anchor"></a><code><span><span class="keyword">module</span> Parse</span><span> = <a href="../CCParse/index.html">CCParse</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Random"><a href="#module-Random" class="anchor"></a><code><span><span class="keyword">module</span> Random</span><span> = <a href="../CCRandom/index.html">CCRandom</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Ref"><a href="#module-Ref" class="anchor"></a><code><span><span class="keyword">module</span> Ref</span><span> = <a href="../CCRef/index.html">CCRef</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Result"><a href="#module-Result" class="anchor"></a><code><span><span class="keyword">module</span> Result</span><span> = <a href="../CCResult/index.html">CCResult</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Seq"><a href="#module-Seq" class="anchor"></a><code><span><span class="keyword">module</span> Seq</span><span> = <a href="../CCSeq/index.html">CCSeq</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Set"><a href="#module-Set" class="anchor"></a><code><span><span class="keyword">module</span> Set</span><span> = <a href="../CCSet/index.html">CCSet</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-String"><a href="#module-String" class="anchor"></a><code><span><span class="keyword">module</span> String</span><span> = <a href="../CCString/index.html">CCString</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Vector"><a href="#module-Vector" class="anchor"></a><code><span><span class="keyword">module</span> Vector</span><span> = <a href="../CCVector/index.html">CCVector</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Monomorphic"><a href="#module-Monomorphic" class="anchor"></a><code><span><span class="keyword">module</span> Monomorphic</span><span> = <a href="../CCMonomorphic/index.html">CCMonomorphic</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Utf8_string"><a href="#module-Utf8_string" class="anchor"></a><code><span><span class="keyword">module</span> Utf8_string</span><span> = <a href="../CCUtf8_string/index.html">CCUtf8_string</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Unit"><a href="#module-Unit" class="anchor"></a><code><span><span class="keyword">module</span> Unit</span><span> = <a href="../CCUnit/index.html">CCUnit</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Atomic"><a href="#module-Atomic" class="anchor"></a><code><span><span class="keyword">module</span> Atomic</span><span> = <a href="../CCAtomic/index.html">CCAtomic</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Sexp"><a href="#module-Sexp" class="anchor"></a><code><span><span class="keyword">module</span> Sexp</span><span> = <a href="../CCSexp/index.html">CCSexp</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Sexp_intf"><a href="#module-Sexp_intf" class="anchor"></a><code><span><span class="keyword">module</span> Sexp_intf</span><span> = <a href="../CCSexp_intf/index.html">CCSexp_intf</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Canonical_sexp"><a href="#module-Canonical_sexp" class="anchor"></a><code><span><span class="keyword">module</span> Canonical_sexp</span><span> = <a href="../CCCanonical_sexp/index.html">CCCanonical_sexp</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Stdlib"><a href="#module-Stdlib" class="anchor"></a><code><span><span class="keyword">module</span> Stdlib</span><span> = <a href="../CCShims_/Stdlib/index.html">CCShims_.Stdlib</a></span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <span class="keyword">struct</span> <span class="keyword">include</span> <a href="../CCMonomorphic/index.html">Monomorphic</a> <span class="keyword">end</span></span></code></summary><h2 id="shadow-unsafe-functions-and-operators-from-stdlib"><a href="#shadow-unsafe-functions-and-operators-from-stdlib" class="anchor"></a>Shadow unsafe functions and operators from Stdlib</h2><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.0</li></ul><div class="odoc-spec"><div class="spec value anchored" id="val-(=)"><a href="#val-(=)" class="anchor"></a><code><span><span class="keyword">val</span> (=) : <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&lt;&gt;)"><a href="#val-(&lt;&gt;)" class="anchor"></a><code><span><span class="keyword">val</span> (&lt;&gt;) : <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&lt;)"><a href="#val-(&lt;)" class="anchor"></a><code><span><span class="keyword">val</span> (&lt;) : <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&gt;)"><a href="#val-(&gt;)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;) : <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&lt;=)"><a href="#val-(&lt;=)" class="anchor"></a><code><span><span class="keyword">val</span> (&lt;=) : <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&gt;=)"><a href="#val-(&gt;=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;=) : <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span><span class="keyword">val</span> compare : <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-min"><a href="#val-min" class="anchor"></a><code><span><span class="keyword">val</span> min : <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max"><a href="#val-max" class="anchor"></a><code><span><span class="keyword">val</span> max : <span>int <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><h3 id="infix-operators-for-floats"><a href="#infix-operators-for-floats" class="anchor"></a>Infix operators for Floats</h3><div class="odoc-spec"><div class="spec value anchored" id="val-(=.)"><a href="#val-(=.)" class="anchor"></a><code><span><span class="keyword">val</span> (=.) : <span>float <span class="arrow">&#45;&gt;</span></span> <span>float <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.1</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&lt;&gt;.)"><a href="#val-(&lt;&gt;.)" class="anchor"></a><code><span><span class="keyword">val</span> (&lt;&gt;.) : <span>float <span class="arrow">&#45;&gt;</span></span> <span>float <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.1</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&lt;.)"><a href="#val-(&lt;.)" class="anchor"></a><code><span><span class="keyword">val</span> (&lt;.) : <span>float <span class="arrow">&#45;&gt;</span></span> <span>float <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.1</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&gt;.)"><a href="#val-(&gt;.)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;.) : <span>float <span class="arrow">&#45;&gt;</span></span> <span>float <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.1</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&lt;=.)"><a href="#val-(&lt;=.)" class="anchor"></a><code><span><span class="keyword">val</span> (&lt;=.) : <span>float <span class="arrow">&#45;&gt;</span></span> <span>float <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.1</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&gt;=.)"><a href="#val-(&gt;=.)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;=.) : <span>float <span class="arrow">&#45;&gt;</span></span> <span>float <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.1</li></ul></div></div><h3 id="shadow-dangerous-operators"><a href="#shadow-dangerous-operators" class="anchor"></a>Shadow Dangerous Operators</h3><div class="odoc-spec"><div class="spec value anchored" id="val-(==)"><a href="#val-(==)" class="anchor"></a><code><span><span class="keyword">val</span> (==) : <span>[ `Consider_using_CCEqual_physical ]</span></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Please use CCEqual.physical or Stdlib.(==) instead.</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(!=)"><a href="#val-(!=)" class="anchor"></a><code><span><span class="keyword">val</span> (!=) : <span>[ `Consider_using_CCEqual_physical ]</span></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.1</li></ul><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Please use [not CCEqual.physical] or Stdlib.(!=) instead.</li></ul></div></div></details></div></div></body></html>
Reference in a new issue View git blame Copy permalink