stats.html 69 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <!-- This file is generated by Nim. -->
  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
  5. <head>
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>std/stats</title>
  9. <!-- Google fonts -->
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  11. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  12. <!-- Favicon -->
  13. <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=="/>
  14. <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=">
  15. <!-- CSS -->
  16. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
  17. <!-- JS -->
  18. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
  19. </head>
  20. <body>
  21. <div class="document" id="documentId">
  22. <div class="container">
  23. <h1 class="title">std/stats</h1>
  24. <div class="row">
  25. <div class="three columns">
  26. <div class="theme-select-wrapper">
  27. <label for="theme-select">Theme:&nbsp;</label>
  28. <select id="theme-select" onchange="setTheme(this.value)">
  29. <option value="auto">🌗 Match OS</option>
  30. <option value="dark">🌑 Dark</option>
  31. <option value="light">🌕 Light</option>
  32. </select>
  33. </div>
  34. <div id="global-links">
  35. <ul class="simple-boot">
  36. <li><a href="manual.html">Manual</a></li>
  37. <li><a href="lib.html">Standard library</a></li>
  38. <li> <a id="indexLink" href="theindex.html">Index</a></li>
  39. <li><a href="compiler/theindex.html">Compiler docs</a></li>
  40. <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
  41. <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
  42. </ul>
  43. </div>
  44. <div id="searchInputDiv">
  45. Search: <input type="search" id="searchInput"
  46. oninput="search()" />
  47. </div>
  48. <ul class="simple simple-toc" id="toc-list">
  49. <li>
  50. <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
  51. </li>
  52. <li>
  53. <details open>
  54. <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
  55. <ul class="simple simple-toc-section">
  56. <li><a class="reference" href="#RunningRegress" title="RunningRegress = object
  57. n*: int ## amount of pushed data
  58. x_stats*: RunningStat ## stats for the first set of data
  59. y_stats*: RunningStat ## stats for the second set of data
  60. ## accumulated data for combined xy">RunningRegress</a></li>
  61. <li><a class="reference" href="#RunningStat" title="RunningStat = object
  62. n*: int ## amount of pushed data
  63. min*, max*, sum*: float ## self-explaining
  64. ## statistical moments, mom1 is mean">RunningStat</a></li>
  65. </ul>
  66. </details>
  67. </li>
  68. <li>
  69. <details open>
  70. <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
  71. <ul class="simple simple-toc-section">
  72. <ul class="simple nested-toc-section">$
  73. <li><a class="reference" href="#%24%2CRunningStat" title="`$`(a: RunningStat): string">`$`(a: RunningStat): string</a></li>
  74. </ul>
  75. <ul class="simple nested-toc-section">+
  76. <li><a class="reference" href="#%2B%2CRunningRegress%2CRunningRegress" title="`+`(a, b: RunningRegress): RunningRegress">`+`(a, b: RunningRegress): RunningRegress</a></li>
  77. <li><a class="reference" href="#%2B%2CRunningStat%2CRunningStat" title="`+`(a, b: RunningStat): RunningStat">`+`(a, b: RunningStat): RunningStat</a></li>
  78. </ul>
  79. <ul class="simple nested-toc-section">+=
  80. <li><a class="reference" href="#%2B%3D%2CRunningRegress%2CRunningRegress" title="`+=`(a: var RunningRegress; b: RunningRegress)">`+=`(a: var RunningRegress; b: RunningRegress)</a></li>
  81. <li><a class="reference" href="#%2B%3D%2CRunningStat%2CRunningStat" title="`+=`(a: var RunningStat; b: RunningStat)">`+=`(a: var RunningStat; b: RunningStat)</a></li>
  82. </ul>
  83. <ul class="simple nested-toc-section">clear
  84. <li><a class="reference" href="#clear%2CRunningRegress" title="clear(r: var RunningRegress)">clear(r: var RunningRegress)</a></li>
  85. <li><a class="reference" href="#clear%2CRunningStat" title="clear(s: var RunningStat)">clear(s: var RunningStat)</a></li>
  86. </ul>
  87. <ul class="simple nested-toc-section">correlation
  88. <li><a class="reference" href="#correlation%2CRunningRegress" title="correlation(r: RunningRegress): float">correlation(r: RunningRegress): float</a></li>
  89. </ul>
  90. <ul class="simple nested-toc-section">intercept
  91. <li><a class="reference" href="#intercept%2CRunningRegress" title="intercept(r: RunningRegress): float">intercept(r: RunningRegress): float</a></li>
  92. </ul>
  93. <ul class="simple nested-toc-section">kurtosis
  94. <li><a class="reference" href="#kurtosis%2CRunningStat" title="kurtosis(s: RunningStat): float">kurtosis(s: RunningStat): float</a></li>
  95. <li><a class="reference" href="#kurtosis%2CopenArray%5BT%5D" title="kurtosis[T](x: openArray[T]): float">kurtosis[T](x: openArray[T]): float</a></li>
  96. </ul>
  97. <ul class="simple nested-toc-section">kurtosisS
  98. <li><a class="reference" href="#kurtosisS%2CRunningStat" title="kurtosisS(s: RunningStat): float">kurtosisS(s: RunningStat): float</a></li>
  99. <li><a class="reference" href="#kurtosisS%2CopenArray%5BT%5D" title="kurtosisS[T](x: openArray[T]): float">kurtosisS[T](x: openArray[T]): float</a></li>
  100. </ul>
  101. <ul class="simple nested-toc-section">mean
  102. <li><a class="reference" href="#mean%2CRunningStat" title="mean(s: RunningStat): float">mean(s: RunningStat): float</a></li>
  103. <li><a class="reference" href="#mean%2CopenArray%5BT%5D" title="mean[T](x: openArray[T]): float">mean[T](x: openArray[T]): float</a></li>
  104. </ul>
  105. <ul class="simple nested-toc-section">push
  106. <li><a class="reference" href="#push%2CRunningRegress%2Cfloat%2Cfloat" title="push(r: var RunningRegress; x, y: float)">push(r: var RunningRegress; x, y: float)</a></li>
  107. <li><a class="reference" href="#push%2CRunningRegress%2Cint%2Cint" title="push(r: var RunningRegress; x, y: int)">push(r: var RunningRegress; x, y: int)</a></li>
  108. <li><a class="reference" href="#push%2CRunningRegress%2CopenArray%5B%5D%2CopenArray%5B%5D" title="push(r: var RunningRegress; x, y: openArray[float | int])">push(r: var RunningRegress; x, y: openArray[float | int])</a></li>
  109. <li><a class="reference" href="#push%2CRunningStat%2Cfloat" title="push(s: var RunningStat; x: float)">push(s: var RunningStat; x: float)</a></li>
  110. <li><a class="reference" href="#push%2CRunningStat%2Cint" title="push(s: var RunningStat; x: int)">push(s: var RunningStat; x: int)</a></li>
  111. <li><a class="reference" href="#push%2CRunningStat%2CopenArray%5B%5D" title="push(s: var RunningStat; x: openArray[float | int])">push(s: var RunningStat; x: openArray[float | int])</a></li>
  112. </ul>
  113. <ul class="simple nested-toc-section">skewness
  114. <li><a class="reference" href="#skewness%2CRunningStat" title="skewness(s: RunningStat): float">skewness(s: RunningStat): float</a></li>
  115. <li><a class="reference" href="#skewness%2CopenArray%5BT%5D" title="skewness[T](x: openArray[T]): float">skewness[T](x: openArray[T]): float</a></li>
  116. </ul>
  117. <ul class="simple nested-toc-section">skewnessS
  118. <li><a class="reference" href="#skewnessS%2CRunningStat" title="skewnessS(s: RunningStat): float">skewnessS(s: RunningStat): float</a></li>
  119. <li><a class="reference" href="#skewnessS%2CopenArray%5BT%5D" title="skewnessS[T](x: openArray[T]): float">skewnessS[T](x: openArray[T]): float</a></li>
  120. </ul>
  121. <ul class="simple nested-toc-section">slope
  122. <li><a class="reference" href="#slope%2CRunningRegress" title="slope(r: RunningRegress): float">slope(r: RunningRegress): float</a></li>
  123. </ul>
  124. <ul class="simple nested-toc-section">standardDeviation
  125. <li><a class="reference" href="#standardDeviation%2CRunningStat" title="standardDeviation(s: RunningStat): float">standardDeviation(s: RunningStat): float</a></li>
  126. <li><a class="reference" href="#standardDeviation%2CopenArray%5BT%5D" title="standardDeviation[T](x: openArray[T]): float">standardDeviation[T](x: openArray[T]): float</a></li>
  127. </ul>
  128. <ul class="simple nested-toc-section">standardDeviationS
  129. <li><a class="reference" href="#standardDeviationS%2CRunningStat" title="standardDeviationS(s: RunningStat): float">standardDeviationS(s: RunningStat): float</a></li>
  130. <li><a class="reference" href="#standardDeviationS%2CopenArray%5BT%5D" title="standardDeviationS[T](x: openArray[T]): float">standardDeviationS[T](x: openArray[T]): float</a></li>
  131. </ul>
  132. <ul class="simple nested-toc-section">variance
  133. <li><a class="reference" href="#variance%2CRunningStat" title="variance(s: RunningStat): float">variance(s: RunningStat): float</a></li>
  134. <li><a class="reference" href="#variance%2CopenArray%5BT%5D" title="variance[T](x: openArray[T]): float">variance[T](x: openArray[T]): float</a></li>
  135. </ul>
  136. <ul class="simple nested-toc-section">varianceS
  137. <li><a class="reference" href="#varianceS%2CRunningStat" title="varianceS(s: RunningStat): float">varianceS(s: RunningStat): float</a></li>
  138. <li><a class="reference" href="#varianceS%2CopenArray%5BT%5D" title="varianceS[T](x: openArray[T]): float">varianceS[T](x: openArray[T]): float</a></li>
  139. </ul>
  140. </ul>
  141. </details>
  142. </li>
  143. </ul>
  144. </div>
  145. <div class="nine columns" id="content">
  146. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  147. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  148. <div id="tocRoot"></div>
  149. <p class="module-desc"><p>Statistical analysis framework for performing basic statistical analysis of data. The data is analysed in a single pass, when it is pushed to a <tt class="docutils literal"><span class="pre"><span class="Identifier">RunningStat</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">RunningRegress</span></span></tt> object.</p>
  150. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">RunningStat</span></span></tt> calculates for a single data set</p>
  151. <ul class="simple"><li>n (data count)</li>
  152. <li>min (smallest value)</li>
  153. <li>max (largest value)</li>
  154. <li>sum</li>
  155. <li>mean</li>
  156. <li>variance</li>
  157. <li>varianceS (sample variance)</li>
  158. <li>standardDeviation</li>
  159. <li>standardDeviationS (sample standard deviation)</li>
  160. <li>skewness (the third statistical moment)</li>
  161. <li>kurtosis (the fourth statistical moment)</li>
  162. </ul>
  163. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">RunningRegress</span></span></tt> calculates for two sets of data</p>
  164. <ul class="simple"><li>n (data count)</li>
  165. <li>slope</li>
  166. <li>intercept</li>
  167. <li>correlation</li>
  168. </ul>
  169. <p>Procs are provided to calculate statistics on <tt class="docutils literal"><span class="pre"><span class="Identifier">openArray</span></span></tt>s.</p>
  170. <p>However, if more than a single statistical calculation is required, it is more efficient to push the data once to a <tt class="docutils literal"><span class="pre"><span class="Identifier">RunningStat</span></span></tt> object and then call the numerous statistical procs for the <tt class="docutils literal"><span class="pre"><span class="Identifier">RunningStat</span></span></tt> object:</p>
  171. <p><strong class="examples_text">Example:</strong></p>
  172. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">stats</span>
  173. <span class="Keyword">from</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">math</span> <span class="Keyword">import</span> <span class="Identifier">almostEqual</span>
  174. <span class="Keyword">template</span> <span class="Punctuation">`</span><span class="Operator">~=</span><span class="Punctuation">`</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">:</span> <span class="Identifier">float</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">bool</span> <span class="Operator">=</span> <span class="Identifier">almostEqual</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">)</span>
  175. <span class="Keyword">var</span> <span class="Identifier">statistics</span><span class="Punctuation">:</span> <span class="Identifier">RunningStat</span> <span class="Comment"># must be var</span>
  176. <span class="Identifier">statistics</span><span class="Operator">.</span><span class="Identifier">push</span><span class="Punctuation">(</span><span class="Operator">@</span><span class="Punctuation">[</span><span class="FloatNumber">1.0</span><span class="Punctuation">,</span> <span class="FloatNumber">2.0</span><span class="Punctuation">,</span> <span class="FloatNumber">1.0</span><span class="Punctuation">,</span> <span class="FloatNumber">4.0</span><span class="Punctuation">,</span> <span class="FloatNumber">1.0</span><span class="Punctuation">,</span> <span class="FloatNumber">4.0</span><span class="Punctuation">,</span> <span class="FloatNumber">1.0</span><span class="Punctuation">,</span> <span class="FloatNumber">2.0</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
  177. <span class="Identifier">doAssert</span> <span class="Identifier">statistics</span><span class="Operator">.</span><span class="Identifier">n</span> <span class="Operator">==</span> <span class="DecNumber">8</span>
  178. <span class="Identifier">doAssert</span> <span class="Identifier">statistics</span><span class="Operator">.</span><span class="Identifier">mean</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">~=</span> <span class="FloatNumber">2.0</span>
  179. <span class="Identifier">doAssert</span> <span class="Identifier">statistics</span><span class="Operator">.</span><span class="Identifier">variance</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">~=</span> <span class="FloatNumber">1.5</span>
  180. <span class="Identifier">doAssert</span> <span class="Identifier">statistics</span><span class="Operator">.</span><span class="Identifier">varianceS</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">~=</span> <span class="FloatNumber">1.714285714285715</span>
  181. <span class="Identifier">doAssert</span> <span class="Identifier">statistics</span><span class="Operator">.</span><span class="Identifier">skewness</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">~=</span> <span class="FloatNumber">0.8164965809277261</span>
  182. <span class="Identifier">doAssert</span> <span class="Identifier">statistics</span><span class="Operator">.</span><span class="Identifier">skewnessS</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">~=</span> <span class="FloatNumber">1.018350154434631</span>
  183. <span class="Identifier">doAssert</span> <span class="Identifier">statistics</span><span class="Operator">.</span><span class="Identifier">kurtosis</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">~=</span> <span class="Operator">-</span><span class="FloatNumber">1.0</span>
  184. <span class="Identifier">doAssert</span> <span class="Identifier">statistics</span><span class="Operator">.</span><span class="Identifier">kurtosisS</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">~=</span> <span class="Operator">-</span><span class="FloatNumber">0.7000000000000008</span></pre></p>
  185. <div class="section" id="6">
  186. <h1><a class="toc-backref" href="#6">Imports</a></h1>
  187. <dl class="item">
  188. <a class="reference external" href="math.html">math</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="formatfloat.html">formatfloat</a>
  189. </dl>
  190. </div>
  191. <div class="section" id="7">
  192. <h1><a class="toc-backref" href="#7">Types</a></h1>
  193. <dl class="item">
  194. <div id="RunningRegress">
  195. <dt><pre><a href="stats.html#RunningRegress"><span class="Identifier">RunningRegress</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
  196. <span class="Identifier">n</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Comment">## amount of pushed data</span>
  197. <span class="Identifier">x_stats</span><span class="Operator">*</span><span class="Other">:</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a> <span class="Comment">## stats for the first set of data</span>
  198. <span class="Identifier">y_stats</span><span class="Operator">*</span><span class="Other">:</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a> <span class="Comment">## stats for the second set of data</span>
  199. <span class="Comment">## accumulated data for combined xy</span></pre></dt>
  200. <dd>
  201. An accumulator for regression calculations.
  202. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L71" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  203. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L71" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  204. </dd>
  205. </div>
  206. <div id="RunningStat">
  207. <dt><pre><a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
  208. <span class="Identifier">n</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Comment">## amount of pushed data</span>
  209. <span class="Identifier">min</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">max</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">sum</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> <span class="Comment">## self-explaining</span>
  210. <span class="Comment">## statistical moments, mom1 is mean</span></pre></dt>
  211. <dd>
  212. An accumulator for statistical data.
  213. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L66" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  214. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L66" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  215. </dd>
  216. </div>
  217. </dl>
  218. </div>
  219. <div class="section" id="12">
  220. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  221. <dl class="item">
  222. <div id="$-procs-all">
  223. <div id="$,RunningStat">
  224. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CRunningStat"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<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>
  225. <dd>
  226. Produces a string representation of the <tt class="docutils literal"><span class="pre"><span class="Identifier">RunningStat</span></span></tt>. The exact format is currently unspecified and subject to change. Currently it contains:<ul class="simple"><li>the number of probes</li>
  227. <li>min, max values</li>
  228. <li>sum, mean and standard deviation.</li>
  229. </ul>
  230. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L199" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  231. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L199" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  232. </dd>
  233. </div>
  234. </div>
  235. <div id="+-procs-all">
  236. <div id="+,RunningRegress,RunningRegress">
  237. <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2CRunningRegress%2CRunningRegress"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="stats.html#RunningRegress"><span class="Identifier">RunningRegress</span></a><span class="Other">)</span><span class="Other">:</span> <a href="stats.html#RunningRegress"><span class="Identifier">RunningRegress</span></a> {.<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>
  238. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  239. <dd>
  240. <p>Combines two <tt class="docutils literal"><span class="pre"><span class="Identifier">RunningRegress</span></span></tt> objects.</p>
  241. <p>Useful when performing parallel analysis of data series and needing to re-combine parallel result sets</p>
  242. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L317" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  243. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L317" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  244. </dd>
  245. </div>
  246. <div id="+,RunningStat,RunningStat">
  247. <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2CRunningStat%2CRunningStat"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a><span class="Other">)</span><span class="Other">:</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a> {.<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>
  248. <dd>
  249. <p>Combines two <tt class="docutils literal"><span class="pre"><span class="Identifier">RunningStat</span></span></tt>s.</p>
  250. <p>Useful when performing parallel analysis of data series and needing to re-combine parallel result sets.</p>
  251. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L166" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  252. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L166" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  253. </dd>
  254. </div>
  255. </div>
  256. <div id="+=-procs-all">
  257. <div id="+=,RunningRegress,RunningRegress">
  258. <dt><pre><span class="Keyword">proc</span> <a href="#%2B%3D%2CRunningRegress%2CRunningRegress"><span class="Identifier">`+=`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="stats.html#RunningRegress"><span class="Identifier">RunningRegress</span></a><span class="Other">;</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="stats.html#RunningRegress"><span class="Identifier">RunningRegress</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>
  259. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  260. <dd>
  261. Adds the <tt class="docutils literal"><span class="pre"><span class="Identifier">RunningRegress</span></span></tt> <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
  262. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L333" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  263. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L333" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  264. </dd>
  265. </div>
  266. <div id="+=,RunningStat,RunningStat">
  267. <dt><pre><span class="Keyword">proc</span> <a href="#%2B%3D%2CRunningStat%2CRunningStat"><span class="Identifier">`+=`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a><span class="Other">;</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a><span class="Other">)</span> {.<span class="Identifier">inline</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>
  268. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  269. <dd>
  270. Adds the <tt class="docutils literal"><span class="pre"><span class="Identifier">RunningStat</span></span></tt> <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
  271. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L195" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  272. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L195" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  273. </dd>
  274. </div>
  275. </div>
  276. <div id="clear-procs-all">
  277. <div id="clear,RunningRegress">
  278. <dt><pre><span class="Keyword">proc</span> <a href="#clear%2CRunningRegress"><span class="Identifier">clear</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="stats.html#RunningRegress"><span class="Identifier">RunningRegress</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>
  279. <dd>
  280. Resets <tt class="docutils literal"><span class="pre"><span class="Identifier">r</span></span></tt>.
  281. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L274" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  282. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L274" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  283. </dd>
  284. </div>
  285. <div id="clear,RunningStat">
  286. <dt><pre><span class="Keyword">proc</span> <a href="#clear%2CRunningStat"><span class="Identifier">clear</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</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>
  287. <dd>
  288. Resets <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.
  289. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L79" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  290. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L79" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  291. </dd>
  292. </div>
  293. </div>
  294. <div id="correlation-procs-all">
  295. <div id="correlation,RunningRegress">
  296. <dt><pre><span class="Keyword">proc</span> <a href="#correlation%2CRunningRegress"><span class="Identifier">correlation</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="stats.html#RunningRegress"><span class="Identifier">RunningRegress</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<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>
  297. <dd>
  298. Computes the current correlation of the two data sets pushed into <tt class="docutils literal"><span class="pre"><span class="Identifier">r</span></span></tt>.
  299. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L311" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  300. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L311" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  301. </dd>
  302. </div>
  303. </div>
  304. <div id="intercept-procs-all">
  305. <div id="intercept,RunningRegress">
  306. <dt><pre><span class="Keyword">proc</span> <a href="#intercept%2CRunningRegress"><span class="Identifier">intercept</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="stats.html#RunningRegress"><span class="Identifier">RunningRegress</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<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>
  307. <dd>
  308. Computes the current intercept of <tt class="docutils literal"><span class="pre"><span class="Identifier">r</span></span></tt>.
  309. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L307" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  310. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L307" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  311. </dd>
  312. </div>
  313. </div>
  314. <div id="kurtosis-procs-all">
  315. <div id="kurtosis,RunningStat">
  316. <dt><pre><span class="Keyword">proc</span> <a href="#kurtosis%2CRunningStat"><span class="Identifier">kurtosis</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<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>
  317. <dd>
  318. Computes the current population kurtosis of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.
  319. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L157" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  320. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L157" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  321. </dd>
  322. </div>
  323. <div id="kurtosis,openArray[T]">
  324. <dt><pre><span class="Keyword">proc</span> <a href="#kurtosis%2CopenArray%5BT%5D"><span class="Identifier">kurtosis</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="system.html#openArray"><span class="Identifier">openArray</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>
  325. <dd>
  326. Computes the population kurtosis of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
  327. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L260" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  328. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L260" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  329. </dd>
  330. </div>
  331. </div>
  332. <div id="kurtosisS-procs-all">
  333. <div id="kurtosisS,RunningStat">
  334. <dt><pre><span class="Keyword">proc</span> <a href="#kurtosisS%2CRunningStat"><span class="Identifier">kurtosisS</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<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>
  335. <dd>
  336. Computes the current sample kurtosis of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.
  337. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L161" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  338. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L161" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  339. </dd>
  340. </div>
  341. <div id="kurtosisS,openArray[T]">
  342. <dt><pre><span class="Keyword">proc</span> <a href="#kurtosisS%2CopenArray%5BT%5D"><span class="Identifier">kurtosisS</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="system.html#openArray"><span class="Identifier">openArray</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>
  343. <dd>
  344. Computes the sample kurtosis of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
  345. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L266" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  346. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L266" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  347. </dd>
  348. </div>
  349. </div>
  350. <div id="mean-procs-all">
  351. <div id="mean,RunningStat">
  352. <dt><pre><span class="Keyword">proc</span> <a href="#mean%2CRunningStat"><span class="Identifier">mean</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<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>
  353. <dd>
  354. Computes the current mean of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.
  355. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L127" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  356. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L127" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  357. </dd>
  358. </div>
  359. <div id="mean,openArray[T]">
  360. <dt><pre><span class="Keyword">proc</span> <a href="#mean%2CopenArray%5BT%5D"><span class="Identifier">mean</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="system.html#openArray"><span class="Identifier">openArray</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>
  361. <dd>
  362. Computes the mean of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
  363. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L218" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  364. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L218" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  365. </dd>
  366. </div>
  367. </div>
  368. <div id="push-procs-all">
  369. <div id="push,RunningRegress,float,float">
  370. <dt><pre><span class="Keyword">proc</span> <a href="#push%2CRunningRegress%2Cfloat%2Cfloat"><span class="Identifier">push</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="stats.html#RunningRegress"><span class="Identifier">RunningRegress</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="system.html#float"><span class="Identifier">float</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>
  371. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  372. <dd>
  373. Pushes two values <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> for processing.
  374. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L281" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  375. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L281" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  376. </dd>
  377. </div>
  378. <div id="push,RunningRegress,int,int">
  379. <dt><pre><span class="Keyword">proc</span> <a href="#push%2CRunningRegress%2Cint%2Cint"><span class="Identifier">push</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="stats.html#RunningRegress"><span class="Identifier">RunningRegress</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="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span> {.<span class="Identifier">inline</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>
  380. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  381. <dd>
  382. <p>Pushes two values <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> for processing.</p>
  383. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> are converted to <tt class="docutils literal"><span class="pre"><span class="Identifier">float</span></span></tt> and the other push operation is called.</p>
  384. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L289" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  385. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L289" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  386. </dd>
  387. </div>
  388. <div id="push,RunningRegress,openArray[],openArray[]">
  389. <dt><pre><span class="Keyword">proc</span> <a href="#push%2CRunningRegress%2CopenArray%5B%5D%2CopenArray%5B%5D"><span class="Identifier">push</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="stats.html#RunningRegress"><span class="Identifier">RunningRegress</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="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#float"><span class="Identifier">float</span></a> <span class="Operator">|</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span><span class="Other">)</span></pre></dt>
  390. <dd>
  391. Pushes two sets of values <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> for processing.
  392. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L296" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  393. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L296" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  394. </dd>
  395. </div>
  396. <div id="push,RunningStat,float">
  397. <dt><pre><span class="Keyword">proc</span> <a href="#push%2CRunningStat%2Cfloat"><span class="Identifier">push</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</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><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>
  398. <dd>
  399. Pushes a value <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> for processing.
  400. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L90" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  401. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L90" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  402. </dd>
  403. </div>
  404. <div id="push,RunningStat,int">
  405. <dt><pre><span class="Keyword">proc</span> <a href="#push%2CRunningStat%2Cint"><span class="Identifier">push</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a><span class="Other">;</span> <span class="Identifier">x</span><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>
  406. <dd>
  407. <p>Pushes a value <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> for processing.</p>
  408. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is simply converted to <tt class="docutils literal"><span class="pre"><span class="Identifier">float</span></span></tt> and the other push operation is called.</p>
  409. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L112" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  410. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L112" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  411. </dd>
  412. </div>
  413. <div id="push,RunningStat,openArray[]">
  414. <dt><pre><span class="Keyword">proc</span> <a href="#push%2CRunningStat%2CopenArray%5B%5D"><span class="Identifier">push</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#float"><span class="Identifier">float</span></a> <span class="Operator">|</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span><span class="Other">)</span></pre></dt>
  415. <dd>
  416. <p>Pushes all values of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> for processing.</p>
  417. <p>Int values of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> are simply converted to <tt class="docutils literal"><span class="pre"><span class="Identifier">float</span></span></tt> and the other push operation is called.</p>
  418. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L119" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  419. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L119" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  420. </dd>
  421. </div>
  422. </div>
  423. <div id="skewness-procs-all">
  424. <div id="skewness,RunningStat">
  425. <dt><pre><span class="Keyword">proc</span> <a href="#skewness%2CRunningStat"><span class="Identifier">skewness</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<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>
  426. <dd>
  427. Computes the current population skewness of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.
  428. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L148" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  429. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L148" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  430. </dd>
  431. </div>
  432. <div id="skewness,openArray[T]">
  433. <dt><pre><span class="Keyword">proc</span> <a href="#skewness%2CopenArray%5BT%5D"><span class="Identifier">skewness</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="system.html#openArray"><span class="Identifier">openArray</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>
  434. <dd>
  435. Computes the population skewness of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
  436. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L248" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  437. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L248" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  438. </dd>
  439. </div>
  440. </div>
  441. <div id="skewnessS-procs-all">
  442. <div id="skewnessS,RunningStat">
  443. <dt><pre><span class="Keyword">proc</span> <a href="#skewnessS%2CRunningStat"><span class="Identifier">skewnessS</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<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>
  444. <dd>
  445. Computes the current sample skewness of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.
  446. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L152" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  447. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L152" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  448. </dd>
  449. </div>
  450. <div id="skewnessS,openArray[T]">
  451. <dt><pre><span class="Keyword">proc</span> <a href="#skewnessS%2CopenArray%5BT%5D"><span class="Identifier">skewnessS</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="system.html#openArray"><span class="Identifier">openArray</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>
  452. <dd>
  453. Computes the sample skewness of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
  454. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L254" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  455. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L254" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  456. </dd>
  457. </div>
  458. </div>
  459. <div id="slope-procs-all">
  460. <div id="slope,RunningRegress">
  461. <dt><pre><span class="Keyword">proc</span> <a href="#slope%2CRunningRegress"><span class="Identifier">slope</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="stats.html#RunningRegress"><span class="Identifier">RunningRegress</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<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>
  462. <dd>
  463. Computes the current slope of <tt class="docutils literal"><span class="pre"><span class="Identifier">r</span></span></tt>.
  464. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L302" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  465. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L302" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  466. </dd>
  467. </div>
  468. </div>
  469. <div id="standardDeviation-procs-all">
  470. <div id="standardDeviation,RunningStat">
  471. <dt><pre><span class="Keyword">proc</span> <a href="#standardDeviation%2CRunningStat"><span class="Identifier">standardDeviation</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<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>
  472. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  473. <dd>
  474. Computes the current population standard deviation of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.
  475. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L140" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  476. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L140" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  477. </dd>
  478. </div>
  479. <div id="standardDeviation,openArray[T]">
  480. <dt><pre><span class="Keyword">proc</span> <a href="#standardDeviation%2CopenArray%5BT%5D"><span class="Identifier">standardDeviation</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="system.html#openArray"><span class="Identifier">openArray</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>
  481. <dd>
  482. Computes the population standard deviation of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
  483. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L236" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  484. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L236" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  485. </dd>
  486. </div>
  487. </div>
  488. <div id="standardDeviationS-procs-all">
  489. <div id="standardDeviationS,RunningStat">
  490. <dt><pre><span class="Keyword">proc</span> <a href="#standardDeviationS%2CRunningStat"><span class="Identifier">standardDeviationS</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<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>
  491. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  492. <dd>
  493. Computes the current sample standard deviation of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.
  494. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L144" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  495. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L144" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  496. </dd>
  497. </div>
  498. <div id="standardDeviationS,openArray[T]">
  499. <dt><pre><span class="Keyword">proc</span> <a href="#standardDeviationS%2CopenArray%5BT%5D"><span class="Identifier">standardDeviationS</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="system.html#openArray"><span class="Identifier">openArray</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>
  500. <dd>
  501. Computes the sample standard deviation of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
  502. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L242" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  503. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L242" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  504. </dd>
  505. </div>
  506. </div>
  507. <div id="variance-procs-all">
  508. <div id="variance,RunningStat">
  509. <dt><pre><span class="Keyword">proc</span> <a href="#variance%2CRunningStat"><span class="Identifier">variance</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<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>
  510. <dd>
  511. Computes the current population variance of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.
  512. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L131" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  513. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L131" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  514. </dd>
  515. </div>
  516. <div id="variance,openArray[T]">
  517. <dt><pre><span class="Keyword">proc</span> <a href="#variance%2CopenArray%5BT%5D"><span class="Identifier">variance</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="system.html#openArray"><span class="Identifier">openArray</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>
  518. <dd>
  519. Computes the population variance of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
  520. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L224" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  521. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L224" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  522. </dd>
  523. </div>
  524. </div>
  525. <div id="varianceS-procs-all">
  526. <div id="varianceS,RunningStat">
  527. <dt><pre><span class="Keyword">proc</span> <a href="#varianceS%2CRunningStat"><span class="Identifier">varianceS</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="stats.html#RunningStat"><span class="Identifier">RunningStat</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<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>
  528. <dd>
  529. Computes the current sample variance of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.
  530. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L135" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  531. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L135" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  532. </dd>
  533. </div>
  534. <div id="varianceS,openArray[T]">
  535. <dt><pre><span class="Keyword">proc</span> <a href="#varianceS%2CopenArray%5BT%5D"><span class="Identifier">varianceS</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="system.html#openArray"><span class="Identifier">openArray</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>
  536. <dd>
  537. Computes the sample variance of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
  538. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/stats.nim#L230" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  539. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/stats.nim#L230" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  540. </dd>
  541. </div>
  542. </div>
  543. </dl>
  544. </div>
  545. </div>
  546. </div>
  547. <div class="twelve-columns footer">
  548. <span class="nim-sprite"></span>
  549. <br>
  550. <small style="color: var(--hint);">Made with Nim. Generated: 2025-03-15 14:13:33 UTC</small>
  551. </div>
  552. </div>
  553. </div>
  554. <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
  555. </body>
  556. </html>