123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746 |
- <?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/fenv</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/fenv</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>
- <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="#Tfenv" title="Tfenv {.importc: "fenv_t", header: "<fenv.h>", final, pure.} = object">Tfenv</a></li>
- <li><a class="reference" href="#Tfexcept" title="Tfexcept {.importc: "fexcept_t", header: "<fenv.h>", final, pure.} = object">Tfexcept</a></li>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#8" id="58">Vars</a></summary>
- <ul class="simple simple-toc-section">
- <li><a class="reference" href="#FE_ALL_EXCEPT" title="FE_ALL_EXCEPT {.importc, header: "<fenv.h>".}: cint">FE_ALL_EXCEPT</a></li>
- <li><a class="reference" href="#FE_DFL_ENV" title="FE_DFL_ENV {.importc, header: "<fenv.h>".}: cint">FE_DFL_ENV</a></li>
- <li><a class="reference" href="#FE_DIVBYZERO" title="FE_DIVBYZERO {.importc, header: "<fenv.h>".}: cint">FE_DIVBYZERO</a></li>
- <li><a class="reference" href="#FE_DOWNWARD" title="FE_DOWNWARD {.importc, header: "<fenv.h>".}: cint">FE_DOWNWARD</a></li>
- <li><a class="reference" href="#FE_INEXACT" title="FE_INEXACT {.importc, header: "<fenv.h>".}: cint">FE_INEXACT</a></li>
- <li><a class="reference" href="#FE_INVALID" title="FE_INVALID {.importc, header: "<fenv.h>".}: cint">FE_INVALID</a></li>
- <li><a class="reference" href="#FE_OVERFLOW" title="FE_OVERFLOW {.importc, header: "<fenv.h>".}: cint">FE_OVERFLOW</a></li>
- <li><a class="reference" href="#FE_TONEAREST" title="FE_TONEAREST {.importc, header: "<fenv.h>".}: cint">FE_TONEAREST</a></li>
- <li><a class="reference" href="#FE_TOWARDZERO" title="FE_TOWARDZERO {.importc, header: "<fenv.h>".}: cint">FE_TOWARDZERO</a></li>
- <li><a class="reference" href="#FE_UNDERFLOW" title="FE_UNDERFLOW {.importc, header: "<fenv.h>".}: cint">FE_UNDERFLOW</a></li>
- <li><a class="reference" href="#FE_UPWARD" title="FE_UPWARD {.importc, header: "<fenv.h>".}: cint">FE_UPWARD</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">feclearexcept
- <li><a class="reference" href="#feclearexcept%2Ccint" title="feclearexcept(excepts: cint): cint">feclearexcept(excepts: cint): cint</a></li>
- </ul>
- <ul class="simple nested-toc-section">fegetenv
- <li><a class="reference" href="#fegetenv%2Cptr.Tfenv" title="fegetenv(envp: ptr Tfenv): cint">fegetenv(envp: ptr Tfenv): cint</a></li>
- </ul>
- <ul class="simple nested-toc-section">fegetexceptflag
- <li><a class="reference" href="#fegetexceptflag%2Cptr.Tfexcept%2Ccint" title="fegetexceptflag(flagp: ptr Tfexcept; excepts: cint): cint">fegetexceptflag(flagp: ptr Tfexcept; excepts: cint): cint</a></li>
- </ul>
- <ul class="simple nested-toc-section">fegetround
- <li><a class="reference" href="#fegetround" title="fegetround(): cint">fegetround(): cint</a></li>
- </ul>
- <ul class="simple nested-toc-section">feholdexcept
- <li><a class="reference" href="#feholdexcept%2Cptr.Tfenv" title="feholdexcept(envp: ptr Tfenv): cint">feholdexcept(envp: ptr Tfenv): cint</a></li>
- </ul>
- <ul class="simple nested-toc-section">feraiseexcept
- <li><a class="reference" href="#feraiseexcept%2Ccint" title="feraiseexcept(excepts: cint): cint">feraiseexcept(excepts: cint): cint</a></li>
- </ul>
- <ul class="simple nested-toc-section">fesetenv
- <li><a class="reference" href="#fesetenv%2Cptr.Tfenv" title="fesetenv(a1: ptr Tfenv): cint">fesetenv(a1: ptr Tfenv): cint</a></li>
- </ul>
- <ul class="simple nested-toc-section">fesetexceptflag
- <li><a class="reference" href="#fesetexceptflag%2Cptr.Tfexcept%2Ccint" title="fesetexceptflag(flagp: ptr Tfexcept; excepts: cint): cint">fesetexceptflag(flagp: ptr Tfexcept; excepts: cint): cint</a></li>
- </ul>
- <ul class="simple nested-toc-section">fesetround
- <li><a class="reference" href="#fesetround%2Ccint" title="fesetround(roundingDirection: cint): cint">fesetround(roundingDirection: cint): cint</a></li>
- </ul>
- <ul class="simple nested-toc-section">fetestexcept
- <li><a class="reference" href="#fetestexcept%2Ccint" title="fetestexcept(excepts: cint): cint">fetestexcept(excepts: cint): cint</a></li>
- </ul>
- <ul class="simple nested-toc-section">feupdateenv
- <li><a class="reference" href="#feupdateenv%2Cptr.Tfenv" title="feupdateenv(envp: ptr Tfenv): cint">feupdateenv(envp: ptr Tfenv): cint</a></li>
- </ul>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
- <ul class="simple simple-toc-section">
- <ul class="simple nested-toc-section">digits
- <li><a class="reference" href="#digits.t%2Ctypedesc%5Bfloat32%5D" title="digits(T: typedesc[float32]): int">digits(T: typedesc[float32]): int</a></li>
- <li><a class="reference" href="#digits.t%2Ctypedesc%5Bfloat64%5D" title="digits(T: typedesc[float64]): int">digits(T: typedesc[float64]): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">epsilon
- <li><a class="reference" href="#epsilon.t%2Ctypedesc%5Bfloat32%5D" title="epsilon(T: typedesc[float32]): float32">epsilon(T: typedesc[float32]): float32</a></li>
- <li><a class="reference" href="#epsilon.t%2Ctypedesc%5Bfloat64%5D" title="epsilon(T: typedesc[float64]): float64">epsilon(T: typedesc[float64]): float64</a></li>
- </ul>
- <ul class="simple nested-toc-section">fpRadix
- <li><a class="reference" href="#fpRadix.t" title="fpRadix(): int">fpRadix(): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">mantissaDigits
- <li><a class="reference" href="#mantissaDigits.t%2Ctypedesc%5Bfloat32%5D" title="mantissaDigits(T: typedesc[float32]): int">mantissaDigits(T: typedesc[float32]): int</a></li>
- <li><a class="reference" href="#mantissaDigits.t%2Ctypedesc%5Bfloat64%5D" title="mantissaDigits(T: typedesc[float64]): int">mantissaDigits(T: typedesc[float64]): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">max10Exponent
- <li><a class="reference" href="#max10Exponent.t%2Ctypedesc%5Bfloat32%5D" title="max10Exponent(T: typedesc[float32]): int">max10Exponent(T: typedesc[float32]): int</a></li>
- <li><a class="reference" href="#max10Exponent.t%2Ctypedesc%5Bfloat64%5D" title="max10Exponent(T: typedesc[float64]): int">max10Exponent(T: typedesc[float64]): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">maxExponent
- <li><a class="reference" href="#maxExponent.t%2Ctypedesc%5Bfloat32%5D" title="maxExponent(T: typedesc[float32]): int">maxExponent(T: typedesc[float32]): int</a></li>
- <li><a class="reference" href="#maxExponent.t%2Ctypedesc%5Bfloat64%5D" title="maxExponent(T: typedesc[float64]): int">maxExponent(T: typedesc[float64]): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">maximumPositiveValue
- <li><a class="reference" href="#maximumPositiveValue.t%2Ctypedesc%5Bfloat32%5D" title="maximumPositiveValue(T: typedesc[float32]): float32">maximumPositiveValue(T: typedesc[float32]): float32</a></li>
- <li><a class="reference" href="#maximumPositiveValue.t%2Ctypedesc%5Bfloat64%5D" title="maximumPositiveValue(T: typedesc[float64]): float64">maximumPositiveValue(T: typedesc[float64]): float64</a></li>
- </ul>
- <ul class="simple nested-toc-section">min10Exponent
- <li><a class="reference" href="#min10Exponent.t%2Ctypedesc%5Bfloat32%5D" title="min10Exponent(T: typedesc[float32]): int">min10Exponent(T: typedesc[float32]): int</a></li>
- <li><a class="reference" href="#min10Exponent.t%2Ctypedesc%5Bfloat64%5D" title="min10Exponent(T: typedesc[float64]): int">min10Exponent(T: typedesc[float64]): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">minExponent
- <li><a class="reference" href="#minExponent.t%2Ctypedesc%5Bfloat32%5D" title="minExponent(T: typedesc[float32]): int">minExponent(T: typedesc[float32]): int</a></li>
- <li><a class="reference" href="#minExponent.t%2Ctypedesc%5Bfloat64%5D" title="minExponent(T: typedesc[float64]): int">minExponent(T: typedesc[float64]): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">minimumPositiveValue
- <li><a class="reference" href="#minimumPositiveValue.t%2Ctypedesc%5Bfloat32%5D" title="minimumPositiveValue(T: typedesc[float32]): float32">minimumPositiveValue(T: typedesc[float32]): float32</a></li>
- <li><a class="reference" href="#minimumPositiveValue.t%2Ctypedesc%5Bfloat64%5D" title="minimumPositiveValue(T: typedesc[float64]): float64">minimumPositiveValue(T: typedesc[float64]): float64</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/fenv.nim#L1" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
- <div id="tocRoot"></div>
-
- <p class="module-desc">Floating-point environment. Handling of floating-point rounding and exceptions (overflow, division by zero, etc.). The types, vars and procs are bindings for the C standard library <a class="reference external" href="https://en.cppreference.com/w/c/numeric/fenv"><fenv.h></a> header.</p>
- <div class="section" id="7">
- <h1><a class="toc-backref" href="#7">Types</a></h1>
- <dl class="item">
- <div id="Tfenv">
- <dt><pre><a href="fenv.html#Tfenv"><span class="Identifier">Tfenv</span></a> {.<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"fenv_t"</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span><span class="Other">,</span> <span class="Identifier">final</span><span class="Other">,</span> <span class="Identifier">pure</span>.} <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
- <dd>
-
- Represents the entire floating-point environment. The floating-point environment refers collectively to any floating-point status flags and control modes supported by the implementation.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L45" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L45" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="Tfexcept">
- <dt><pre><a href="fenv.html#Tfexcept"><span class="Identifier">Tfexcept</span></a> {.<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"fexcept_t"</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span><span class="Other">,</span> <span class="Identifier">final</span><span class="Other">,</span> <span class="Identifier">pure</span>.} <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
- <dd>
-
- Represents the floating-point status flags collectively, including any status the implementation associates with the flags. A floating-point status flag is a system variable whose value is set (but never cleared) when a floating-point exception is raised, which occurs as a side effect of exceptional floating-point arithmetic to provide auxiliary information. A floating-point control mode is a system variable whose value may be set by the user to affect the subsequent behavior of floating-point arithmetic.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L50" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L50" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </dl>
- </div>
- <div class="section" id="8">
- <h1><a class="toc-backref" href="#8">Vars</a></h1>
- <dl class="item">
- <div id="FE_ALL_EXCEPT">
- <dt><pre><a href="fenv.html#FE_ALL_EXCEPT"><span class="Identifier">FE_ALL_EXCEPT</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span>.}<span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a></pre></dt>
- <dd>
-
- bitwise OR of all supported exceptions
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L29" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L29" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="FE_DFL_ENV">
- <dt><pre><a href="fenv.html#FE_DFL_ENV"><span class="Identifier">FE_DFL_ENV</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span>.}<span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a></pre></dt>
- <dd>
-
- macro of type pointer to <tt class="docutils literal"><span class="pre"><span class="Identifier">fenv_t</span></span></tt> to be used as the argument to functions taking an argument of type <tt class="docutils literal"><span class="pre"><span class="Identifier">fenv_t</span></span></tt>; in this case the default environment will be used
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L39" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L39" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="FE_DIVBYZERO">
- <dt><pre><a href="fenv.html#FE_DIVBYZERO"><span class="Identifier">FE_DIVBYZERO</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span>.}<span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a></pre></dt>
- <dd>
-
- division by zero
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L19" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L19" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="FE_DOWNWARD">
- <dt><pre><a href="fenv.html#FE_DOWNWARD"><span class="Identifier">FE_DOWNWARD</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span>.}<span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a></pre></dt>
- <dd>
-
- round toward -Inf
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L31" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L31" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="FE_INEXACT">
- <dt><pre><a href="fenv.html#FE_INEXACT"><span class="Identifier">FE_INEXACT</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span>.}<span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a></pre></dt>
- <dd>
-
- inexact result
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L21" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L21" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="FE_INVALID">
- <dt><pre><a href="fenv.html#FE_INVALID"><span class="Identifier">FE_INVALID</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span>.}<span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a></pre></dt>
- <dd>
-
- invalid operation
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L23" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L23" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="FE_OVERFLOW">
- <dt><pre><a href="fenv.html#FE_OVERFLOW"><span class="Identifier">FE_OVERFLOW</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span>.}<span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a></pre></dt>
- <dd>
-
- result not representable due to overflow
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L25" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L25" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="FE_TONEAREST">
- <dt><pre><a href="fenv.html#FE_TONEAREST"><span class="Identifier">FE_TONEAREST</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span>.}<span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a></pre></dt>
- <dd>
-
- round to nearest
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L33" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L33" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="FE_TOWARDZERO">
- <dt><pre><a href="fenv.html#FE_TOWARDZERO"><span class="Identifier">FE_TOWARDZERO</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span>.}<span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a></pre></dt>
- <dd>
-
- round toward 0
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L35" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L35" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="FE_UNDERFLOW">
- <dt><pre><a href="fenv.html#FE_UNDERFLOW"><span class="Identifier">FE_UNDERFLOW</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span>.}<span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a></pre></dt>
- <dd>
-
- result not representable due to underflow
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L27" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L27" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="FE_UPWARD">
- <dt><pre><a href="fenv.html#FE_UPWARD"><span class="Identifier">FE_UPWARD</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span>.}<span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a></pre></dt>
- <dd>
-
- round toward +Inf
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L37" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L37" 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="feclearexcept-procs-all">
- <div id="feclearexcept,cint">
- <dt><pre><span class="Keyword">proc</span> <a href="#feclearexcept%2Ccint"><span class="Identifier">feclearexcept</span></a><span class="Other">(</span><span class="Identifier">excepts</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span><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>
-
- Clear the supported exceptions represented by <tt class="docutils literal"><span class="pre"><span class="Identifier">excepts</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L61" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L61" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="fegetenv-procs-all">
- <div id="fegetenv,ptr.Tfenv">
- <dt><pre><span class="Keyword">proc</span> <a href="#fegetenv%2Cptr.Tfenv"><span class="Identifier">fegetenv</span></a><span class="Other">(</span><span class="Identifier">envp</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="fenv.html#Tfenv"><span class="Identifier">Tfenv</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span><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>
-
- Store the current floating-point environment in the object pointed to by <tt class="docutils literal"><span class="pre"><span class="Identifier">envp</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L87" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L87" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="fegetexceptflag-procs-all">
- <div id="fegetexceptflag,ptr.Tfexcept,cint">
- <dt><pre><span class="Keyword">proc</span> <a href="#fegetexceptflag%2Cptr.Tfexcept%2Ccint"><span class="Identifier">fegetexceptflag</span></a><span class="Other">(</span><span class="Identifier">flagp</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="fenv.html#Tfexcept"><span class="Identifier">Tfexcept</span></a><span class="Other">;</span> <span class="Identifier">excepts</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span>
- <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span><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>
-
- Store implementation-defined representation of the exception flags indicated by <tt class="docutils literal"><span class="pre"><span class="Identifier">excepts</span></span></tt> in the object pointed to by <tt class="docutils literal"><span class="pre"><span class="Identifier">flagp</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L64" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L64" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="fegetround-procs-all">
- <div id="fegetround">
- <dt><pre><span class="Keyword">proc</span> <a href="#fegetround"><span class="Identifier">fegetround</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span><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>
-
- Get current rounding direction.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L81" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L81" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="feholdexcept-procs-all">
- <div id="feholdexcept,ptr.Tfenv">
- <dt><pre><span class="Keyword">proc</span> <a href="#feholdexcept%2Cptr.Tfenv"><span class="Identifier">feholdexcept</span></a><span class="Other">(</span><span class="Identifier">envp</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="fenv.html#Tfenv"><span class="Identifier">Tfenv</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span><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>
-
- Save the current environment in the object pointed to by <tt class="docutils literal"><span class="pre"><span class="Identifier">envp</span></span></tt>, clear exception flags and install a non-stop mode (if available) for all exceptions.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L91" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L91" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="feraiseexcept-procs-all">
- <div id="feraiseexcept,cint">
- <dt><pre><span class="Keyword">proc</span> <a href="#feraiseexcept%2Ccint"><span class="Identifier">feraiseexcept</span></a><span class="Other">(</span><span class="Identifier">excepts</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span><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>
-
- Raise the supported exceptions represented by <tt class="docutils literal"><span class="pre"><span class="Identifier">excepts</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L69" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L69" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="fesetenv-procs-all">
- <div id="fesetenv,ptr.Tfenv">
- <dt><pre><span class="Keyword">proc</span> <a href="#fesetenv%2Cptr.Tfenv"><span class="Identifier">fesetenv</span></a><span class="Other">(</span><span class="Identifier">a1</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="fenv.html#Tfenv"><span class="Identifier">Tfenv</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span><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>
-
- Establish the floating-point environment represented by the object pointed to by <tt class="docutils literal"><span class="pre"><span class="Identifier">envp</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L96" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L96" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="fesetexceptflag-procs-all">
- <div id="fesetexceptflag,ptr.Tfexcept,cint">
- <dt><pre><span class="Keyword">proc</span> <a href="#fesetexceptflag%2Cptr.Tfexcept%2Ccint"><span class="Identifier">fesetexceptflag</span></a><span class="Other">(</span><span class="Identifier">flagp</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="fenv.html#Tfexcept"><span class="Identifier">Tfexcept</span></a><span class="Other">;</span> <span class="Identifier">excepts</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span>
- <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span><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>
-
- Set complete status for exceptions indicated by <tt class="docutils literal"><span class="pre"><span class="Identifier">excepts</span></span></tt> according to the representation in the object pointed to by <tt class="docutils literal"><span class="pre"><span class="Identifier">flagp</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L72" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L72" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="fesetround-procs-all">
- <div id="fesetround,cint">
- <dt><pre><span class="Keyword">proc</span> <a href="#fesetround%2Ccint"><span class="Identifier">fesetround</span></a><span class="Other">(</span><span class="Identifier">roundingDirection</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span><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>
-
- Establish the rounding direction represented by <tt class="docutils literal"><span class="pre"><span class="Identifier">roundingDirection</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L84" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L84" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="fetestexcept-procs-all">
- <div id="fetestexcept,cint">
- <dt><pre><span class="Keyword">proc</span> <a href="#fetestexcept%2Ccint"><span class="Identifier">fetestexcept</span></a><span class="Other">(</span><span class="Identifier">excepts</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span><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>
-
- Determine which of subset of the exceptions specified by <tt class="docutils literal"><span class="pre"><span class="Identifier">excepts</span></span></tt> are currently set.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L77" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L77" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="feupdateenv-procs-all">
- <div id="feupdateenv,ptr.Tfenv">
- <dt><pre><span class="Keyword">proc</span> <a href="#feupdateenv%2Cptr.Tfenv"><span class="Identifier">feupdateenv</span></a><span class="Other">(</span><span class="Identifier">envp</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="fenv.html#Tfenv"><span class="Identifier">Tfenv</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#cint"><span class="Identifier">cint</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<fenv.h>"</span><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>
-
- Save current exceptions in temporary storage, install environment represented by object pointed to by <tt class="docutils literal"><span class="pre"><span class="Identifier">envp</span></span></tt> and raise exceptions according to saved exceptions.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L100" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L100" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- </dl>
- </div>
- <div class="section" id="18">
- <h1><a class="toc-backref" href="#18">Templates</a></h1>
- <dl class="item">
- <div id="digits-templates-all">
- <div id="digits.t,typedesc[float32]">
- <dt><pre><span class="Keyword">template</span> <a href="#digits.t%2Ctypedesc%5Bfloat32%5D"><span class="Identifier">digits</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float32"><span class="Identifier">float32</span></a><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>
-
- Number of decimal digits that can be represented in a 32-bit floating-point type without losing precision.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L135" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L135" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="digits.t,typedesc[float64]">
- <dt><pre><span class="Keyword">template</span> <a href="#digits.t%2Ctypedesc%5Bfloat64%5D"><span class="Identifier">digits</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float64"><span class="Identifier">float64</span></a><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>
-
- Number of decimal digits that can be represented in a 64-bit floating-point type without losing precision.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L161" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L161" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="epsilon-templates-all">
- <div id="epsilon.t,typedesc[float32]">
- <dt><pre><span class="Keyword">template</span> <a href="#epsilon.t%2Ctypedesc%5Bfloat32%5D"><span class="Identifier">epsilon</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a></pre></dt>
- <dd>
-
- The difference between 1.0 and the smallest number greater than 1.0 that can be represented in a 32-bit floating-point type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L154" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L154" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="epsilon.t,typedesc[float64]">
- <dt><pre><span class="Keyword">template</span> <a href="#epsilon.t%2Ctypedesc%5Bfloat64%5D"><span class="Identifier">epsilon</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float64"><span class="Identifier">float64</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float64"><span class="Identifier">float64</span></a></pre></dt>
- <dd>
-
- The difference between 1.0 and the smallest number greater than 1.0 that can be represented in a 64-bit floating-point type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L180" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L180" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="fpRadix-templates-all">
- <div id="fpRadix.t">
- <dt><pre><span class="Keyword">template</span> <a href="#fpRadix.t"><span class="Identifier">fpRadix</span></a><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>
-
- The (integer) value of the radix used to represent any floating point type on the architecture used to build the program.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L128" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L128" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="mantissaDigits-templates-all">
- <div id="mantissaDigits.t,typedesc[float32]">
- <dt><pre><span class="Keyword">template</span> <a href="#mantissaDigits.t%2Ctypedesc%5Bfloat32%5D"><span class="Identifier">mantissaDigits</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float32"><span class="Identifier">float32</span></a><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>
-
- Number of digits (in base <tt class="docutils literal"><span class="pre"><span class="Identifier">floatingPointRadix</span></span></tt>) in the mantissa of 32-bit floating-point numbers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L132" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L132" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="mantissaDigits.t,typedesc[float64]">
- <dt><pre><span class="Keyword">template</span> <a href="#mantissaDigits.t%2Ctypedesc%5Bfloat64%5D"><span class="Identifier">mantissaDigits</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float64"><span class="Identifier">float64</span></a><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>
-
- Number of digits (in base <tt class="docutils literal"><span class="pre"><span class="Identifier">floatingPointRadix</span></span></tt>) in the mantissa of 64-bit floating-point numbers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L158" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L158" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="max10Exponent-templates-all">
- <div id="max10Exponent.t,typedesc[float32]">
- <dt><pre><span class="Keyword">template</span> <a href="#max10Exponent.t%2Ctypedesc%5Bfloat32%5D"><span class="Identifier">max10Exponent</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float32"><span class="Identifier">float32</span></a><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>
-
- Maximum (positive) exponent in base 10 for 32-bit floating-point numbers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L145" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L145" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="max10Exponent.t,typedesc[float64]">
- <dt><pre><span class="Keyword">template</span> <a href="#max10Exponent.t%2Ctypedesc%5Bfloat64%5D"><span class="Identifier">max10Exponent</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float64"><span class="Identifier">float64</span></a><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>
-
- Maximum (positive) exponent in base 10 for 64-bit floating-point numbers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L171" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L171" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="maxExponent-templates-all">
- <div id="maxExponent.t,typedesc[float32]">
- <dt><pre><span class="Keyword">template</span> <a href="#maxExponent.t%2Ctypedesc%5Bfloat32%5D"><span class="Identifier">maxExponent</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float32"><span class="Identifier">float32</span></a><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>
-
- Maximum (positive) exponent for 32-bit floating-point numbers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L140" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L140" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="maxExponent.t,typedesc[float64]">
- <dt><pre><span class="Keyword">template</span> <a href="#maxExponent.t%2Ctypedesc%5Bfloat64%5D"><span class="Identifier">maxExponent</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float64"><span class="Identifier">float64</span></a><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>
-
- Maximum (positive) exponent for 64-bit floating-point numbers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L166" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L166" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="maximumPositiveValue-templates-all">
- <div id="maximumPositiveValue.t,typedesc[float32]">
- <dt><pre><span class="Keyword">template</span> <a href="#maximumPositiveValue.t%2Ctypedesc%5Bfloat32%5D"><span class="Identifier">maximumPositiveValue</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a></pre></dt>
- <dd>
-
- The largest positive number that can be represented in a 32-bit floating-point type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L151" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L151" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="maximumPositiveValue.t,typedesc[float64]">
- <dt><pre><span class="Keyword">template</span> <a href="#maximumPositiveValue.t%2Ctypedesc%5Bfloat64%5D"><span class="Identifier">maximumPositiveValue</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float64"><span class="Identifier">float64</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float64"><span class="Identifier">float64</span></a></pre></dt>
- <dd>
-
- The largest positive number that can be represented in a 64-bit floating-point type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L177" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L177" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="min10Exponent-templates-all">
- <div id="min10Exponent.t,typedesc[float32]">
- <dt><pre><span class="Keyword">template</span> <a href="#min10Exponent.t%2Ctypedesc%5Bfloat32%5D"><span class="Identifier">min10Exponent</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float32"><span class="Identifier">float32</span></a><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>
-
- Minimum (negative) exponent in base 10 for 32-bit floating-point numbers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L142" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L142" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="min10Exponent.t,typedesc[float64]">
- <dt><pre><span class="Keyword">template</span> <a href="#min10Exponent.t%2Ctypedesc%5Bfloat64%5D"><span class="Identifier">min10Exponent</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float64"><span class="Identifier">float64</span></a><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>
-
- Minimum (negative) exponent in base 10 for 64-bit floating-point numbers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L168" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L168" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="minExponent-templates-all">
- <div id="minExponent.t,typedesc[float32]">
- <dt><pre><span class="Keyword">template</span> <a href="#minExponent.t%2Ctypedesc%5Bfloat32%5D"><span class="Identifier">minExponent</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float32"><span class="Identifier">float32</span></a><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>
-
- Minimum (negative) exponent for 32-bit floating-point numbers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L138" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L138" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="minExponent.t,typedesc[float64]">
- <dt><pre><span class="Keyword">template</span> <a href="#minExponent.t%2Ctypedesc%5Bfloat64%5D"><span class="Identifier">minExponent</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float64"><span class="Identifier">float64</span></a><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>
-
- Minimum (negative) exponent for 64-bit floating-point numbers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L164" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L164" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="minimumPositiveValue-templates-all">
- <div id="minimumPositiveValue.t,typedesc[float32]">
- <dt><pre><span class="Keyword">template</span> <a href="#minimumPositiveValue.t%2Ctypedesc%5Bfloat32%5D"><span class="Identifier">minimumPositiveValue</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a></pre></dt>
- <dd>
-
- The smallest positive (nonzero) number that can be represented in a 32-bit floating-point type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L148" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L148" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="minimumPositiveValue.t,typedesc[float64]">
- <dt><pre><span class="Keyword">template</span> <a href="#minimumPositiveValue.t%2Ctypedesc%5Bfloat64%5D"><span class="Identifier">minimumPositiveValue</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float64"><span class="Identifier">float64</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float64"><span class="Identifier">float64</span></a></pre></dt>
- <dd>
-
- The smallest positive (nonzero) number that can be represented in a 64-bit floating-point type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/fenv.nim#L174" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/fenv.nim#L174" 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-04-22 15:32:27 UTC</small>
- </div>
- </div>
- </div>
- <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
-
- </body>
- </html>
|