Import Upstream version 20180207
[hcoop/debian/mlton.git] / doc / guide / localhost / UnsafeStructure
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>UnsafeStructure</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>UnsafeStructure</h1>
27 </div>
28 <div id="content">
29 <div id="preamble">
30 <div class="sectionbody">
31 <div class="paragraph"><p>This module is a subset of the <span class="monospaced">Unsafe</span> module provided by SML/NJ,
32 with a few extract operations for <span class="monospaced">PackWord</span> and <span class="monospaced">PackReal</span>.</p></div>
33 <div class="listingblock">
34 <div class="content"><div class="highlight"><pre><span class="k">signature</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"> </span><span class="p">=</span><span class="w"></span>
35 <span class="w"> </span><span class="k">sig</span><span class="w"></span>
36 <span class="w"> </span><span class="k">type</span><span class="w"> </span><span class="n">array</span><span class="w"></span>
37 <span class="w"> </span><span class="k">type</span><span class="w"> </span><span class="n">elem</span><span class="w"></span>
38
39 <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="n">array</span><span class="w"></span>
40 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">sub</span><span class="p">:</span><span class="w"> </span><span class="n">array</span><span class="w"> </span><span class="n">*</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">elem</span><span class="w"></span>
41 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">update</span><span class="p">:</span><span class="w"> </span><span class="n">array</span><span class="w"> </span><span class="n">*</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">elem</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>
42 <span class="w"> </span><span class="k">end</span><span class="w"></span>
43
44 <span class="k">signature</span><span class="w"> </span><span class="n">UNSAFE_MONO_VECTOR</span><span class="w"> </span><span class="p">=</span><span class="w"></span>
45 <span class="w"> </span><span class="k">sig</span><span class="w"></span>
46 <span class="w"> </span><span class="k">type</span><span class="w"> </span><span class="n">elem</span><span class="w"></span>
47 <span class="w"> </span><span class="k">type</span><span class="w"> </span><span class="n">vector</span><span class="w"></span>
48
49 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">sub</span><span class="p">:</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">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">elem</span><span class="w"></span>
50 <span class="w"> </span><span class="k">end</span><span class="w"></span>
51
52 <span class="k">signature</span><span class="w"> </span><span class="n">UNSAFE</span><span class="w"> </span><span class="p">=</span><span class="w"></span>
53 <span class="w"> </span><span class="k">sig</span><span class="w"></span>
54 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Array</span><span class="p">:</span><span class="w"></span>
55 <span class="w"> </span><span class="k">sig</span><span class="w"></span>
56 <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="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">&#39;a</span><span class="w"> </span><span class="n">array</span><span class="w"></span>
57 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">sub</span><span class="p">:</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"> </span><span class="n">array</span><span class="w"> </span><span class="n">*</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="w"></span>
58 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">update</span><span class="p">:</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"> </span><span class="n">array</span><span class="w"> </span><span class="n">*</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="w"></span>
59 <span class="w"> </span><span class="k">end</span><span class="w"></span>
60 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">CharArray</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"></span>
61 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">CharVector</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_VECTOR</span><span class="w"></span>
62 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">IntArray</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"></span>
63 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">IntVector</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_VECTOR</span><span class="w"></span>
64 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Int8Array</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"></span>
65 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Int8Vector</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_VECTOR</span><span class="w"></span>
66 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Int16Array</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"></span>
67 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Int16Vector</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_VECTOR</span><span class="w"></span>
68 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Int32Array</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"></span>
69 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Int32Vector</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_VECTOR</span><span class="w"></span>
70 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Int64Array</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"></span>
71 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Int64Vector</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_VECTOR</span><span class="w"></span>
72 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">IntInfArray</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"></span>
73 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">IntInfVector</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_VECTOR</span><span class="w"></span>
74 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">LargeIntArray</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"></span>
75 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">LargeIntVector</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_VECTOR</span><span class="w"></span>
76 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">LargeRealArray</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"></span>
77 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">LargeRealVector</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_VECTOR</span><span class="w"></span>
78 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">LargeWordArray</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"></span>
79 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">LargeWordVector</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_VECTOR</span><span class="w"></span>
80 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">RealArray</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"></span>
81 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">RealVector</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_VECTOR</span><span class="w"></span>
82 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Real32Array</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"></span>
83 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Real32Vector</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_VECTOR</span><span class="w"></span>
84 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Real64Array</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"></span>
85 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Vector</span><span class="p">:</span><span class="w"></span>
86 <span class="w"> </span><span class="k">sig</span><span class="w"></span>
87 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">sub</span><span class="p">:</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">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"></span>
88 <span class="w"> </span><span class="k">end</span><span class="w"></span>
89 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Word8Array</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"></span>
90 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Word8Vector</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_VECTOR</span><span class="w"></span>
91 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Word16Array</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"></span>
92 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Word16Vector</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_VECTOR</span><span class="w"></span>
93 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Word32Array</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"></span>
94 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Word32Vector</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_VECTOR</span><span class="w"></span>
95 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Word64Array</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_ARRAY</span><span class="w"></span>
96 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">Word64Vector</span><span class="p">:</span><span class="w"> </span><span class="n">UNSAFE_MONO_VECTOR</span><span class="w"></span>
97
98 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">PackReal32Big</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">PACK_REAL</span><span class="w"></span>
99 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">PackReal32Little</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">PACK_REAL</span><span class="w"></span>
100 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">PackReal64Big</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">PACK_REAL</span><span class="w"></span>
101 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">PackReal64Little</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">PACK_REAL</span><span class="w"></span>
102 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">PackRealBig</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">PACK_REAL</span><span class="w"></span>
103 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">PackRealLittle</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">PACK_REAL</span><span class="w"></span>
104 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">PackWord16Big</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">PACK_WORD</span><span class="w"></span>
105 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">PackWord16Little</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">PACK_WORD</span><span class="w"></span>
106 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">PackWord32Big</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">PACK_WORD</span><span class="w"></span>
107 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">PackWord32Little</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">PACK_WORD</span><span class="w"></span>
108 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">PackWord64Big</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">PACK_WORD</span><span class="w"></span>
109 <span class="w"> </span><span class="k">structure</span><span class="w"> </span><span class="n">PackWord64Little</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">PACK_WORD</span><span class="w"></span>
110 <span class="w"> </span><span class="k">end</span><span class="w"></span>
111 </pre></div></div></div>
112 </div>
113 </div>
114 </div>
115 <div id="footnotes"><hr></div>
116 <div id="footer">
117 <div id="footer-text">
118 </div>
119 <div id="footer-badges">
120 </div>
121 </div>
122 </body>
123 </html>