123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793 |
- <?xml version="1.0" encoding="utf-8" ?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <!-- This file is generated by Nim. -->
- <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>std/rationals</title>
- <!-- Google fonts -->
- <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
- <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
- <!-- Favicon -->
- <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
- <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
- <!-- CSS -->
- <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
- <!-- JS -->
- <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
- </head>
- <body>
- <div class="document" id="documentId">
- <div class="container">
- <h1 class="title">std/rationals</h1>
- <div class="row">
- <div class="three columns">
- <div class="theme-select-wrapper">
- <label for="theme-select">Theme: </label>
- <select id="theme-select" onchange="setTheme(this.value)">
- <option value="auto">🌗 Match OS</option>
- <option value="dark">🌑 Dark</option>
- <option value="light">🌕 Light</option>
- </select>
- </div>
- <div id="global-links">
- <ul class="simple-boot">
- <li><a href="manual.html">Manual</a></li>
- <li><a href="lib.html">Standard library</a></li>
- <li> <a id="indexLink" href="theindex.html">Index</a></li>
- <li><a href="compiler/theindex.html">Compiler docs</a></li>
- <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
- <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
- </ul>
- </div>
- <div id="searchInputDiv">
- Search: <input type="search" id="searchInput"
- oninput="search()" />
- </div>
-
- <ul class="simple simple-toc" id="toc-list">
- <li>
- <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
- <ul class="simple simple-toc-section">
- <li><a class="reference" href="#Rational" title="Rational[T] = object
- num*, den*: T">Rational</a></li>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
- <ul class="simple simple-toc-section">
- <ul class="simple nested-toc-section">$
- <li><a class="reference" href="#%24%2CRational%5BT%5D" title="`$`[T](x: Rational[T]): string">`$`[T](x: Rational[T]): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">*
- <li><a class="reference" href="#%2A%2CRational%5BT%5D%2CRational%5BT%5D" title="`*`[T](x, y: Rational[T]): Rational[T]">`*`[T](x, y: Rational[T]): Rational[T]</a></li>
- <li><a class="reference" href="#%2A%2CRational%5BT%5D%2CT" title="`*`[T](x: Rational[T]; y: T): Rational[T]">`*`[T](x: Rational[T]; y: T): Rational[T]</a></li>
- <li><a class="reference" href="#%2A%2CT%2CRational%5BT%5D" title="`*`[T](x: T; y: Rational[T]): Rational[T]">`*`[T](x: T; y: Rational[T]): Rational[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">*=
- <li><a class="reference" href="#%2A%3D%2CRational%5BT%5D%2CRational%5BT%5D" title="`*=`[T](x: var Rational[T]; y: Rational[T])">`*=`[T](x: var Rational[T]; y: Rational[T])</a></li>
- <li><a class="reference" href="#%2A%3D%2CRational%5BT%5D%2CT" title="`*=`[T](x: var Rational[T]; y: T)">`*=`[T](x: var Rational[T]; y: T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">+
- <li><a class="reference" href="#%2B%2CRational%5BT%5D%2CRational%5BT%5D" title="`+`[T](x, y: Rational[T]): Rational[T]">`+`[T](x, y: Rational[T]): Rational[T]</a></li>
- <li><a class="reference" href="#%2B%2CRational%5BT%5D%2CT" title="`+`[T](x: Rational[T]; y: T): Rational[T]">`+`[T](x: Rational[T]; y: T): Rational[T]</a></li>
- <li><a class="reference" href="#%2B%2CT%2CRational%5BT%5D" title="`+`[T](x: T; y: Rational[T]): Rational[T]">`+`[T](x: T; y: Rational[T]): Rational[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">+=
- <li><a class="reference" href="#%2B%3D%2CRational%5BT%5D%2CRational%5BT%5D" title="`+=`[T](x: var Rational[T]; y: Rational[T])">`+=`[T](x: var Rational[T]; y: Rational[T])</a></li>
- <li><a class="reference" href="#%2B%3D%2CRational%5BT%5D%2CT" title="`+=`[T](x: var Rational[T]; y: T)">`+=`[T](x: var Rational[T]; y: T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">-
- <li><a class="reference" href="#-%2CRational%5BT%5D%2CRational%5BT%5D" title="`-`[T](x, y: Rational[T]): Rational[T]">`-`[T](x, y: Rational[T]): Rational[T]</a></li>
- <li><a class="reference" href="#-%2CRational%5BT%5D" title="`-`[T](x: Rational[T]): Rational[T]">`-`[T](x: Rational[T]): Rational[T]</a></li>
- <li><a class="reference" href="#-%2CRational%5BT%5D%2CT" title="`-`[T](x: Rational[T]; y: T): Rational[T]">`-`[T](x: Rational[T]; y: T): Rational[T]</a></li>
- <li><a class="reference" href="#-%2CT%2CRational%5BT%5D" title="`-`[T](x: T; y: Rational[T]): Rational[T]">`-`[T](x: T; y: Rational[T]): Rational[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">-=
- <li><a class="reference" href="#-%3D%2CRational%5BT%5D%2CRational%5BT%5D" title="`-=`[T](x: var Rational[T]; y: Rational[T])">`-=`[T](x: var Rational[T]; y: Rational[T])</a></li>
- <li><a class="reference" href="#-%3D%2CRational%5BT%5D%2CT" title="`-=`[T](x: var Rational[T]; y: T)">`-=`[T](x: var Rational[T]; y: T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">/
- <li><a class="reference" href="#%2F%2CRational%5BT%5D%2CRational%5BT%5D" title="`/`[T](x, y: Rational[T]): Rational[T]">`/`[T](x, y: Rational[T]): Rational[T]</a></li>
- <li><a class="reference" href="#%2F%2CRational%5BT%5D%2CT" title="`/`[T](x: Rational[T]; y: T): Rational[T]">`/`[T](x: Rational[T]; y: T): Rational[T]</a></li>
- <li><a class="reference" href="#%2F%2CT%2CRational%5BT%5D" title="`/`[T](x: T; y: Rational[T]): Rational[T]">`/`[T](x: T; y: Rational[T]): Rational[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">//
- <li><a class="reference" href="#%2F%2F%2CT%2CT" title="`//`[T](num, den: T): Rational[T]">`//`[T](num, den: T): Rational[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">/=
- <li><a class="reference" href="#%2F%3D%2CRational%5BT%5D%2CRational%5BT%5D" title="`/=`[T](x: var Rational[T]; y: Rational[T])">`/=`[T](x: var Rational[T]; y: Rational[T])</a></li>
- <li><a class="reference" href="#%2F%3D%2CRational%5BT%5D%2CT" title="`/=`[T](x: var Rational[T]; y: T)">`/=`[T](x: var Rational[T]; y: T)</a></li>
- </ul>
- <ul class="simple nested-toc-section"><
- <li><a class="reference" href="#%3C%2CRational%2CRational" title="`<`(x, y: Rational): bool">`<`(x, y: Rational): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section"><=
- <li><a class="reference" href="#%3C%3D%2CRational%2CRational" title="`<=`(x, y: Rational): bool">`<=`(x, y: Rational): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">==
- <li><a class="reference" href="#%3D%3D%2CRational%2CRational" title="`==`(x, y: Rational): bool">`==`(x, y: Rational): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">^
- <li><a class="reference" href="#%5E%2CRational%5BT%3A%20SomeInteger%5D%2CT" title="`^`[T: SomeInteger](x: Rational[T]; y: T): Rational[T]">`^`[T: SomeInteger](x: Rational[T]; y: T): Rational[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">abs
- <li><a class="reference" href="#abs%2CRational%5BT%5D" title="abs[T](x: Rational[T]): Rational[T]">abs[T](x: Rational[T]): Rational[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">cmp
- <li><a class="reference" href="#cmp%2CRational%2CRational" title="cmp(x, y: Rational): int">cmp(x, y: Rational): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">div
- <li><a class="reference" href="#div%2CRational%5BT%3A%20SomeInteger%5D%2CRational%5BT%3A%20SomeInteger%5D" title="`div`[T: SomeInteger](x, y: Rational[T]): T">`div`[T: SomeInteger](x, y: Rational[T]): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">floorDiv
- <li><a class="reference" href="#floorDiv%2CRational%5BT%3A%20SomeInteger%5D%2CRational%5BT%3A%20SomeInteger%5D" title="floorDiv[T: SomeInteger](x, y: Rational[T]): T">floorDiv[T: SomeInteger](x, y: Rational[T]): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">floorMod
- <li><a class="reference" href="#floorMod%2CRational%5BT%3A%20SomeInteger%5D%2CRational%5BT%3A%20SomeInteger%5D" title="floorMod[T: SomeInteger](x, y: Rational[T]): Rational[T]">floorMod[T: SomeInteger](x, y: Rational[T]): Rational[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">hash
- <li><a class="reference" href="#hash%2CRational%5BT%5D" title="hash[T](x: Rational[T]): Hash">hash[T](x: Rational[T]): Hash</a></li>
- </ul>
- <ul class="simple nested-toc-section">initRational
- <li><a class="reference" href="#initRational%2CT%2CT" title="initRational[T: SomeInteger](num, den: T): Rational[T]">initRational[T: SomeInteger](num, den: T): Rational[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">mod
- <li><a class="reference" href="#mod%2CRational%5BT%3A%20SomeInteger%5D%2CRational%5BT%3A%20SomeInteger%5D" title="`mod`[T: SomeInteger](x, y: Rational[T]): Rational[T]">`mod`[T: SomeInteger](x, y: Rational[T]): Rational[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">reciprocal
- <li><a class="reference" href="#reciprocal%2CRational%5BT%5D" title="reciprocal[T](x: Rational[T]): Rational[T]">reciprocal[T](x: Rational[T]): Rational[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">reduce
- <li><a class="reference" href="#reduce%2CRational%5BT%3A%20SomeInteger%5D" title="reduce[T: SomeInteger](x: var Rational[T])">reduce[T: SomeInteger](x: var Rational[T])</a></li>
- </ul>
- <ul class="simple nested-toc-section">toFloat
- <li><a class="reference" href="#toFloat%2CRational%5BT%5D" title="toFloat[T](x: Rational[T]): float">toFloat[T](x: Rational[T]): float</a></li>
- </ul>
- <ul class="simple nested-toc-section">toInt
- <li><a class="reference" href="#toInt%2CRational%5BT%5D" title="toInt[T](x: Rational[T]): int">toInt[T](x: Rational[T]): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">toRational
- <li><a class="reference" href="#toRational%2Cfloat%2Cint" title="toRational(x: float; n: int = high(int) shr 32): Rational[int]">toRational(x: float; n: int = high(int) shr 32): Rational[int]</a></li>
- <li><a class="reference" href="#toRational%2CT" title="toRational[T: SomeInteger](x: T): Rational[T]">toRational[T: SomeInteger](x: T): Rational[T]</a></li>
- </ul>
- </ul>
- </details>
- </li>
- </ul>
- </div>
- <div class="nine columns" id="content">
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L1" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
- <div id="tocRoot"></div>
-
- <p class="module-desc">This module implements rational numbers, consisting of a numerator and a denominator. The denominator can not be 0.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">rationals</span>
- <span class="Keyword">let</span>
- <span class="Identifier">r1</span> <span class="Operator">=</span> <span class="DecNumber">1</span> <span class="Operator">//</span> <span class="DecNumber">2</span>
- <span class="Identifier">r2</span> <span class="Operator">=</span> <span class="Operator">-</span><span class="DecNumber">3</span> <span class="Operator">//</span> <span class="DecNumber">4</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">r1</span> <span class="Operator">+</span> <span class="Identifier">r2</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">1</span> <span class="Operator">//</span> <span class="DecNumber">4</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">r1</span> <span class="Operator">-</span> <span class="Identifier">r2</span> <span class="Operator">==</span> <span class="DecNumber">5</span> <span class="Operator">//</span> <span class="DecNumber">4</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">r1</span> <span class="Operator">*</span> <span class="Identifier">r2</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">3</span> <span class="Operator">//</span> <span class="DecNumber">8</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">r1</span> <span class="Operator">/</span> <span class="Identifier">r2</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">2</span> <span class="Operator">//</span> <span class="DecNumber">3</span></pre></p>
- <div class="section" id="6">
- <h1><a class="toc-backref" href="#6">Imports</a></h1>
- <dl class="item">
- <a class="reference external" href="math.html">math</a>, <a class="reference external" href="hashes.html">hashes</a>, <a class="reference external" href="assertions.html">assertions</a>
- </dl>
- </div>
- <div class="section" id="7">
- <h1><a class="toc-backref" href="#7">Types</a></h1>
- <dl class="item">
- <div id="Rational">
- <dt><pre><a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> <span class="Other">=</span> <span class="Keyword">object</span>
- <span class="Identifier">num</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">den</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
- <dd>
-
- A rational number, consisting of a numerator <tt class="docutils literal"><span class="pre"><span class="Identifier">num</span></span></tt> and a denominator <tt class="docutils literal"><span class="pre"><span class="Identifier">den</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L28" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L28" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </dl>
- </div>
- <div class="section" id="12">
- <h1><a class="toc-backref" href="#12">Procs</a></h1>
- <dl class="item">
- <div id="$-procs-all">
- <div id="$,Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#%24%2CRational%5BT%5D"><span class="Identifier">`$`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
- <dd>
-
- Turns a rational number into a string.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Punctuation">(</span><span class="DecNumber">1</span> <span class="Operator">//</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"1/2"</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L71" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L71" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="*-procs-all">
- <div id="*,Rational[T],Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#%2A%2CRational%5BT%5D%2CRational%5BT%5D"><span class="Identifier">`*`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- Multiplies two rational numbers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L180" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L180" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*,Rational[T],T">
- <dt><pre><span class="Keyword">func</span> <a href="#%2A%2CRational%5BT%5D%2CT"><span class="Identifier">`*`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- Multiplies the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> with the int <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L185" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L185" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*,T,Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#%2A%2CT%2CRational%5BT%5D"><span class="Identifier">`*`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- Multiplies the int <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> with the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L190" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L190" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="*=-procs-all">
- <div id="*=,Rational[T],Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#%2A%3D%2CRational%5BT%5D%2CRational%5BT%5D"><span class="Identifier">`*=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
- <dd>
-
- Multiplies the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> by <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> in-place.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L195" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L195" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*=,Rational[T],T">
- <dt><pre><span class="Keyword">func</span> <a href="#%2A%3D%2CRational%5BT%5D%2CT"><span class="Identifier">`*=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span></pre></dt>
- <dd>
-
- Multiplies the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> by the int <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> in-place.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L201" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L201" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="+-procs-all">
- <div id="+,Rational[T],Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#%2B%2CRational%5BT%5D%2CRational%5BT%5D"><span class="Identifier">`+`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- Adds two rational numbers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L122" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L122" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,Rational[T],T">
- <dt><pre><span class="Keyword">func</span> <a href="#%2B%2CRational%5BT%5D%2CT"><span class="Identifier">`+`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- Adds the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> to the int <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L130" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L130" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,T,Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#%2B%2CT%2CRational%5BT%5D"><span class="Identifier">`+`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- Adds the int <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> to the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L134" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L134" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="+=-procs-all">
- <div id="+=,Rational[T],Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#%2B%3D%2CRational%5BT%5D%2CRational%5BT%5D"><span class="Identifier">`+=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
- <dd>
-
- Adds the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> to the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> in-place.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L138" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L138" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+=,Rational[T],T">
- <dt><pre><span class="Keyword">func</span> <a href="#%2B%3D%2CRational%5BT%5D%2CT"><span class="Identifier">`+=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span></pre></dt>
- <dd>
-
- Adds the int <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> to the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> in-place.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L145" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L145" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="--procs-all">
- <div id="-,Rational[T],Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#-%2CRational%5BT%5D%2CRational%5BT%5D"><span class="Identifier">`-`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- Subtracts two rational numbers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L153" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L153" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#-%2CRational%5BT%5D"><span class="Identifier">`-`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- Unary minus for rational numbers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L149" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L149" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,Rational[T],T">
- <dt><pre><span class="Keyword">func</span> <a href="#-%2CRational%5BT%5D%2CT"><span class="Identifier">`-`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- Subtracts the int <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> from the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L161" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L161" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,T,Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#-%2CT%2CRational%5BT%5D"><span class="Identifier">`-`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- Subtracts the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> from the int <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L165" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L165" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="-=-procs-all">
- <div id="-=,Rational[T],Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#-%3D%2CRational%5BT%5D%2CRational%5BT%5D"><span class="Identifier">`-=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
- <dd>
-
- Subtracts the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> from the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> in-place.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L169" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L169" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-=,Rational[T],T">
- <dt><pre><span class="Keyword">func</span> <a href="#-%3D%2CRational%5BT%5D%2CT"><span class="Identifier">`-=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span></pre></dt>
- <dd>
-
- Subtracts the int <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> from the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> in-place.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L176" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L176" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="/-procs-all">
- <div id="/,Rational[T],Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#%2F%2CRational%5BT%5D%2CRational%5BT%5D"><span class="Identifier">`/`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- Divides the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> by the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L216" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L216" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="/,Rational[T],T">
- <dt><pre><span class="Keyword">func</span> <a href="#%2F%2CRational%5BT%5D%2CT"><span class="Identifier">`/`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- Divides the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> by the int <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L221" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L221" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="/,T,Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#%2F%2CT%2CRational%5BT%5D"><span class="Identifier">`/`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- Divides the int <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> by the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L226" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L226" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="//-procs-all">
- <div id="//,T,T">
- <dt><pre><span class="Keyword">func</span> <a href="#%2F%2F%2CT%2CT"><span class="Identifier">`//`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">num</span><span class="Other">,</span> <span class="Identifier">den</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- A friendlier version of <a class="reference external" href="#initRational,T,T">initRational</a>.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">x</span> <span class="Operator">=</span> <span class="DecNumber">1</span> <span class="Operator">//</span> <span class="DecNumber">3</span> <span class="Operator">+</span> <span class="DecNumber">1</span> <span class="Operator">//</span> <span class="DecNumber">5</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">x</span> <span class="Operator">==</span> <span class="DecNumber">8</span> <span class="Operator">//</span> <span class="DecNumber">15</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L63" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L63" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="/=-procs-all">
- <div id="/=,Rational[T],Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#%2F%3D%2CRational%5BT%5D%2CRational%5BT%5D"><span class="Identifier">`/=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
- <dd>
-
- Divides the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> by the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> in-place.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L231" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L231" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="/=,Rational[T],T">
- <dt><pre><span class="Keyword">func</span> <a href="#%2F%3D%2CRational%5BT%5D%2CT"><span class="Identifier">`/=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span></pre></dt>
- <dd>
-
- Divides the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> by the int <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> in-place.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L237" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L237" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="<-procs-all">
- <div id="<,Rational,Rational">
- <dt><pre><span class="Keyword">func</span> <a href="#%3C%2CRational%2CRational"><span class="Identifier">`<`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
- <dd>
-
- Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is less than <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L249" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L249" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="<=-procs-all">
- <div id="<=,Rational,Rational">
- <dt><pre><span class="Keyword">func</span> <a href="#%3C%3D%2CRational%2CRational"><span class="Identifier">`<=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
- <dd>
-
- Returns tue if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is less than or equal to <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L253" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L253" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="==-procs-all">
- <div id="==,Rational,Rational">
- <dt><pre><span class="Keyword">func</span> <a href="#%3D%3D%2CRational%2CRational"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
- <dd>
-
- Compares two rationals for equality.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L257" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L257" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="^-procs-all">
- <div id="^,Rational[T: SomeInteger],T">
- <dt><pre><span class="Keyword">func</span> <a href="#%5E%2CRational%5BT%3A%20SomeInteger%5D%2CT"><span class="Identifier">`^`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- <p>Computes <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> to the power of <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.</p>
- <p>The exponent <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> must be an integer. Negative exponents are supported but floating point exponents are not.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">doAssert</span> <span class="Punctuation">(</span><span class="Operator">-</span><span class="DecNumber">3</span> <span class="Operator">//</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">^</span> <span class="DecNumber">0</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="DecNumber">1</span> <span class="Operator">//</span> <span class="DecNumber">1</span><span class="Punctuation">)</span>
- <span class="Identifier">doAssert</span> <span class="Punctuation">(</span><span class="Operator">-</span><span class="DecNumber">3</span> <span class="Operator">//</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">^</span> <span class="DecNumber">1</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="Operator">-</span><span class="DecNumber">3</span> <span class="Operator">//</span> <span class="DecNumber">5</span><span class="Punctuation">)</span>
- <span class="Identifier">doAssert</span> <span class="Punctuation">(</span><span class="Operator">-</span><span class="DecNumber">3</span> <span class="Operator">//</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">^</span> <span class="DecNumber">2</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="DecNumber">9</span> <span class="Operator">//</span> <span class="DecNumber">25</span><span class="Punctuation">)</span>
- <span class="Identifier">doAssert</span> <span class="Punctuation">(</span><span class="Operator">-</span><span class="DecNumber">3</span> <span class="Operator">//</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">^</span> <span class="Operator">-</span><span class="DecNumber">2</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="DecNumber">25</span> <span class="Operator">//</span> <span class="DecNumber">9</span><span class="Punctuation">)</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L307" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L307" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="abs-procs-all">
- <div id="abs,Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#abs%2CRational%5BT%5D"><span class="Identifier">abs</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- Returns the absolute value of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">abs</span><span class="Punctuation">(</span><span class="DecNumber">1</span> <span class="Operator">//</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span> <span class="Operator">//</span> <span class="DecNumber">2</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">abs</span><span class="Punctuation">(</span><span class="Operator">-</span><span class="DecNumber">1</span> <span class="Operator">//</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span> <span class="Operator">//</span> <span class="DecNumber">2</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L261" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L261" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="cmp-procs-all">
- <div id="cmp,Rational,Rational">
- <dt><pre><span class="Keyword">func</span> <a href="#cmp%2CRational%2CRational"><span class="Identifier">cmp</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
- <dd>
-
- Compares two rationals. Returns<ul class="simple"><li>a value less than zero, if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator"><</span> <span class="Identifier">y</span></span></tt></li>
- <li>a value greater than zero, if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator">></span> <span class="Identifier">y</span></span></tt></li>
- <li>zero, if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator">==</span> <span class="Identifier">y</span></span></tt></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L242" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L242" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="div-procs-all">
- <div id="div,Rational[T: SomeInteger],Rational[T: SomeInteger]">
- <dt><pre><span class="Keyword">func</span> <a href="#div%2CRational%5BT%3A%20SomeInteger%5D%2CRational%5BT%3A%20SomeInteger%5D"><span class="Identifier">`div`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
- <dd>
-
- Computes the rational truncated division.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L268" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L268" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="floorDiv-procs-all">
- <div id="floorDiv,Rational[T: SomeInteger],Rational[T: SomeInteger]">
- <dt><pre><span class="Keyword">func</span> <a href="#floorDiv%2CRational%5BT%3A%20SomeInteger%5D%2CRational%5BT%3A%20SomeInteger%5D"><span class="Identifier">floorDiv</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
- <dd>
-
- <p>Computes the rational floor division.</p>
- <p>Floor division is conceptually defined as <tt class="docutils literal"><span class="pre"><span class="Identifier">floor</span><span class="Punctuation">(</span><span class="Identifier">x</span> <span class="Operator">/</span> <span class="Identifier">y</span><span class="Punctuation">)</span></span></tt>. This is different from the <tt class="docutils literal"><span class="pre"><span class="Keyword">div</span></span></tt> operator, which is defined as <tt class="docutils literal"><span class="pre"><span class="Identifier">trunc</span><span class="Punctuation">(</span><span class="Identifier">x</span> <span class="Operator">/</span> <span class="Identifier">y</span><span class="Punctuation">)</span></span></tt>. That is, <tt class="docutils literal"><span class="pre"><span class="Keyword">div</span></span></tt> rounds towards 0 and <tt class="docutils literal"><span class="pre"><span class="Identifier">floorDiv</span></span></tt> rounds down.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L278" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L278" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="floorMod-procs-all">
- <div id="floorMod,Rational[T: SomeInteger],Rational[T: SomeInteger]">
- <dt><pre><span class="Keyword">func</span> <a href="#floorMod%2CRational%5BT%3A%20SomeInteger%5D%2CRational%5BT%3A%20SomeInteger%5D"><span class="Identifier">floorMod</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- <p>Computes the rational modulo by floor division (modulo).</p>
- <p>This is same as <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator">-</span> <span class="Identifier">floorDiv</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">,</span> <span class="Identifier">y</span><span class="Punctuation">)</span> <span class="Operator">*</span> <span class="Identifier">y</span></span></tt>. This func behaves the same as the <tt class="docutils literal"><span class="pre"><span class="Operator">%</span></span></tt> operator in Python.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L287" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L287" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="hash-procs-all">
- <div id="hash,Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#hash%2CRational%5BT%5D"><span class="Identifier">hash</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a></pre></dt>
- <dd>
-
- Computes the hash for the rational <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L295" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L295" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="initRational-procs-all">
- <div id="initRational,T,T">
- <dt><pre><span class="Keyword">func</span> <a href="#initRational%2CT%2CT"><span class="Identifier">initRational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">num</span><span class="Other">,</span> <span class="Identifier">den</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- <p>Creates a new rational number with numerator <tt class="docutils literal"><span class="pre"><span class="Identifier">num</span></span></tt> and denominator <tt class="docutils literal"><span class="pre"><span class="Identifier">den</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">den</span></span></tt> must not be 0.</p>
- <p><strong>Note:</strong> <tt class="docutils literal"><span class="pre"><span class="Identifier">den</span> <span class="Operator">!=</span> <span class="DecNumber">0</span></span></tt> is not checked when assertions are turned off.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L54" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L54" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="mod-procs-all">
- <div id="mod,Rational[T: SomeInteger],Rational[T: SomeInteger]">
- <dt><pre><span class="Keyword">func</span> <a href="#mod%2CRational%5BT%3A%20SomeInteger%5D%2CRational%5BT%3A%20SomeInteger%5D"><span class="Identifier">`mod`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- Computes the rational modulo by truncated division (remainder). This is same as <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator">-</span> <span class="Punctuation">(</span><span class="Identifier">x</span> <span class="Keyword">div</span> <span class="Identifier">y</span><span class="Punctuation">)</span> <span class="Operator">*</span> <span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L272" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L272" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="reciprocal-procs-all">
- <div id="reciprocal,Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#reciprocal%2CRational%5BT%5D"><span class="Identifier">reciprocal</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- Calculates the reciprocal of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> (<tt class="docutils literal"><span class="pre"><span class="DecNumber">1</span><span class="Operator">/</span><span class="Identifier">x</span></span></tt>). If <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is 0, raises <tt class="docutils literal"><span class="pre"><span class="Identifier">DivByZeroDefect</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L206" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L206" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="reduce-procs-all">
- <div id="reduce,Rational[T: SomeInteger]">
- <dt><pre><span class="Keyword">func</span> <a href="#reduce%2CRational%5BT%3A%20SomeInteger%5D"><span class="Identifier">reduce</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
- <dd>
-
- <p>Reduces the rational number <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>, so that the numerator and denominator have no common divisors other than 1 (and -1). If <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is 0, raises <tt class="docutils literal"><span class="pre"><span class="Identifier">DivByZeroDefect</span></span></tt>.</p>
- <p><strong>Note:</strong> This is called automatically by the various operations on rationals.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">r</span> <span class="Operator">=</span> <span class="Identifier">Rational</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Identifier">num</span><span class="Punctuation">:</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="Identifier">den</span><span class="Punctuation">:</span> <span class="DecNumber">4</span><span class="Punctuation">)</span> <span class="Comment"># 1/2</span>
- <span class="Identifier">reduce</span><span class="Punctuation">(</span><span class="Identifier">r</span><span class="Punctuation">)</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">r</span><span class="Operator">.</span><span class="Identifier">num</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">r</span><span class="Operator">.</span><span class="Identifier">den</span> <span class="Operator">==</span> <span class="DecNumber">2</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L32" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L32" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="toFloat-procs-all">
- <div id="toFloat,Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#toFloat%2CRational%5BT%5D"><span class="Identifier">toFloat</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a></pre></dt>
- <dd>
-
- Converts a rational number <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> to a <tt class="docutils literal"><span class="pre"><span class="Identifier">float</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L113" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L113" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="toInt-procs-all">
- <div id="toInt,Rational[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#toInt%2CRational%5BT%5D"><span class="Identifier">toInt</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
- <dd>
-
- Converts a rational number <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> to an <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span></span></tt>. Conversion rounds towards 0 if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> does not contain an integer value.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L117" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L117" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="toRational-procs-all">
- <div id="toRational,float,int">
- <dt><pre><span class="Keyword">func</span> <a href="#toRational%2Cfloat%2Cint"><span class="Identifier">toRational</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a><span class="Other">;</span> <span class="Identifier">n</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="Identifier">high</span><span class="Other">(</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span> <span class="Keyword">shr</span> <span class="DecNumber">32</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Calculates the best rational approximation of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>, where the denominator is smaller than <tt class="docutils literal"><span class="pre"><span class="Identifier">n</span></span></tt> (default is the largest possible <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span></span></tt> for maximal resolution).</p>
- <p>The algorithm is based on the theory of continued fractions.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">x</span> <span class="Operator">=</span> <span class="FloatNumber">1.2</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">toRational</span><span class="Operator">.</span><span class="Identifier">toFloat</span> <span class="Operator">==</span> <span class="Identifier">x</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L84" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L84" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="toRational,T">
- <dt><pre><span class="Keyword">func</span> <a href="#toRational%2CT"><span class="Identifier">toRational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="rationals.html#Rational"><span class="Identifier">Rational</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- Converts some integer <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> to a rational number.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">toRational</span><span class="Punctuation">(</span><span class="DecNumber">42</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">42</span> <span class="Operator">//</span> <span class="DecNumber">1</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/rationals.nim#L78" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/rationals.nim#L78" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- </dl>
- </div>
- </div>
- </div>
- <div class="twelve-columns footer">
- <span class="nim-sprite"></span>
- <br>
- <small style="color: var(--hint);">Made with Nim. Generated: 2025-01-09 12:00:03 UTC</small>
- </div>
- </div>
- </div>
- <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
-
- </body>
- </html>
|