<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>book/src/unit-definitions.md - fork/numbat @ v1.7.0</title>
<meta name="description" content="book/src/unit-definitions.md in fork/numbat at v1.7.0.">
<meta property="og:title" content="book/src/unit-definitions.md - fork/numbat @ v1.7.0">
<meta property="og:description" content="book/src/unit-definitions.md in fork/numbat at v1.7.0.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="v1.7.0" data-tip="bbb855bc9bf1f01c8d99861f5b828043e21f799a">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/numbat</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/numbat</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">0xflotus</span><span class="commit-message" data-commit="5d936d06df1892ff5b3e3142bbe45ebea2a1fdae">Update unit-definitions.md</span><span class="snapshot-sha sha" data-commit="5d936d06df1892ff5b3e3142bbe45ebea2a1fdae">5d936d0</span><time datetime="2023-09-27T14:40:13+02:00" title="2023-09-27 14:40:13 +0200">2023-09-27</time></p>
<header class="topbar"><details class="switcher"><summary>v1.7.0</summary><div class="menu"><strong>branches</strong><a href="/fork/numbat/ref/master/">master</a><strong>tags</strong><a href="/fork/numbat/ref/v1.6.0/">v1.6.0</a><a href="/fork/numbat/ref/v1.6.1/">v1.6.1</a><a href="/fork/numbat/ref/v1.6.2/">v1.6.2</a><a href="/fork/numbat/ref/v1.6.3/">v1.6.3</a><a class="current" href="/fork/numbat/ref/v1.7.0/">v1.7.0</a><a href="/fork/numbat/ref/v1.8.0/">v1.8.0</a><a class="all" href="/fork/numbat/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/numbat/">numbat</a> / <a href="/fork/numbat/ref/v1.7.0/tree/book/">book</a> / <a href="/fork/numbat/ref/v1.7.0/tree/book/src/">src</a> / <span class="cur">unit-definitions.md</span></nav>
<span class="view-stats"><span>3.0 KiB</span><span>71 lines</span></span><span class="actions"><a class="raw" href="/fork/numbat/raw/50adee687544711650fcc67d41007db55eb8b18c/book/src/unit-definitions.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Unit definitions</h1>
<p>New units of measurement can be introduced with the <code>unit</code> keyword. There are two types of units: base units and derived units.</p>
<p>A new <strong>base unit</strong> can be defined by specifying the <em>physical dimension</em> it represents. For example, in the
<a href="https://en.wikipedia.org/wiki/International_System_of_Units">International System of Units (SI)</a>, the <em>second</em> is the base unit for measuring times:</p>
<pre>unit second: Time
</pre>
<p>Here, <code>Time</code> denotes the physical dimension. To learn more, you can read the <a href="/fork/numbat/ref/v1.7.0/blob/book/src/dimension-definitions.md">corresponding chapter</a>. But for now, we can just assume that they are already given.</p>
<p><strong>Derived units</strong> are also introduced with the <code>unit</code> keyword. But unlike base units, they are defined through their relation to
other units. For example, a <em>minute</em> can be defined as</p>
<pre>unit minute: Time = 60 second
</pre>
<p>Here, the <code>: Time</code> annotation is optional. If a dimension is specified, it will be used to verify that the right hand side expression (<code>60 second</code>) is indeed of physical dimension <code>Time</code>. This is apparent in this simple example, but can be useful for more complicated unit definitions like</p>
<pre>unit farad: Capacitance = ampere^2 second^4 / (kilogram meter^2)
</pre>
<h2>Prefixes</h2>
<p>If a unit may be used with metric prefixes such as <code>milli</code>/<code>m</code>, <code>kilo</code>/<code>k</code> or <code>mega</code>/<code>M</code>, we can prepend the unit definition with the <code>@metric_prefixes</code> decorator:</p>
<pre>@metric_prefixes
unit second: Time
</pre>
<p>This allows identifiers such as <code>millisecond</code> to be used in calculations. See the section below how prefixes interact with aliases.</p>
<p>Similarly, if a unit should be prependable with <em>binary</em> (IEC) prefixes such as <code>kibi</code>/<code>Ki</code>, <code>mebi</code>/<code>Mi</code> or <code>gibi</code>/<code>Gi</code>, you can
add the <code>@binary_prefixes</code> decorator. A unit might also allow for both metric and binary prefixes, for example:</p>
<pre>@binary_prefixes
@metric_prefixes
unit byte = 8 bit
</pre>
<p>This allows the usage of both <code>mebibyte</code> (1024² byte) as well as <code>megabyte</code> (1000² byte).</p>
<h2>Aliases</h2>
<p>It is often useful to define alternative names for a unit. For example, we might want to use the plural form <code>seconds</code> or the commonly
used short version <code>s</code>. We can use the <code>@aliases</code> decorator to specify them:</p>
<pre>@metric_prefixes
@aliases(meters, metre, metres, m: short)
unit meter: Length
</pre>
<p>In addition to the name, we can also specify how aliases interact with prefixes using <code>: long</code> (the default), <code>: short</code>, <code>: both</code> or
<code>: none</code>. The actual unit name (<code>meter</code>) and all <code>long</code> aliases will accept the long version of prefixes (..., <code>milli</code>, <code>kilo</code>, <code>mega</code>, <code>giga</code>, ...).
All <code>short</code> aliases (<code>m</code> in the example above) will only accept the respective short versions of the prefixes (..., <code>m</code>, <code>k</code>, <code>M</code>, <code>G</code>, ...).
Aliases annotated with <code>: both</code> or <code>: none</code> accept either both long <em>and</em> short prefixes, or none of them.
The unit definition above allows all of following expressions:</p>
<pre>millimeter
kilometer

