doc/guide/localhost/MLtonIntInf

   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>MLtonIntInf</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>MLtonIntInf</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_INT_INF</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><span class="p">=</span><span class="w"> </span><span class="n">IntInf</span><span class="p">.</span><span class="n">int</span><span class="w"></span>
  35
  36 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">areSmall</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</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">bool</span><span class="w"></span>
  37 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">gcd</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</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">t</span><span class="w"></span>
  38 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">isSmall</span><span class="p">:</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">bool</span><span class="w"></span>
  39
  40 <span class="w">      </span><span class="k">structure</span><span class="w"> </span><span class="n">BigWord</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">WORD</span><span class="w"></span>
  41 <span class="w">      </span><span class="k">structure</span><span class="w"> </span><span class="n">SmallInt</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">INTEGER</span><span class="w"></span>
  42 <span class="w">      </span><span class="k">datatype</span><span class="w"> </span><span class="n">rep</span><span class="w"> </span><span class="p">=</span><span class="w"></span>
  43 <span class="w">         </span><span class="n">Big</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">BigWord</span><span class="p">.</span><span class="n">word</span><span class="w"> </span><span class="n">vector</span><span class="w"></span>
  44 <span class="w">       </span><span class="p">|</span><span class="w"> </span><span class="n">Small</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">SmallInt</span><span class="p">.</span><span class="n">int</span><span class="w"></span>
  45 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">rep</span><span class="p">:</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">rep</span><span class="w"></span>
  46 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">fromRep</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">rep</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="n">option</span><span class="w"></span>
  47 <span class="w">   </span><span class="k">end</span><span class="w"></span>
  48 </pre></div></div></div>
  49 <div class="paragraph"><p>MLton represents an arbitrary precision integer either as an unboxed
  50 word with the bottom bit set to 1 and the top bits representing a
  51 small signed integer, or as a pointer to a vector of words, where the
  52 first word indicates the sign and the rest are the limbs of a
  53 <a href="GnuMP">GnuMP</a> big integer.</p></div>
  54 <div class="ulist"><ul>
  55 <li>
  56 <p>
  57 <span class="monospaced">type t</span>
  58 </p>
  59 <div class="paragraph"><p>the same as type <span class="monospaced">IntInf.int</span>.</p></div>
  60 </li>
  61 <li>
  62 <p>
  63 <span class="monospaced">areSmall (a, b)</span>
  64 </p>
  65 <div class="paragraph"><p>returns true iff both <span class="monospaced">a</span> and <span class="monospaced">b</span> are small.</p></div>
  66 </li>
  67 <li>
  68 <p>
  69 <span class="monospaced">gcd (a, b)</span>
  70 </p>
  71 <div class="paragraph"><p>uses the <a href="GnuMP">GnuMP&#8217;s</a> fast gcd implementation.</p></div>
  72 </li>
  73 <li>
  74 <p>
  75 <span class="monospaced">isSmall a</span>
  76 </p>
  77 <div class="paragraph"><p>returns true iff <span class="monospaced">a</span> is small.</p></div>
  78 </li>
  79 <li>
  80 <p>
  81 <span class="monospaced">BigWord : WORD</span>
  82 </p>
  83 <div class="paragraph"><p>representation of a big <span class="monospaced">IntInf.int</span> as a vector of words; on 32-bit
  84 platforms, <span class="monospaced">BigWord</span> is likely to be equivalent to <span class="monospaced">Word32</span>, and on
  85 64-bit platforms, <span class="monospaced">BigWord</span> is likely to be equivalent to <span class="monospaced">Word64</span>.</p></div>
  86 </li>
  87 <li>
  88 <p>
  89 <span class="monospaced">SmallInt : INTEGER</span>
  90 </p>
  91 <div class="paragraph"><p>representation of a small <span class="monospaced">IntInf.int</span> as a signed integer; on 32-bit
  92 platforms, <span class="monospaced">SmallInt</span> is likely to be equivalent to <span class="monospaced">Int32</span>, and on
  93 64-bit platforms, <span class="monospaced">SmallInt</span> is likely to be equivalent to <span class="monospaced">Int64</span>.</p></div>
  94 </li>
  95 <li>
  96 <p>
  97 <span class="monospaced">datatype rep</span>
  98 </p>
  99 <div class="paragraph"><p>the underlying representation of an <span class="monospaced">IntInf.int</span>.</p></div>
 100 </li>
 101 <li>
 102 <p>
 103 <span class="monospaced">rep i</span>
 104 </p>
 105 <div class="paragraph"><p>returns the underlying representation of <span class="monospaced">i</span>.</p></div>
 106 </li>
 107 <li>
 108 <p>
 109 <span class="monospaced">fromRep r</span>
 110 </p>
 111 <div class="paragraph"><p>converts from the underlying representation back to an <span class="monospaced">IntInf.int</span>.
 112 If <span class="monospaced">fromRep r</span> is given anything besides the valid result of <span class="monospaced">rep i</span>
 113 for some <span class="monospaced">i</span>, this function call will return <span class="monospaced">NONE</span>.</p></div>
 114 </li>
 115 </ul></div>
 116 </div>
 117 </div>
 118 </div>
 119 <div id="footnotes"><hr></div>
 120 <div id="footer">
 121 <div id="footer-text">
 122 </div>
 123 <div id="footer-badges">
 124 </div>
 125 </div>
 126 </body>
 127 </html>