<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>book/src/dimension-definitions.md - fork/numbat @ v1.8.0</title>
<meta name="description" content="book/src/dimension-definitions.md in fork/numbat at v1.8.0.">
<meta property="og:title" content="book/src/dimension-definitions.md - fork/numbat @ v1.8.0">
<meta property="og:description" content="book/src/dimension-definitions.md in fork/numbat at v1.8.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.8.0" data-tip="c04afb354608ef22e475d8d6fec955ca6e823d97">
<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">David Peter</span><span class="commit-message" data-commit="dc1eeeb2ad9035ff3e775a85d66517f4b8c51dec">Rename speed =&gt; velocity</span><span class="snapshot-sha sha" data-commit="dc1eeeb2ad9035ff3e775a85d66517f4b8c51dec">dc1eeeb</span><time datetime="2023-10-11T20:21:43+02:00" title="2023-10-11 20:21:43 +0200">2023-10-11</time></p>
<header class="topbar"><details class="switcher"><summary>v1.8.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 href="/fork/numbat/ref/v1.7.0/">v1.7.0</a><a class="current" 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.8.0/tree/book/">book</a> / <a href="/fork/numbat/ref/v1.8.0/tree/book/src/">src</a> / <span class="cur">dimension-definitions.md</span></nav>
<span class="view-stats"><span>2.0 KiB</span><span>53 lines</span></span><span class="actions"><a class="raw" href="/fork/numbat/raw/99686728aec10b95f8c1dd146d79213f3221089f/book/src/dimension-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>Dimension definitions</h1>
<p>New (physical) dimensions can be introduced with the <code>dimension</code> keyword. Similar to <a href="/fork/numbat/ref/v1.8.0/blob/book/src/unit-definitions.md">units</a>, there are base dimensions (like <em>length</em>, <em>time</em> and <em>mass</em>) and dimensions that are derived from those base dimensions (like <em>momentum</em>, which is <em>mass</em> · <em>length</em> / <em>time</em>). Base dimensions are simply introduced by declaring their name:</p>
<pre>dimension Length
dimension Time
dimension Mass
</pre>
<p>Derived dimensions need to specify their relation to base dimensions (or other derived dimensions). For example:</p>
<pre>dimension Velocity = Length / Time
dimension Momentum = Mass * Velocity
dimension Force = Mass * Acceleration = Momentum / Time
dimension Energy = Momentum^2 / Mass = Mass * Velocity^2 = Force * Length
</pre>
<p>In the definition of <code>Force</code> and <code>Energy</code>, we can see that <em>alternative definitions</em> can be given. This is entirely optional. If specified, the compiler will make sure that all definitions are equivalent.</p>
<h2>Custom dimensions</h2>
<p>It is often useful to introduce 'fictional' physical dimensions. For example, we might want to do calculations with
screen resolutions and 'dot densities'. Introducing a new dimension for <em>dots</em> then allows us to define units like <code>dpi</code> without sacrificing unit safety:</p>
<pre>dimension Dot

@aliases(dots)
unit dot: Dot

unit dpi = dots / inch

fn inter_dot_spacing(resolution: Dot / Length) -&gt; Length = 1 dot / resolution

inter_dot_spacing(72 dpi) -&gt; µm  # 353 µm
</pre>
<p>There is also a shorthand notation for creating a new dimension and a corresponding
unit:</p>
<pre>unit book

@aliases(pages)
unit page

@aliases(words)
unit word

let words_per_book = 500 words/page × 300 pages/book
</pre>
<p>Here, the base unit definitions will implicitly create new dimensions which are capitalized
versions of the unit names (<code>Book</code>, <code>Page</code>, <code>Word</code>). This allows you to count books, pages
and words independently without any risk of mixing them. The <code>words_per_book</code> constant in this
examples has a type of <code>Word / Book</code>.</p>
</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>Dimension 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 (physical) dimensions can be introduced with the `dimension` keyword. Similar to [units](./unit-definitions.md), there are base dimensions (like *length*, *time* and *mass*) and dimensions that are derived from those base dimensions (like *momentum*, which is *mass* · *length* / *time*). Base dimensions are simply introduced by declaring their name:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</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="L5" href="#L5">5</a><span class="code-text"><a-p>dimension Length</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>dimension Time</a-p></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>dimension Mass</a-p></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>```</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>Derived dimensions need to specify their relation to base dimensions (or other derived dimensions). For example:</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>```</a-p><a-tl> numbat</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>dimension Velocity = Length / Time</a-p></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>dimension Momentum = Mass * Velocity</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>dimension Force = Mass * Acceleration = Momentum / Time</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>dimension Energy = Momentum^2 / Mass = Mass * Velocity^2 = Force * Length</a-p></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>```</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>In the definition of `Force` and `Energy`, we can see that *alternative definitions* can be given. This is entirely optional. If specified, the compiler will make sure that all definitions are equivalent.</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"></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-tt>Custom dimensions</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></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>It is often useful to introduce &#39;fictional&#39; physical dimensions. For example, we might want to do calculations with</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"><a-p>screen resolutions and &#39;dot densities&#39;. Introducing a new dimension for *dots* then allows us to define units like `dpi` without sacrificing unit safety:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</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="L23" href="#L23">23</a><span class="code-text"><a-p>dimension Dot</a-p></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>@aliases(dots)</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>unit dot: Dot</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></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 dpi = dots / inch</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"></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>fn inter_dot_spacing(resolution: Dot / Length) -&gt; Length = 1 dot / resolution</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>inter_dot_spacing(72 dpi) -&gt; µm  # 353 µm</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>```</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"></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>There is also a shorthand notation for creating a new dimension and a corresponding</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>unit:</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"></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><a-tl> numbat</a-tl></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>unit book</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>@aliases(pages)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>unit page</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></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>@aliases(words)</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>unit word</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"></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>let words_per_book = 500 words/page × 300 pages/book</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>```</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text">Here, the base unit definitions will implicitly create new dimensions which are capitalized</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text">versions of the unit names (`Book`, `Page`, `Word`). This allows you to count books, pages</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text">and words independently without any risk of mixing them. The `words_per_book` constant in this</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text">examples has a type of `Word / Book`.</span></span></pre></div></div>
</main>
</body>
</html>
