Import Upstream version 20180207
[hcoop/debian/mlton.git] / doc / guide / localhost / MLtonReal
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>MLtonReal</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>MLtonReal</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_REAL</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">type</span><span class="w"> </span><span class="n">t</span><span class="w"></span>\r
35\r
36<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">fromWord</span><span class="p">:</span><span class="w"> </span><span class="n">word</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">t</span><span class="w"></span>\r
37<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">fromLargeWord</span><span class="p">:</span><span class="w"> </span><span class="n">LargeWord</span><span class="p">.</span><span class="n">word</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">t</span><span class="w"></span>\r
38<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">toWord</span><span class="p">:</span><span class="w"> </span><span class="n">IEEEReal</span><span class="p">.</span><span class="n">rounding_mode</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">word</span><span class="w"></span>\r
39<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">toLargeWord</span><span class="p">:</span><span class="w"> </span><span class="n">IEEEReal</span><span class="p">.</span><span class="n">rounding_mode</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">LargeWord</span><span class="p">.</span><span class="n">word</span><span class="w"></span>\r
40<span class="w"> </span><span class="k">end</span><span class="w"></span>\r
41</pre></div></div></div>\r
42<div class="ulist"><ul>\r
43<li>\r
44<p>\r
45<span class="monospaced">type t</span>\r
46</p>\r
47<div class="paragraph"><p>the type of reals. For <span class="monospaced">MLton.LargeReal</span> this is <span class="monospaced">LargeReal.real</span>,\r
48for <span class="monospaced">MLton.Real</span> this is <span class="monospaced">Real.real</span>, for <span class="monospaced">MLton.Real32</span> this is\r
49<span class="monospaced">Real32.real</span>, for <span class="monospaced">MLton.Real64</span> this is <span class="monospaced">Real64.real</span>.</p></div>\r
50</li>\r
51<li>\r
52<p>\r
53<span class="monospaced">fromWord w</span>\r
54</p>\r
55</li>\r
56<li>\r
57<p>\r
58<span class="monospaced">fromLargeWord w</span>\r
59</p>\r
60<div class="paragraph"><p>convert the word <span class="monospaced">w</span> to a real value. If the value of <span class="monospaced">w</span> is larger\r
61than (the appropriate) <span class="monospaced">REAL.maxFinite</span>, then infinity is returned.\r
62If <span class="monospaced">w</span> cannot be exactly represented as a real value, then the current\r
63rounding mode is used to determine the resulting value.</p></div>\r
64</li>\r
65<li>\r
66<p>\r
67<span class="monospaced">toWord mode r</span>\r
68</p>\r
69</li>\r
70<li>\r
71<p>\r
72<span class="monospaced">toLargeWord mode r</span>\r
73</p>\r
74<div class="paragraph"><p>convert the argument <span class="monospaced">r</span> to a word type using the specified rounding\r
75mode. They raise <span class="monospaced">Overflow</span> if the result is not representable, in\r
76particular, if <span class="monospaced">r</span> is an infinity. They raise <span class="monospaced">Domain</span> if <span class="monospaced">r</span> is NaN.</p></div>\r
77</li>\r
78<li>\r
79<p>\r
80<span class="monospaced">MLton.Real32.castFromWord w</span>\r
81</p>\r
82</li>\r
83<li>\r
84<p>\r
85<span class="monospaced">MLton.Real64.castFromWord w</span>\r
86</p>\r
87<div class="paragraph"><p>convert the argument <span class="monospaced">w</span> to a real type as a bit-wise cast.</p></div>\r
88</li>\r
89<li>\r
90<p>\r
91<span class="monospaced">MLton.Real32.castToWord r</span>\r
92</p>\r
93</li>\r
94<li>\r
95<p>\r
96<span class="monospaced">MLton.Real64.castToWord r</span>\r
97</p>\r
98<div class="paragraph"><p>convert the argument <span class="monospaced">r</span> to a word type as a bit-wise cast.</p></div>\r
99</li>\r
100</ul></div>\r
101</div>\r
102</div>\r
103</div>\r
104<div id="footnotes"><hr></div>\r
105<div id="footer">\r
106<div id="footer-text">\r
107</div>\r
108<div id="footer-badges">\r
109</div>\r
110</div>\r
111</body>\r
112</html>\r