1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="generator" content="AsciiDoc 8.6.8">
<title>TipsForWritingConciseSML</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css">
<link rel="stylesheet" href="./pygments.css" type="text/css">
<script type="text/javascript" src="./asciidoc.js"></script>
<script type="text/javascript">
/*<![CDATA[*/
asciidoc.install();
/*]]>*/
</script>
<link rel="stylesheet" href="./mlton.css" type="text/css"/>
</head>
<body class="article">
<div id="banner">
<div id="banner-home">
<a href="./Home">MLton 20130715</a>
</div>
</div>
<div id="header">
<h1>TipsForWritingConciseSML</h1>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph"><p>SML is a rich enough language that there are often several ways to
express things. This page contains miscellaneous tips (ideas not
rules) for writing concise SML. The metric that we are interested in
here is the number of tokens or words (rather than the number of
lines, for example).</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_datatypes_in_signatures">Datatypes in Signatures</h2>
<div class="sectionbody">
<div class="paragraph"><p>A seemingly frequent source of repetition in SML is that of datatype
definitions in signatures and structures. Actually, it isn’t
repetition at all. A datatype specification in a signature, such as,</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">signature</span><span class="w"> </span><span class="n">EXP</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="k">sig</span><span class="w"></span>
<span class="w"> </span><span class="k">datatype</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">Fn</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">id</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">App</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">Var</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">id</span><span class="w"></span>
<span class="k">end</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>is just a specification of a datatype that may be matched by multiple
(albeit identical) datatype declarations. For example, in</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">structure</span><span class="w"> </span><span class="n">AnExp</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">EXP</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="k">struct</span><span class="w"></span>
<span class="w"> </span><span class="k">datatype</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">Fn</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">id</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">App</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">Var</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">id</span><span class="w"></span>
<span class="k">end</span><span class="w"></span>
<span class="k">structure</span><span class="w"> </span><span class="n">AnotherExp</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">EXP</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="k">struct</span><span class="w"></span>
<span class="w"> </span><span class="k">datatype</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">Fn</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">id</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">App</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">Var</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">id</span><span class="w"></span>
<span class="k">end</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>the types <span class="monospaced">AnExp.exp</span> and <span class="monospaced">AnotherExp.exp</span> are two distinct types. If
such <a href="GenerativeDatatype">generativity</a> isn’t desired or needed, you
can avoid the repetition:</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">structure</span><span class="w"> </span><span class="n">Exp</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="k">struct</span><span class="w"></span>
<span class="w"> </span><span class="k">datatype</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">Fn</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">id</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">App</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">Var</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">id</span><span class="w"></span>
<span class="k">end</span><span class="w"></span>
<span class="k">signature</span><span class="w"> </span><span class="n">EXP</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="k">sig</span><span class="w"></span>
<span class="w"> </span><span class="k">datatype</span><span class="w"> </span><span class="n">exp</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="k">datatype</span><span class="w"> </span><span class="n">Exp</span><span class="p">.</span><span class="n">exp</span><span class="w"></span>
<span class="k">end</span><span class="w"></span>
<span class="k">structure</span><span class="w"> </span><span class="n">Exp</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">EXP</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="k">struct</span><span class="w"></span>
<span class="w"> </span><span class="k">open</span><span class="w"> </span><span class="n">Exp</span><span class="w"></span>
<span class="k">end</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>Keep in mind that this isn’t semantically equivalent to the original.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_clausal_function_definitions">Clausal Function Definitions</h2>
<div class="sectionbody">
<div class="paragraph"><p>The syntax of clausal function definitions is rather repetitive. For
example,</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">fun</span><span class="w"> </span><span class="n">isSome</span><span class="w"> </span><span class="n">NONE</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">false</span><span class="w"></span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">isSome</span><span class="w"> </span><span class="p">(</span><span class="n">SOME</span><span class="w"> </span><span class="p">_)</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">true</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>is more verbose than</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">val</span><span class="w"> </span><span class="n">isSome</span><span class="w"> </span><span class="p">=</span><span class="w"></span>
<span class="w"> </span><span class="k">fn</span><span class="w"> </span><span class="n">NONE</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="n">false</span><span class="w"></span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">SOME</span><span class="w"> </span><span class="p">_</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="n">true</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>For recursive functions the break-even point is one clause higher. For example,</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">fun</span><span class="w"> </span><span class="n">fib</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="mi">0</span><span class="w"></span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">fib</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="mi">1</span><span class="w"></span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">fib</span><span class="w"> </span><span class="n">n</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">fib</span><span class="w"> </span><span class="p">(</span><span class="n">n-</span><span class="mi">1</span><span class="p">)</span><span class="w"> </span><span class="n">+</span><span class="w"> </span><span class="n">fib</span><span class="w"> </span><span class="p">(</span><span class="n">n-</span><span class="mi">2</span><span class="p">)</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>isn’t less verbose than</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">val</span><span class="w"> </span><span class="k">rec</span><span class="w"> </span><span class="n">fib</span><span class="w"> </span><span class="p">=</span><span class="w"></span>
<span class="w"> </span><span class="k">fn</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="mi">0</span><span class="w"></span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="mi">1</span><span class="w"></span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">n</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="n">fib</span><span class="w"> </span><span class="p">(</span><span class="n">n-</span><span class="mi">1</span><span class="p">)</span><span class="w"> </span><span class="n">+</span><span class="w"> </span><span class="n">fib</span><span class="w"> </span><span class="p">(</span><span class="n">n-</span><span class="mi">2</span><span class="p">)</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>It is quite often the case that a curried function primarily examines
just one of its arguments. Such functions can be written particularly
concisely by making the examined argument last. For example, instead
of</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">fun</span><span class="w"> </span><span class="n">eval</span><span class="w"> </span><span class="p">(</span><span class="n">Fn</span><span class="w"> </span><span class="p">(</span><span class="n">v</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">))</span><span class="w"> </span><span class="n">env</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">...</span><span class="w"></span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">eval</span><span class="w"> </span><span class="p">(</span><span class="n">App</span><span class="w"> </span><span class="p">(</span><span class="n">f</span><span class="p">,</span><span class="w"> </span><span class="n">a</span><span class="p">)</span><span class="w"> </span><span class="n">env</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">...</span><span class="w"></span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">eval</span><span class="w"> </span><span class="p">(</span><span class="n">Var</span><span class="w"> </span><span class="n">v</span><span class="p">)</span><span class="w"> </span><span class="n">env</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">...</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>consider writing</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">fun</span><span class="w"> </span><span class="n">eval</span><span class="w"> </span><span class="n">env</span><span class="w"> </span><span class="p">=</span><span class="w"></span>
<span class="w"> </span><span class="k">fn</span><span class="w"> </span><span class="n">Fn</span><span class="w"> </span><span class="p">(</span><span class="n">v</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">)</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">...</span><span class="w"></span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">App</span><span class="w"> </span><span class="p">(</span><span class="n">f</span><span class="p">,</span><span class="w"> </span><span class="n">a</span><span class="p">)</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">...</span><span class="w"></span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">Var</span><span class="w"> </span><span class="n">v</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">...</span><span class="w"></span>
</pre></div></div></div>
</div>
</div>
<div class="sect1">
<h2 id="_parentheses">Parentheses</h2>
<div class="sectionbody">
<div class="paragraph"><p>It is a good idea to avoid using lots of irritating superfluous
parentheses. An important rule to know is that prefix function
application in SML has higher precedence than any infix operator. For
example, the outer parentheses in</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="p">(</span><span class="n">square</span><span class="w"> </span><span class="p">(</span><span class="mi">5</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><span class="n">+</span><span class="w"> </span><span class="p">(</span><span class="n">square</span><span class="w"> </span><span class="p">(</span><span class="mi">5</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="mi">2</span><span class="p">))</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>are superfluous.</p></div>
<div class="paragraph"><p>People trained in other languages often use superfluous parentheses in
a number of places. In particular, the parentheses in the following
examples are practically always superfluous and are best avoided:</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">condition</span><span class="p">)</span><span class="w"> </span><span class="k">then</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="p">...</span><span class="w"></span>
<span class="k">while</span><span class="w"> </span><span class="p">(</span><span class="n">condition</span><span class="p">)</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="p">...</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>The same basically applies to case expressions:</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">case</span><span class="w"> </span><span class="p">(</span><span class="n">expression</span><span class="p">)</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="p">...</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>It is not uncommon to match a tuple of two or more values:</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">case</span><span class="w"> </span><span class="p">(</span><span class="n">a</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">)</span><span class="w"> </span><span class="k">of</span><span class="w"></span>
<span class="w"> </span><span class="p">(</span><span class="n">A1</span><span class="p">,</span><span class="w"> </span><span class="n">B1</span><span class="p">)</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">...</span><span class="w"></span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="p">(</span><span class="n">A2</span><span class="p">,</span><span class="w"> </span><span class="n">B2</span><span class="p">)</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">...</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>Such case expressions can be written more concisely with an
<a href="ProductType">infix product constructor</a>:</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">case</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">&</span><span class="w"> </span><span class="n">b</span><span class="w"> </span><span class="k">of</span><span class="w"></span>
<span class="w"> </span><span class="n">A1</span><span class="w"> </span><span class="n">&</span><span class="w"> </span><span class="n">B1</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">...</span><span class="w"></span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">A2</span><span class="w"> </span><span class="n">&</span><span class="w"> </span><span class="n">B2</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">...</span><span class="w"></span>
</pre></div></div></div>
</div>
</div>
<div class="sect1">
<h2 id="_conditionals">Conditionals</h2>
<div class="sectionbody">
<div class="paragraph"><p>Repeated sequences of conditionals such as</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">if</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="n"><</span><span class="w"> </span><span class="n">y</span><span class="w"> </span><span class="k">then</span><span class="w"> </span><span class="p">...</span><span class="w"></span>
<span class="k">else</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">y</span><span class="w"> </span><span class="k">then</span><span class="w"> </span><span class="p">...</span><span class="w"></span>
<span class="k">else</span><span class="w"> </span><span class="p">...</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>can often be written more concisely as case expressions such as</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">case</span><span class="w"> </span><span class="n">Int</span><span class="p">.</span><span class="n">compare</span><span class="w"> </span><span class="p">(</span><span class="n">x</span><span class="p">,</span><span class="w"> </span><span class="n">y</span><span class="p">)</span><span class="w"> </span><span class="k">of</span><span class="w"></span>
<span class="w"> </span><span class="n">LESS</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">...</span><span class="w"></span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">EQUAL</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">...</span><span class="w"></span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">GREATER</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">...</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>For a custom comparison, you would then define an appropriate datatype
and a reification function. An alternative to using datatypes is to
use dispatch functions</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="n">comparing</span><span class="w"> </span><span class="p">(</span><span class="n">x</span><span class="p">,</span><span class="w"> </span><span class="n">y</span><span class="p">)</span><span class="w"></span>
<span class="p">{</span><span class="n">lt</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="k">fn</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="w"></span>
<span class="w"> </span><span class="n">eq</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="k">fn</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="w"></span>
<span class="w"> </span><span class="n">gt</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="k">fn</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="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>where</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">fun</span><span class="w"> </span><span class="n">comparing</span><span class="w"> </span><span class="p">(</span><span class="n">x</span><span class="p">,</span><span class="w"> </span><span class="n">y</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="n">lt</span><span class="p">,</span><span class="w"> </span><span class="n">eq</span><span class="p">,</span><span class="w"> </span><span class="n">gt</span><span class="p">}</span><span class="w"> </span><span class="p">=</span><span class="w"></span>
<span class="w"> </span><span class="p">(</span><span class="k">case</span><span class="w"> </span><span class="n">Int</span><span class="p">.</span><span class="n">compare</span><span class="w"> </span><span class="p">(</span><span class="n">x</span><span class="p">,</span><span class="w"> </span><span class="n">y</span><span class="p">)</span><span class="w"> </span><span class="k">of</span><span class="w"></span>
<span class="w"> </span><span class="n">LESS</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="n">lt</span><span class="w"></span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">EQUAL</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="n">eq</span><span class="w"></span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">GREATER</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="n">gt</span><span class="p">)</span><span class="w"> </span><span class="p">()</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>An advantage is that no datatype definition is needed. A disadvantage
is that you can’t combine multiple dispatch results easily.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_command_query_fusion">Command-Query Fusion</h2>
<div class="sectionbody">
<div class="paragraph"><p>Many are familiar with the
<a href="http://en.wikipedia.org/wiki/Command-Query_Separation">Command-Query
Separation Principle</a>. Adhering to the principle, a signature for an
imperative stack might contain specifications</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">val</span><span class="w"> </span><span class="n">isEmpty</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">'a</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">bool</span><span class="w"></span>
<span class="k">val</span><span class="w"> </span><span class="n">pop</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">'a</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">'a</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>and use of a stack would look like</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">if</span><span class="w"> </span><span class="n">isEmpty</span><span class="w"> </span><span class="n">stack</span><span class="w"></span>
<span class="k">then</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">pop</span><span class="w"> </span><span class="n">stack</span><span class="w"> </span><span class="p">...</span><span class="w"></span>
<span class="k">else</span><span class="w"> </span><span class="p">...</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>or, when the element needs to be named,</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">if</span><span class="w"> </span><span class="n">isEmpty</span><span class="w"> </span><span class="n">stack</span><span class="w"></span>
<span class="k">then</span><span class="w"> </span><span class="k">let</span><span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">elem</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">pop</span><span class="w"> </span><span class="n">stack</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="k">end</span><span class="w"></span>
<span class="k">else</span><span class="w"> </span><span class="p">...</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>For efficiency, correctness, and conciseness, it is often better to
combine the query and command and return the result as an option:</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">val</span><span class="w"> </span><span class="n">pop</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">'a</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">'a</span><span class="w"> </span><span class="n">option</span><span class="w"></span>
</pre></div></div></div>
<div class="paragraph"><p>A use of a stack would then look like this:</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="k">case</span><span class="w"> </span><span class="n">pop</span><span class="w"> </span><span class="n">stack</span><span class="w"> </span><span class="k">of</span><span class="w"></span>
<span class="w"> </span><span class="n">NONE</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">...</span><span class="w"></span>
<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">SOME</span><span class="w"> </span><span class="n">elem</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">...</span><span class="w"></span>
</pre></div></div></div>
</div>
</div>
</div>
<div id="footnotes"><hr></div>
<div id="footer">
<div id="footer-text">
</div>
<div id="footer-badges">
</div>
</div>
</body>
</html>
|