moonpool/dev/ocaml/CamlinternalMenhirLib/InfiniteArray/index.html
2023-08-28 17:11:38 +00:00

2 lines
No EOL
3.8 KiB
HTML
Raw 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>InfiniteArray (ocaml.CamlinternalMenhirLib.InfiniteArray)</title><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><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">ocaml</a> &#x00BB; <a href="../index.html">CamlinternalMenhirLib</a> &#x00BB; InfiniteArray</nav><header class="odoc-preamble"><h1>Module <code><span>CamlinternalMenhirLib.InfiniteArray</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a t</span></span></code></div><div class="spec-doc"><p>This module implements infinite arrays. *</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>make x</code> creates an infinite array, where every slot contains <code>x</code>. *</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>get a i</code> returns the element contained at offset <code>i</code> in the array <code>a</code>. Slots are numbered 0 and up. *</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set"><a href="#val-set" class="anchor"></a><code><span><span class="keyword">val</span> set : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>set a i x</code> sets the element contained at offset <code>i</code> in the array <code>a</code> to <code>x</code>. Slots are numbered 0 and up. *</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-extent"><a href="#val-extent" class="anchor"></a><code><span><span class="keyword">val</span> extent : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p><code>extent a</code> is the length of an initial segment of the array <code>a</code> that is sufficiently large to contain all <code>set</code> operations ever performed. In other words, all elements beyond that segment have the default value.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-domain"><a href="#val-domain" class="anchor"></a><code><span><span class="keyword">val</span> domain : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> array</span></span></code></div><div class="spec-doc"><p><code>domain a</code> is a fresh copy of an initial segment of the array <code>a</code> whose length is <code>extent a</code>.</p></div></div></div></body></html>