ocaml-containers/3.2/containers/CCVector/index.html
2021-02-01 10:58:00 -05:00

2 lines
No EOL
52 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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>CCVector (containers.CCVector)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../index.html">containers</a> &#x00BB; CCVector</nav><h1>Module <code>CCVector</code></h1><h2 id="growable,-mutable-vector"><a href="#growable,-mutable-vector" class="anchor"></a>Growable, mutable vector</h2></header><dl><dt class="spec type" id="type-ro"><a href="#type-ro" class="anchor"></a><code><span class="keyword">type</span> ro</code> = <code>[ </code><table class="variant"><tr id="type-ro.RO" class="anchored"><td class="def constructor"><a href="#type-ro.RO" class="anchor"></a><code>| </code><code>`RO</code></td></tr></table><code> ]</code></dt><dt class="spec type" id="type-rw"><a href="#type-rw" class="anchor"></a><code><span class="keyword">type</span> rw</code> = <code>[ </code><table class="variant"><tr id="type-rw.RW" class="anchored"><td class="def constructor"><a href="#type-rw.RW" class="anchor"></a><code>| </code><code>`RW</code></td></tr></table><code> ]</code></dt></dl><aside><p>Mutability is <code>rw</code> (read-write) or <code>ro</code> (read-only).</p></aside><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> <span>('a, 'mut) t</span></code></dt><dd><p>The type of a vector of elements of type <code>'a</code>, with a mutability flat <code>'mut</code>.</p></dd></dl><dl><dt class="spec type" id="type-vector"><a href="#type-vector" class="anchor"></a><code><span class="keyword">type</span> <span>'a vector</span></code><code> = <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Type synonym: a <code>'a vector</code> is mutable.</p></dd></dl><dl><dt class="spec type" id="type-ro_vector"><a href="#type-ro_vector" class="anchor"></a><code><span class="keyword">type</span> <span>'a ro_vector</span></code><code> = <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-ro">ro</a>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Alias for immutable vectors.</p><dl><dt>since</dt><dd>0.15</dd></dl></dd></dl><dl><dt class="spec type" id="type-iter"><a href="#type-iter" class="anchor"></a><code><span class="keyword">type</span> <span>'a iter</span></code><code> = <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> unit)</span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Fast internal iterator.</p><dl><dt>since</dt><dd>2.8</dd></dl></dd></dl><dl><dt class="spec type" id="type-gen"><a href="#type-gen" class="anchor"></a><code><span class="keyword">type</span> <span>'a gen</span></code><code> = unit <span>&#45;&gt;</span> <span><span class="type-var">'a</span> option</span></code></dt><dt class="spec type" id="type-equal"><a href="#type-equal" class="anchor"></a><code><span class="keyword">type</span> <span>'a equal</span></code><code> = <span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> bool</code></dt><dt class="spec type" id="type-ord"><a href="#type-ord" class="anchor"></a><code><span class="keyword">type</span> <span>'a ord</span></code><code> = <span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> int</code></dt><dt class="spec type" id="type-printer"><a href="#type-printer" class="anchor"></a><code><span class="keyword">type</span> <span>'a printer</span></code><code> = Stdlib.Format.formatter <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> unit</code></dt></dl><dl><dt class="spec value" id="val-freeze"><a href="#val-freeze" class="anchor"></a><code><span class="keyword">val</span> freeze : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-ro">ro</a>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Make an immutable vector (no copy! Don't use the old version).</p></dd></dl><dl><dt class="spec value" id="val-freeze_copy"><a href="#val-freeze_copy" class="anchor"></a><code><span class="keyword">val</span> freeze_copy : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-ro">ro</a>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Copy the vector into an immutable version.</p></dd></dl><dl><dt class="spec value" id="val-create"><a href="#val-create" class="anchor"></a><code><span class="keyword">val</span> create : unit <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Create a new, empty vector.</p></dd></dl><dl><dt class="spec value" id="val-create_with"><a href="#val-create_with" class="anchor"></a><code><span class="keyword">val</span> create_with : <span>?&#8288;capacity:int</span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Create a new vector, the value is used to enforce the type the new vector.</p><dl><dt>parameter capacity</dt><dd><p>the size of the underlying array.</p></dd></dl></dd></dl><dl><dt class="spec value" id="val-return"><a href="#val-return" class="anchor"></a><code><span class="keyword">val</span> return : <span class="type-var">'a</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Singleton vector.</p><dl><dt>since</dt><dd>0.14</dd></dl></dd></dl><dl><dt class="spec value" id="val-make"><a href="#val-make" class="anchor"></a><code><span class="keyword">val</span> make : int <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p><code>make n x</code> makes a vector of size <code>n</code>, filled with <code>x</code>.</p></dd></dl><dl><dt class="spec value" id="val-init"><a href="#val-init" class="anchor"></a><code><span class="keyword">val</span> init : int <span>&#45;&gt;</span> <span>(int <span>&#45;&gt;</span> <span class="type-var">'a</span>)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Init the vector with the given function and size.</p></dd></dl><dl><dt class="spec value" id="val-clear"><a href="#val-clear" class="anchor"></a><code><span class="keyword">val</span> clear : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Clear the content of the vector.</p></dd></dl><dl><dt class="spec value" id="val-clear_and_reset"><a href="#val-clear_and_reset" class="anchor"></a><code><span class="keyword">val</span> clear_and_reset : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Clear the content of the vector, and deallocate the underlying array, removing references to all the elements.</p><dl><dt>since</dt><dd>2.8</dd></dl></dd></dl><dl><dt class="spec value" id="val-ensure_with"><a href="#val-ensure_with" class="anchor"></a><code><span class="keyword">val</span> ensure_with : <span>init:<span class="type-var">'a</span></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> int <span>&#45;&gt;</span> unit</code></dt><dd><p>Hint to the vector that it should have at least the given capacity.</p><dl><dt>parameter init</dt><dd><p>if <code>capacity v = 0</code>, used to enforce the type of the vector (see <a href="index.html#val-create_with"><code>create_with</code></a>).</p></dd></dl><dl><dt>since</dt><dd>0.14</dd></dl></dd></dl><dl><dt class="spec value" id="val-ensure"><a href="#val-ensure" class="anchor"></a><code><span class="keyword">val</span> ensure : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> int <span>&#45;&gt;</span> unit</code></dt><dd><p>Hint to the vector that it should have at least the given capacity. Just a hint, will not be enforced if the vector is empty and <code>init</code> is not provided.</p></dd></dl><dl><dt class="spec value" id="val-is_empty"><a href="#val-is_empty" class="anchor"></a><code><span class="keyword">val</span> is_empty : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> bool</code></dt><dd><p>Is the vector empty?</p></dd></dl><dl><dt class="spec value" id="val-push"><a href="#val-push" class="anchor"></a><code><span class="keyword">val</span> push : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Add an element at the end of the vector.</p></dd></dl><dl><dt class="spec value" id="val-append"><a href="#val-append" class="anchor"></a><code><span class="keyword">val</span> append : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> unit</code></dt><dd><p><code>append a b</code> adds all elements of b to a.</p></dd></dl><dl><dt class="spec value" id="val-append_array"><a href="#val-append_array" class="anchor"></a><code><span class="keyword">val</span> append_array : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> array</span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Like <a href="index.html#val-append"><code>append</code></a>, with an array.</p></dd></dl><dl><dt class="spec value" id="val-append_iter"><a href="#val-append_iter" class="anchor"></a><code><span class="keyword">val</span> append_iter : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> <a href="index.html#type-iter">iter</a></span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Append content of iterator.</p><dl><dt>since</dt><dd>2.8</dd></dl></dd></dl><dl><dt class="spec value" id="val-append_seq"><a href="#val-append_seq" class="anchor"></a><code><span class="keyword">val</span> append_seq : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> Stdlib.Seq.t</span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Append content of iterator. Renamed from <code>append_std_seq</code> since 3.0.</p><dl><dt>since</dt><dd>3.0</dd></dl></dd></dl><dl><dt class="spec value" id="val-append_list"><a href="#val-append_list" class="anchor"></a><code><span class="keyword">val</span> append_list : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> list</span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Append content of list.</p><dl><dt>since</dt><dd>0.14</dd></dl></dd></dl><dl><dt class="spec value" id="val-append_gen"><a href="#val-append_gen" class="anchor"></a><code><span class="keyword">val</span> append_gen : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> <a href="index.html#type-gen">gen</a></span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Append content of generator.</p><dl><dt>since</dt><dd>0.20</dd></dl></dd></dl><dl><dt class="spec value" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span class="keyword">val</span> equal : <span><span class="type-var">'a</span> <a href="index.html#type-equal">equal</a></span> <span>&#45;&gt;</span> <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <a href="index.html#type-equal">equal</a></span></code></dt><dt class="spec value" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span class="keyword">val</span> compare : <span><span class="type-var">'a</span> <a href="index.html#type-ord">ord</a></span> <span>&#45;&gt;</span> <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <a href="index.html#type-ord">ord</a></span></code></dt><dd><p>Total ordering on vectors. Lexicographic comparison.</p></dd></dl><dl><dt class="spec exception" id="exception-Empty"><a href="#exception-Empty" class="anchor"></a><code><span class="keyword">exception</span> </code><code><span class="exception">Empty</span></code></dt><dd><p>Raised on empty stack.</p></dd></dl><dl><dt class="spec value" id="val-pop"><a href="#val-pop" class="anchor"></a><code><span class="keyword">val</span> pop : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> option</span></code></dt><dd><p>Remove last element, or <code>None</code>.</p></dd></dl><dl><dt class="spec value" id="val-pop_exn"><a href="#val-pop_exn" class="anchor"></a><code><span class="keyword">val</span> pop_exn : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span class="type-var">'a</span></code></dt><dd><p>Remove last element, or raise a Failure if empty.</p><dl><dt>raises Empty</dt><dd><p>on an empty vector.</p></dd></dl></dd></dl><dl><dt class="spec value" id="val-top"><a href="#val-top" class="anchor"></a><code><span class="keyword">val</span> top : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> option</span></code></dt><dd><p>Top element, if present.</p><dl><dt>since</dt><dd>0.6</dd></dl></dd></dl><dl><dt class="spec value" id="val-top_exn"><a href="#val-top_exn" class="anchor"></a><code><span class="keyword">val</span> top_exn : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span class="type-var">'a</span></code></dt><dd><p>Top element, if present.</p><dl><dt>raises Empty</dt><dd><p>on an empty vector.</p></dd></dl><dl><dt>since</dt><dd>0.6</dd></dl></dd></dl><dl><dt class="spec value" id="val-copy"><a href="#val-copy" class="anchor"></a><code><span class="keyword">val</span> copy : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Shallow copy (may give an immutable or mutable vector).</p></dd></dl><dl><dt class="spec value" id="val-truncate"><a href="#val-truncate" class="anchor"></a><code><span class="keyword">val</span> truncate : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> int <span>&#45;&gt;</span> unit</code></dt><dd><p>Truncate to the given size (remove elements above this size). Does nothing if the parameter is bigger than the current size. <code>truncate</code> was called <code>shrink</code>.</p><dl><dt>since</dt><dd>3.0</dd></dl></dd></dl><dl><dt class="spec value" id="val-shrink_to_fit"><a href="#val-shrink_to_fit" class="anchor"></a><code><span class="keyword">val</span> shrink_to_fit : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Shrink internal array to fit the size of the vector</p><dl><dt>since</dt><dd>2.8</dd></dl></dd></dl><dl><dt class="spec value" id="val-member"><a href="#val-member" class="anchor"></a><code><span class="keyword">val</span> member : <span>eq:<span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> bool)</span></span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> bool</code></dt><dd><p>Is the element a member of the vector?</p></dd></dl><dl><dt class="spec value" id="val-sort"><a href="#val-sort" class="anchor"></a><code><span class="keyword">val</span> sort : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> int)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Sort the vector, returning a copy of it that is sorted w.r.t the given ordering. The vector itself is unchanged. The underlying array of the new vector can be smaller than the original one.</p></dd></dl><dl><dt class="spec value" id="val-sort'"><a href="#val-sort'" class="anchor"></a><code><span class="keyword">val</span> sort' : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> int)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Sort the vector in place (modifying it). This function change the size of the underlying array.</p></dd></dl><dl><dt class="spec value" id="val-uniq_sort"><a href="#val-uniq_sort" class="anchor"></a><code><span class="keyword">val</span> uniq_sort : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> int)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Sort the array and remove duplicates, in place (e.g. modifying the vector itself).</p></dd></dl><dl><dt class="spec value" id="val-iter"><a href="#val-iter" class="anchor"></a><code><span class="keyword">val</span> iter : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> unit)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Iterate on the vector's content.</p></dd></dl><dl><dt class="spec value" id="val-iteri"><a href="#val-iteri" class="anchor"></a><code><span class="keyword">val</span> iteri : <span>(int <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> unit)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Iterate on the vector, with indexes.</p></dd></dl><dl><dt class="spec value" id="val-map"><a href="#val-map" class="anchor"></a><code><span class="keyword">val</span> map : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span>)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Map elements of the vector, yielding a new vector.</p></dd></dl><dl><dt class="spec value" id="val-mapi"><a href="#val-mapi" class="anchor"></a><code><span class="keyword">val</span> mapi : <span>(int <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span>)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p><code>map f v</code> is just like <a href="index.html#val-map"><code>map</code></a>, but it also passes in the index of each element as the first argument to the function <code>f</code>.</p><dl><dt>since</dt><dd>2.8</dd></dl></dd></dl><dl><dt class="spec value" id="val-map_in_place"><a href="#val-map_in_place" class="anchor"></a><code><span class="keyword">val</span> map_in_place : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'a</span>)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Map elements of the vector in place</p><dl><dt>since</dt><dd>2.3</dd></dl></dd></dl><dl><dt class="spec value" id="val-filter"><a href="#val-filter" class="anchor"></a><code><span class="keyword">val</span> filter : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> bool)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Filter elements from the vector. <code>filter p v</code> leaves <code>v</code> unchanged but returns a new vector that only contains elements of <code>v</code> satisfying <code>p</code>.</p></dd></dl><dl><dt class="spec value" id="val-filter_in_place"><a href="#val-filter_in_place" class="anchor"></a><code><span class="keyword">val</span> filter_in_place : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> bool)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Filter elements from the vector in place.</p><dl><dt>since</dt><dd>3.0</dd></dl></dd></dl><dl><dt class="spec value" id="val-fold"><a href="#val-fold" class="anchor"></a><code><span class="keyword">val</span> fold : <span>(<span class="type-var">'b</span> <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span>)</span> <span>&#45;&gt;</span> <span class="type-var">'b</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span class="type-var">'b</span></code></dt><dd><p>Fold on elements of the vector</p></dd></dl><dl><dt class="spec value" id="val-exists"><a href="#val-exists" class="anchor"></a><code><span class="keyword">val</span> exists : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> bool)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> bool</code></dt><dd><p>Existential test (is there an element that satisfies the predicate?).</p></dd></dl><dl><dt class="spec value" id="val-for_all"><a href="#val-for_all" class="anchor"></a><code><span class="keyword">val</span> for_all : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> bool)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> bool</code></dt><dd><p>Universal test (do all the elements satisfy the predicate?).</p></dd></dl><dl><dt class="spec value" id="val-find"><a href="#val-find" class="anchor"></a><code><span class="keyword">val</span> find : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> bool)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> option</span></code></dt><dd><p>Find an element that satisfies the predicate.</p></dd></dl><dl><dt class="spec value" id="val-find_exn"><a href="#val-find_exn" class="anchor"></a><code><span class="keyword">val</span> find_exn : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> bool)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span class="type-var">'a</span></code></dt><dd><p>Find an element that satisfies the predicate, or</p><dl><dt>raises Not_found</dt><dd><p>if no element does.</p></dd></dl></dd></dl><dl><dt class="spec value" id="val-find_map"><a href="#val-find_map" class="anchor"></a><code><span class="keyword">val</span> find_map : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span><span class="type-var">'b</span> option</span>)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'b</span> option</span></code></dt><dd><p><code>find_map f v</code> returns the first <code>Some y = f x</code> for <code>x</code> in <code>v</code>, or <code>None</code> if <code>f x = None</code> for each <code>x</code> in <code>v</code>.</p><dl><dt>since</dt><dd>0.14</dd></dl></dd></dl><dl><dt class="spec value" id="val-filter_map"><a href="#val-filter_map" class="anchor"></a><code><span class="keyword">val</span> filter_map : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span><span class="type-var">'b</span> option</span>)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Map elements with a function, possibly filtering some of them out.</p></dd></dl><dl><dt class="spec value" id="val-filter_map_in_place"><a href="#val-filter_map_in_place" class="anchor"></a><code><span class="keyword">val</span> filter_map_in_place : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> option</span>)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Filter-map elements of the vector in place</p><dl><dt>since</dt><dd>2.3</dd></dl></dd></dl><dl><dt class="spec value" id="val-flat_map"><a href="#val-flat_map" class="anchor"></a><code><span class="keyword">val</span> flat_map : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span>)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Map each element to a sub-vector.</p></dd></dl><dl><dt class="spec value" id="val-flat_map_seq"><a href="#val-flat_map_seq" class="anchor"></a><code><span class="keyword">val</span> flat_map_seq : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span><span class="type-var">'b</span> Stdlib.Seq.t</span>)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Like <a href="index.html#val-flat_map"><code>flat_map</code></a>, but using <code>Seq</code> for intermediate collections. Renamed from <code>flat_map_std_seq</code> since 3.0.</p><dl><dt>since</dt><dd>3.0</dd></dl></dd></dl><dl><dt class="spec value" id="val-flat_map_list"><a href="#val-flat_map_list" class="anchor"></a><code><span class="keyword">val</span> flat_map_list : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span><span class="type-var">'b</span> list</span>)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Like <a href="index.html#val-flat_map"><code>flat_map</code></a>, but using <code>list</code> for intermediate collections.</p><dl><dt>since</dt><dd>0.14</dd></dl></dd></dl><dl><dt class="spec value" id="val-monoid_product"><a href="#val-monoid_product" class="anchor"></a><code><span class="keyword">val</span> monoid_product : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span> <span>&#45;&gt;</span> <span class="type-var">'c</span>)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'c</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>All combinaisons of tuples from the two vectors are passed to the function.</p><dl><dt>since</dt><dd>2.8</dd></dl></dd></dl><dl><dt class="spec value" id="val-(&gt;&gt;=)"><a href="#val-(&gt;&gt;=)" class="anchor"></a><code><span class="keyword">val</span> (&gt;&gt;=) : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span>)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Infix version of <a href="index.html#val-flat_map"><code>flat_map</code></a>.</p></dd></dl><dl><dt class="spec value" id="val-(&gt;|=)"><a href="#val-(&gt;|=)" class="anchor"></a><code><span class="keyword">val</span> (&gt;|=) : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span>)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Infix version of <a href="index.html#val-map"><code>map</code></a>.</p></dd></dl><dl><dt class="spec value" id="val-get"><a href="#val-get" class="anchor"></a><code><span class="keyword">val</span> get : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> int <span>&#45;&gt;</span> <span class="type-var">'a</span></code></dt><dd><p>Access element by its index, or</p><dl><dt>raises Invalid_argument</dt><dd><p>if bad index.</p></dd></dl></dd></dl><dl><dt class="spec value" id="val-set"><a href="#val-set" class="anchor"></a><code><span class="keyword">val</span> set : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> int <span>&#45;&gt;</span> <span class="type-var">'a</span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Modify element at given index, or</p><dl><dt>raises Invalid_argument</dt><dd><p>if bad index.</p></dd></dl></dd></dl><dl><dt class="spec value" id="val-remove_and_shift"><a href="#val-remove_and_shift" class="anchor"></a><code><span class="keyword">val</span> remove_and_shift : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> int <span>&#45;&gt;</span> unit</code></dt><dd><p><code>remove_and_shift v i</code> remove the <code>i-th</code> element from <code>v</code>. Move elements that are after the <code>i-th</code> in <code>v</code>. Preserve the order of the elements in <code>v</code>. See <a href="index.html#val-remove_unordered"><code>remove_unordered</code></a> for constant time function.</p><dl><dt>since</dt><dd>3.0</dd></dl></dd></dl><dl><dt class="spec value" id="val-remove_unordered"><a href="#val-remove_unordered" class="anchor"></a><code><span class="keyword">val</span> remove_unordered : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> int <span>&#45;&gt;</span> unit</code></dt><dd><p><code>remove_unordered v i</code> remove the <code>i-th</code> element from <code>v</code>. Does <b>NOT</b> preserve the order of the elements in <code>v</code> (might swap with the last element). See <a href="index.html#val-remove_and_shift"><code>remove_and_shift</code></a> if you want to keep the ordering.</p></dd></dl><dl><dt class="spec value" id="val-rev"><a href="#val-rev" class="anchor"></a><code><span class="keyword">val</span> rev : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Reverse the vector.</p></dd></dl><dl><dt class="spec value" id="val-rev_in_place"><a href="#val-rev_in_place" class="anchor"></a><code><span class="keyword">val</span> rev_in_place : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> unit</code></dt><dd><p>Reverse the vector in place.</p><dl><dt>since</dt><dd>0.14</dd></dl></dd></dl><dl><dt class="spec value" id="val-rev_iter"><a href="#val-rev_iter" class="anchor"></a><code><span class="keyword">val</span> rev_iter : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> unit)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> unit</code></dt><dd><p><code>rev_iter f a</code> is the same as <code>iter f (rev a)</code>, only more efficient.</p><dl><dt>since</dt><dd>0.14</dd></dl></dd></dl><dl><dt class="spec value" id="val-size"><a href="#val-size" class="anchor"></a><code><span class="keyword">val</span> size : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> int</code></dt><dd><p>Number of elements in the vector.</p></dd></dl><dl><dt class="spec value" id="val-length"><a href="#val-length" class="anchor"></a><code><span class="keyword">val</span> length : <span><span>(<span class="type-var">_</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> int</code></dt><dd><p>Synonym for <a href="index.html#val-size"><code>size</code></a>.</p></dd></dl><dl><dt class="spec value" id="val-capacity"><a href="#val-capacity" class="anchor"></a><code><span class="keyword">val</span> capacity : <span><span>(<span class="type-var">_</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> int</code></dt><dd><p>Number of elements the vector can contain without being resized.</p></dd></dl><dl><dt class="spec value" id="val-unsafe_get_array"><a href="#val-unsafe_get_array" class="anchor"></a><code><span class="keyword">val</span> unsafe_get_array : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> array</span></code></dt><dd><p>Access the underlying <b>shared</b> array (do not modify!). <code>unsafe_get_array v</code> is longer than <code>size v</code>, but elements at higher index than <code>size v</code> are undefined (do not access!).</p></dd></dl><dl><dt class="spec value" id="val-(--)"><a href="#val-(--)" class="anchor"></a><code><span class="keyword">val</span> (--) : int <span>&#45;&gt;</span> int <span>&#45;&gt;</span> <span><span>(int, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Range of integers, either ascending or descending (both included, therefore the result is never empty). Example: <code>1 -- 10</code> returns the vector <code>[1;2;3;4;5;6;7;8;9;10]</code>.</p></dd></dl><dl><dt class="spec value" id="val-(--^)"><a href="#val-(--^)" class="anchor"></a><code><span class="keyword">val</span> (--^) : int <span>&#45;&gt;</span> int <span>&#45;&gt;</span> <span><span>(int, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Range of integers, either ascending or descending, but excluding right. Example: <code>1 --^ 10</code> returns the vector <code>[1;2;3;4;5;6;7;8;9]</code>.</p><dl><dt>since</dt><dd>0.17</dd></dl></dd></dl><dl><dt class="spec value" id="val-of_array"><a href="#val-of_array" class="anchor"></a><code><span class="keyword">val</span> of_array : <span><span class="type-var">'a</span> array</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p><code>of_array a</code> returns a vector corresponding to the array <code>a</code>. Operates in <code>O(n)</code> time.</p></dd></dl><dl><dt class="spec value" id="val-of_list"><a href="#val-of_list" class="anchor"></a><code><span class="keyword">val</span> of_list : <span><span class="type-var">'a</span> list</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'mut</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dt class="spec value" id="val-to_array"><a href="#val-to_array" class="anchor"></a><code><span class="keyword">val</span> to_array : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> array</span></code></dt><dd><p><code>to_array v</code> returns an array corresponding to the vector <code>v</code>.</p></dd></dl><dl><dt class="spec value" id="val-to_list"><a href="#val-to_list" class="anchor"></a><code><span class="keyword">val</span> to_list : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> list</span></code></dt><dd><p>Return a list with the elements contained in the vector.</p></dd></dl><dl><dt class="spec value" id="val-of_iter"><a href="#val-of_iter" class="anchor"></a><code><span class="keyword">val</span> of_iter : <span>?&#8288;init:<span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> <a href="index.html#type-iter">iter</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Convert an Iterator to a vector.</p><dl><dt>since</dt><dd>2.8.1</dd></dl></dd></dl><dl><dt class="spec value" id="val-of_seq"><a href="#val-of_seq" class="anchor"></a><code><span class="keyword">val</span> of_seq : <span>?&#8288;init:<span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> Stdlib.Seq.t</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Convert an Iterator to a vector. Renamed from <code>of_std_seq</code> since 3.0.</p><dl><dt>since</dt><dd>3.0</dd></dl></dd></dl><dl><dt class="spec value" id="val-to_iter"><a href="#val-to_iter" class="anchor"></a><code><span class="keyword">val</span> to_iter : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> <a href="index.html#type-iter">iter</a></span></code></dt><dd><p>Return a <code>iter</code> with the elements contained in the vector.</p><dl><dt>since</dt><dd>2.8</dd></dl></dd></dl><dl><dt class="spec value" id="val-to_iter_rev"><a href="#val-to_iter_rev" class="anchor"></a><code><span class="keyword">val</span> to_iter_rev : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> <a href="index.html#type-iter">iter</a></span></code></dt><dd><p><code>to_iter_rev v</code> returns the sequence of elements of <code>v</code> in reverse order, that is, the last elements of <code>v</code> are iterated on first.</p><dl><dt>since</dt><dd>2.8</dd></dl></dd></dl><dl><dt class="spec value" id="val-to_seq"><a href="#val-to_seq" class="anchor"></a><code><span class="keyword">val</span> to_seq : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> Stdlib.Seq.t</span></code></dt><dd><p>Return an iterator with the elements contained in the vector. Renamed from <code>to_std_seq</code> since 3.0.</p><dl><dt>since</dt><dd>3.0</dd></dl></dd></dl><dl><dt class="spec value" id="val-to_seq_rev"><a href="#val-to_seq_rev" class="anchor"></a><code><span class="keyword">val</span> to_seq_rev : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> Stdlib.Seq.t</span></code></dt><dd><p><code>to_seq v</code> returns the sequence of elements of <code>v</code> in reverse order, that is, the last elements of <code>v</code> are iterated on first. Renamed from <code>to_std_seq</code> since 3.0.</p><dl><dt>since</dt><dd>3.0</dd></dl></dd></dl><dl><dt class="spec value" id="val-slice"><a href="#val-slice" class="anchor"></a><code><span class="keyword">val</span> slice : <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> array</span> * int * int</code></dt><dd><p>Vector as an array slice. By doing it we expose the internal array, so be careful!.</p></dd></dl><dl><dt class="spec value" id="val-slice_iter"><a href="#val-slice_iter" class="anchor"></a><code><span class="keyword">val</span> slice_iter : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> int <span>&#45;&gt;</span> int <span>&#45;&gt;</span> <span><span class="type-var">'a</span> <a href="index.html#type-iter">iter</a></span></code></dt><dd><p><code>slice_iter v start len</code> is the sequence of elements from <code>v.(start)</code> to <code>v.(start+len-1)</code>.</p><dl><dt>since</dt><dd>3.0</dd></dl></dd></dl><dl><dt class="spec value" id="val-of_gen"><a href="#val-of_gen" class="anchor"></a><code><span class="keyword">val</span> of_gen : <span>?&#8288;init:<span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> <a href="index.html#type-gen">gen</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>)</span> <a href="index.html#type-t">t</a></span></code></dt><dt class="spec value" id="val-to_gen"><a href="#val-to_gen" class="anchor"></a><code><span class="keyword">val</span> to_gen : <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> <a href="index.html#type-gen">gen</a></span></code></dt><dt class="spec value" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span class="keyword">val</span> to_string : <span>?&#8288;start:string</span> <span>&#45;&gt;</span> <span>?&#8288;stop:string</span> <span>&#45;&gt;</span> <span>?&#8288;sep:string</span> <span>&#45;&gt;</span> <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> string)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> string</code></dt><dd><p>Print the vector in a string</p><dl><dt>since</dt><dd>2.7</dd></dl></dd></dl><dl><dt class="spec value" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span class="keyword">val</span> pp : <span>?&#8288;pp_start:<span>unit <a href="index.html#type-printer">printer</a></span></span> <span>&#45;&gt;</span> <span>?&#8288;pp_stop:<span>unit <a href="index.html#type-printer">printer</a></span></span> <span>&#45;&gt;</span> <span>?&#8288;pp_sep:<span>unit <a href="index.html#type-printer">printer</a></span></span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> <a href="index.html#type-printer">printer</a></span> <span>&#45;&gt;</span> <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <a href="index.html#type-printer">printer</a></span></code></dt><dd><p><code>pp ~pp_start ~pp_stop ~pp_sep pp_item ppf v</code> formats the vector <code>v</code> on <code>ppf</code>. Each element is formatted with <code>pp_item</code>, <code>pp_start</code> is called at the beginning, <code>pp_stop</code> is called at the end, <code>pp_sep</code> is called between each elements. By defaults <code>pp_start</code> and <code>pp_stop</code> does nothing and <code>pp_sep</code> defaults to (fun out -&gt; Format.fprintf out &quot;,@ &quot;).</p></dd></dl><div><div class="spec include"><div class="doc"><p>Let operators on OCaml &gt;= 4.08.0, nothing otherwise</p><dl><dt>since</dt><dd>2.8</dd></dl><details open="open"><summary><span class="def"><code><span class="keyword">include</span> <a href="../CCShimsMkLet_/index.html#module-type-S2">CCShimsMkLet_.S2</a> <span class="keyword">with</span> <span class="keyword">type</span> <span>('a, 'e) <a href="../CCShimsMkLet_/module-type-S2/index.html#type-t_let2">t_let2</a></span> := <span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t">t</a></span></code></span></summary><dl><dt class="spec type" id="type-t_let2"><a href="#type-t_let2" class="anchor"></a><code><span class="keyword">type</span> <span>('a, 'e) t_let2</span></code></dt></dl><dl><dt class="spec value" id="val-let+"><a href="#val-let+" class="anchor"></a><code><span class="keyword">val</span> let+ : <span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t_let2">t_let2</a></span> <span>&#45;&gt;</span> <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span>)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t_let2">t_let2</a></span></code></dt><dt class="spec value" id="val-and+"><a href="#val-and+" class="anchor"></a><code><span class="keyword">val</span> and+ : <span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t_let2">t_let2</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t_let2">t_let2</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span> * <span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t_let2">t_let2</a></span></code></dt><dt class="spec value" id="val-let*"><a href="#val-let*" class="anchor"></a><code><span class="keyword">val</span> let* : <span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t_let2">t_let2</a></span> <span>&#45;&gt;</span> <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t_let2">t_let2</a></span>)</span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t_let2">t_let2</a></span></code></dt><dt class="spec value" id="val-and*"><a href="#val-and*" class="anchor"></a><code><span class="keyword">val</span> and* : <span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t_let2">t_let2</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t_let2">t_let2</a></span> <span>&#45;&gt;</span> <span><span>(<span class="type-var">'a</span> * <span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t_let2">t_let2</a></span></code></dt></dl></details></div></div></div></div></body></html>