doc/guide/localhost/MLtonReal

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