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