Import Debian changes 20180207-1
[hcoop/debian/mlton.git] / doc / guide / localhost / MLtonVector
1 <!DOCTYPE html>
2 <html lang="en">
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <meta name="generator" content="AsciiDoc 8.6.9">
6 <title>MLtonVector</title>
7 <link rel="stylesheet" href="./asciidoc.css" type="text/css">
8 <link rel="stylesheet" href="./pygments.css" type="text/css">
9
10
11 <script type="text/javascript" src="./asciidoc.js"></script>
12 <script type="text/javascript">
13 /*<![CDATA[*/
14 asciidoc.install();
15 /*]]>*/
16 </script>
17 <link rel="stylesheet" href="./mlton.css" type="text/css">
18 </head>
19 <body class="article">
20 <div id="banner">
21 <div id="banner-home">
22 <a href="./Home">MLton 20180207</a>
23 </div>
24 </div>
25 <div id="header">
26 <h1>MLtonVector</h1>
27 </div>
28 <div id="content">
29 <div id="preamble">
30 <div class="sectionbody">
31 <div class="listingblock">
32 <div class="content"><div class="highlight"><pre><span class="k">signature</span><span class="w"> </span><span class="n">MLTON_VECTOR</span><span class="w"> </span><span class="p">=</span><span class="w"></span>
33 <span class="w"> </span><span class="k">sig</span><span class="w"></span>
34 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">create</span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="p">{</span><span class="n">done</span><span class="p">:</span><span class="w"> </span><span class="n">unit</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"> </span><span class="n">vector</span><span class="p">,</span><span class="w"></span>
35 <span class="w"> </span><span class="n">sub</span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">&#39;a</span><span class="p">,</span><span class="w"></span>
36 <span class="w"> </span><span class="n">update</span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="p">}</span><span class="w"></span>
37 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">unfoldi</span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">&#39;b</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="p">(</span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">&#39;b</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">&#39;b</span><span class="p">)</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"> </span><span class="n">vector</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">&#39;b</span><span class="w"></span>
38 <span class="w"> </span><span class="k">end</span><span class="w"></span>
39 </pre></div></div></div>
40 <div class="ulist"><ul>
41 <li>
42 <p>
43 <span class="monospaced">create n</span>
44 </p>
45 <div class="paragraph"><p>initiates the construction a vector <em>v</em> of length <span class="monospaced">n</span>, returning
46 functions to manipulate the vector. The <span class="monospaced">done</span> function may be called
47 to return the created vector; it is an error to call <span class="monospaced">done</span> before all
48 entries have been initialized; it is an error to call <span class="monospaced">done</span> after
49 having called <span class="monospaced">done</span>. The <span class="monospaced">sub</span> function may be called to return an
50 initialized vector entry; it is not an error to call <span class="monospaced">sub</span> after
51 having called <span class="monospaced">done</span>. The <span class="monospaced">update</span> function may be called to
52 initialize a vector entry; it is an error to call <span class="monospaced">update</span> after
53 having called <span class="monospaced">done</span>. One must initialize vector entries in order
54 from lowest to highest; that is, before calling <span class="monospaced">update (i, x)</span>, one
55 must have already called <span class="monospaced">update (j, x)</span> for all <span class="monospaced">j</span> in <span class="monospaced">[0, i)</span>. The
56 <span class="monospaced">done</span>, <span class="monospaced">sub</span>, and <span class="monospaced">update</span> functions are all constant-time
57 operations.</p></div>
58 </li>
59 <li>
60 <p>
61 <span class="monospaced">unfoldi (n, b, f)</span>
62 </p>
63 <div class="paragraph"><p>constructs a vector <em>v</em> of length <span class="monospaced">n</span>, whose elements <em>v<sub>i</sub></em> are
64 determined by the equations <em>b<sub>0</sub> = b</em> and
65 <em>(v<sub>i</sub>, b<sub>i+1</sub>) = f (i, b<sub>i</sub>)</em>.</p></div>
66 </li>
67 </ul></div>
68 </div>
69 </div>
70 </div>
71 <div id="footnotes"><hr></div>
72 <div id="footer">
73 <div id="footer-text">
74 </div>
75 <div id="footer-badges">
76 </div>
77 </div>
78 </body>
79 </html>