mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
5 lines
No EOL
4.9 KiB
HTML
5 lines
No EOL
4.9 KiB
HTML
<!DOCTYPE html>
|
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>1-A (containers.CCRingBuffer.MakeFromArray.1-A)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../../index.html">containers</a></span></nav><header><h1><span class="keyword">Parameter</span> <span class="module-path">CCRingBuffer.MakeFromArray.1-A</span></h1></header><div class="spec type" id="type-elt"><a href="#type-elt" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>elt</code><code></code><code></code></div><div class="doc"><p>The element type</p></div></div><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code></code><code></code></div><div class="doc"><p>The type of an array instance</p></div></div><div class="spec val" id="val-create"><a href="#val-create" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>create : int <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Make an array of the given size, filled with dummy elements.</p></div></div><div class="spec val" id="val-length"><a href="#val-length" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>length : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p><code class="code">length t</code> gets the total number of elements currently in <code class="code">t</code>.</p></div></div><div class="spec val" id="val-get"><a href="#val-get" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> <a href="index.html#type-elt">elt</a></code></div><div class="doc"><p><code class="code">get t i</code> gets the element at position <code class="code">i</code>.</p></div></div><div class="spec val" id="val-set"><a href="#val-set" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>set : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> <a href="index.html#type-elt">elt</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">set t i e</code> sets the element at position <code class="code">i</code> to <code class="code">e</code>.</p></div></div><div class="spec val" id="val-sub"><a href="#val-sub" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>sub : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> int <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">sub t i len</code> gets the sub-array of <code class="code">t</code> from
|
|
position <code class="code">i</code> to <code class="code">i + len</code>.</p></div></div><div class="spec val" id="val-copy"><a href="#val-copy" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>copy : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">copy t</code> makes a fresh copy of the array <code class="code">t</code>.</p></div></div><div class="spec val" id="val-blit"><a href="#val-blit" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>blit : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> int <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">blit t s arr i len</code> copies <code class="code">len</code> elements from <code class="code">arr</code> starting at <code class="code">i</code>
|
|
to position <code class="code">s</code> from <code class="code">t</code>.</p></div></div><div class="spec val" id="val-iter"><a href="#val-iter" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>iter : (<a href="index.html#type-elt">elt</a> <span class="keyword">‑></span> unit) <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">iter f t</code> iterates over the array <code class="code">t</code> invoking <code class="code">f</code> with
|
|
the current element, in array order.</p></div></div></body></html> |