millimeters
kilometers

millimetre
kilometre

millimetres
kilometres

mm
km
...
</pre>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Unit definitions</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">New units of measurement can be introduced with the `unit` keyword. There are two types of units: base units and derived units.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">A new **base unit** can be defined by specifying the *physical dimension* it represents. For example, in the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"> [International System of Units (SI)](https://en.wikipedia.org/wiki/International_System_of_Units), the *second* is the base unit for measuring times:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>```</a-p><a-tl> numbat</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>unit second: Time</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>Here, `Time` denotes the physical dimension. To learn more, you can read the [corresponding chapter](dimension-definitions.md). But for now, we can just assume that they are already given.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>**Derived units** are also introduced with the `unit` keyword. But unlike base units, they are defined through their relation to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>other units. For example, a *minute* can be defined as</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>```</a-p><a-tl> numbat</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>unit minute: Time = 60 second</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>Here, the `: Time` annotation is optional. If a dimension is specified, it will be used to verify that the right hand side expression (`60 second`) is indeed of physical dimension `Time`. This is apparent in this simple example, but can be useful for more complicated unit definitions like</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>```</a-p><a-tl> numbat</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>unit farad: Capacitance = ampere^2 second^4 / (kilogram meter^2)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>## </a-p><a-tt>Prefixes</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>If a unit may be used with metric prefixes such as `milli`/`m`, `kilo`/`k` or `mega`/`M`, we can prepend the unit definition with the `@metric_prefixes` decorator:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>```</a-p><a-tl> numbat</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>@metric_prefixes</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>unit second: Time</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>This allows identifiers such as `millisecond` to be used in calculations. See the section below how prefixes interact with aliases.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>Similarly, if a unit should be prependable with *binary* (IEC) prefixes such as `kibi`/`Ki`, `mebi`/`Mi` or `gibi`/`Gi`, you can</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>add the `@binary_prefixes` decorator. A unit might also allow for both metric and binary prefixes, for example:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>```</a-p><a-tl> numbat</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>@binary_prefixes</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>@metric_prefixes</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>unit byte = 8 bit</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>This allows the usage of both `mebibyte` (1024² byte) as well as `megabyte` (1000² byte).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>## </a-p><a-tt>Aliases</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>It is often useful to define alternative names for a unit. For example, we might want to use the plural form `seconds` or the commonly</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>used short version `s`. We can use the `@aliases` decorator to specify them:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>```</a-p><a-tl> numbat</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>@metric_prefixes</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>@aliases(meters, metre, metres, m: short)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>unit meter: Length</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>In addition to the name, we can also specify how aliases interact with prefixes using `: long` (the default), `: short`, `: both` or</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>`: none`. The actual unit name (`meter`) and all `long` aliases will accept the long version of prefixes (..., `milli`, `kilo`, `mega`, `giga`, ...).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>All `short` aliases (`m` in the example above) will only accept the respective short versions of the prefixes (..., `m`, `k`, `M`, `G`, ...).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>Aliases annotated with `: both` or `: none` accept either both long *and* short prefixes, or none of them.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>The unit definition above allows all of following expressions:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>```</a-p><a-tl> numbat</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>millimeter</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>kilometer</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>millimeters</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>kilometers</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>millimetre</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>kilometre</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>millimetres</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>kilometres</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>mm</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>km</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>...</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
