4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <meta name="generator" content="AsciiDoc 8.6.9">
6 <title>EqualityType</title>
7 <link rel="stylesheet" href="./asciidoc.css" type="text/css">
8 <link rel="stylesheet" href="./pygments.css" type="text/css">
11 <script type="text/javascript" src="./asciidoc.js"></script>
12 <script type="text/javascript">
17 <link rel="stylesheet" href="./mlton.css" type="text/css">
19 <body class="article">
21 <div id="banner-home">
22 <a href="./Home">MLton 20180207</a>
30 <div class="sectionbody">
31 <div class="paragraph"><p>An equality type is a type to which <a href="PolymorphicEquality">PolymorphicEquality</a> can be
32 applied. The <a href="DefinitionOfStandardML">Definition</a> and the
33 <a href="BasisLibrary">Basis Library</a> precisely spell out which types are
34 equality types.</p></div>
35 <div class="ulist"><ul>
38 <span class="monospaced">bool</span>, <span class="monospaced">char</span>, <span class="monospaced">IntInf.int</span>, <span class="monospaced">Int<em><N></em>.int</span>, <span class="monospaced">string</span>, and <span class="monospaced">Word<em><N></em>.word</span> are equality types.
43 for any <span class="monospaced">t</span>, both <span class="monospaced">t array</span> and <span class="monospaced">t ref</span> are equality types.
48 if <span class="monospaced">t</span> is an equality type, then <span class="monospaced">t list</span>, and <span class="monospaced">t vector</span> are equality types.
53 if <span class="monospaced">t1</span>, …, <span class="monospaced">tn</span> are equality types, then <span class="monospaced">t1 * ... * tn</span> and <span class="monospaced">{l1: t1, ..., ln: tn}</span> are equality types.
58 if <span class="monospaced">t1</span>, …, <span class="monospaced">tn</span> are equality types and <span class="monospaced">t</span> <a href="AdmitsEquality">AdmitsEquality</a>, then <span class="monospaced">(t1, ..., tn) t</span> is an equality type.
62 <div class="paragraph"><p>To check that a type t is an equality type, use the following idiom.</p></div>
63 <div class="listingblock">
64 <div class="content"><div class="highlight"><pre><span class="k">structure</span><span class="w"> </span><span class="n">S</span><span class="p">:</span><span class="w"> </span><span class="k">sig</span><span class="w"> </span><span class="k">eqtype</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="k">end</span><span class="w"> </span><span class="p">=</span><span class="w"></span>
65 <span class="w"> </span><span class="k">struct</span><span class="w"></span>
66 <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="p">...</span><span class="w"></span>
67 <span class="w"> </span><span class="k">end</span><span class="w"></span>
68 </pre></div></div></div>
69 <div class="paragraph"><p>Notably, <span class="monospaced">exn</span> and <span class="monospaced">real</span> are not equality types. Neither is <span class="monospaced">t1 -> t2</span>, for any <span class="monospaced">t1</span> and <span class="monospaced">t2</span>.</p></div>
70 <div class="paragraph"><p>Equality on arrays and ref cells is by identity, not structure.
71 For example, <span class="monospaced">ref 13 = ref 13</span> is <span class="monospaced">false</span>.
72 On the other hand, equality for lists, strings, and vectors is by
73 structure, not identity. For example, the following equalities hold.</p></div>
74 <div class="listingblock">
75 <div class="content"><div class="highlight"><pre><span class="k">val</span><span class="w"> </span><span class="p">_</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p">]</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="n">::</span><span class="w"> </span><span class="p">[</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p">]</span><span class="w"></span>
76 <span class="k">val</span><span class="w"> </span><span class="p">_</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">"foo"</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">concat</span><span class="w"> </span><span class="p">[</span><span class="s">"f"</span><span class="p">,</span><span class="w"> </span><span class="s">"o"</span><span class="p">,</span><span class="w"> </span><span class="s">"o"</span><span class="p">]</span><span class="w"></span>
77 <span class="k">val</span><span class="w"> </span><span class="p">_</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">Vector</span><span class="p">.</span><span class="n">fromList</span><span class="w"> </span><span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p">]</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">Vector</span><span class="p">.</span><span class="n">tabulate</span><span class="w"> </span><span class="p">(</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="k">fn</span><span class="w"> </span><span class="n">i</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="n">i</span><span class="w"> </span><span class="n">+</span><span class="w"> </span><span class="mi">1</span><span class="p">)</span><span class="w"></span>
78 </pre></div></div></div>
82 <div id="footnotes"><hr></div>
84 <div id="footer-text">
86 <div id="footer-badges">