README.md (15299B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2018 The Stdlib Authors. 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 19 --> 20 21 # Iterator Statistics 22 23 > Standard library functions for computing statistics over iterators. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var ns = require( '@stdlib/stats/iter' ); 31 ``` 32 33 #### ns 34 35 Standard library functions for computing statistics over iterators. 36 37 ```javascript 38 var o = ns; 39 // returns {...} 40 ``` 41 42 <!-- <toc pattern="*"> --> 43 44 <div class="namespace-toc"> 45 46 - <span class="signature">[`itercugmean( iterator )`][@stdlib/stats/iter/cugmean]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a cumulative geometric mean.</span> 47 - <span class="signature">[`itercuhmean( iterator )`][@stdlib/stats/iter/cuhmean]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a cumulative harmonic mean.</span> 48 - <span class="signature">[`itercumax( iterator )`][@stdlib/stats/iter/cumax]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a cumulative maximum value.</span> 49 - <span class="signature">[`itercumaxabs( iterator )`][@stdlib/stats/iter/cumaxabs]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a cumulative maximum absolute value.</span> 50 - <span class="signature">[`itercumean( iterator )`][@stdlib/stats/iter/cumean]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a cumulative arithmetic mean.</span> 51 - <span class="signature">[`itercumeanabs( iterator )`][@stdlib/stats/iter/cumeanabs]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a cumulative arithmetic mean of absolute values.</span> 52 - <span class="signature">[`itercumeanabs2( iterator )`][@stdlib/stats/iter/cumeanabs2]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a cumulative arithmetic mean of squared absolute values.</span> 53 - <span class="signature">[`itercumidrange( iterator )`][@stdlib/stats/iter/cumidrange]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a cumulative mid-range.</span> 54 - <span class="signature">[`itercumin( iterator )`][@stdlib/stats/iter/cumin]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a cumulative minimum value.</span> 55 - <span class="signature">[`itercuminabs( iterator )`][@stdlib/stats/iter/cuminabs]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a cumulative minimum absolute value.</span> 56 - <span class="signature">[`itercuprod( iterator )`][@stdlib/stats/iter/cuprod]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a cumulative product.</span> 57 - <span class="signature">[`itercurange( iterator )`][@stdlib/stats/iter/curange]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a cumulative range.</span> 58 - <span class="signature">[`itercusum( iterator )`][@stdlib/stats/iter/cusum]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a cumulative sum.</span> 59 - <span class="signature">[`itercusumabs( iterator )`][@stdlib/stats/iter/cusumabs]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a cumulative sum of absolute values.</span> 60 - <span class="signature">[`itercusumabs2( iterator )`][@stdlib/stats/iter/cusumabs2]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a cumulative sum of squared absolute values.</span> 61 - <span class="signature">[`itermax( iterator )`][@stdlib/stats/iter/max]</span><span class="delimiter">: </span><span class="description">compute the maximum value of all iterated values.</span> 62 - <span class="signature">[`itermaxabs( iterator )`][@stdlib/stats/iter/maxabs]</span><span class="delimiter">: </span><span class="description">compute the maximum absolute value of all iterated values.</span> 63 - <span class="signature">[`itermean( iterator )`][@stdlib/stats/iter/mean]</span><span class="delimiter">: </span><span class="description">compute the arithmetic mean over all iterated values.</span> 64 - <span class="signature">[`itermeanabs( iterator )`][@stdlib/stats/iter/meanabs]</span><span class="delimiter">: </span><span class="description">compute the arithmetic mean of absolute values for all iterated values.</span> 65 - <span class="signature">[`itermeanabs2( iterator )`][@stdlib/stats/iter/meanabs2]</span><span class="delimiter">: </span><span class="description">compute the arithmetic mean of squared absolute values for all iterated values.</span> 66 - <span class="signature">[`itermidrange( iterator )`][@stdlib/stats/iter/midrange]</span><span class="delimiter">: </span><span class="description">compute the mid-range of all iterated values.</span> 67 - <span class="signature">[`itermin( iterator )`][@stdlib/stats/iter/min]</span><span class="delimiter">: </span><span class="description">compute the minimum value of all iterated values.</span> 68 - <span class="signature">[`iterminabs( iterator )`][@stdlib/stats/iter/minabs]</span><span class="delimiter">: </span><span class="description">compute the minimum absolute value of all iterated values.</span> 69 - <span class="signature">[`itermmax( iterator, W )`][@stdlib/stats/iter/mmax]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a moving maximum value.</span> 70 - <span class="signature">[`itermmaxabs( iterator, W )`][@stdlib/stats/iter/mmaxabs]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a moving maximum absolute value.</span> 71 - <span class="signature">[`itermmean( iterator, W )`][@stdlib/stats/iter/mmean]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a moving arithmetic mean.</span> 72 - <span class="signature">[`itermmeanabs( iterator, W )`][@stdlib/stats/iter/mmeanabs]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a moving arithmetic mean of absolute values.</span> 73 - <span class="signature">[`itermmeanabs2( iterator, W )`][@stdlib/stats/iter/mmeanabs2]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a moving arithmetic mean of squared absolute values.</span> 74 - <span class="signature">[`itermmidrange( iterator, W )`][@stdlib/stats/iter/mmidrange]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a moving mid-range.</span> 75 - <span class="signature">[`itermmin( iterator, W )`][@stdlib/stats/iter/mmin]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a moving minimum value.</span> 76 - <span class="signature">[`itermminabs( iterator, W )`][@stdlib/stats/iter/mminabs]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a moving minimum absolute value.</span> 77 - <span class="signature">[`itermprod( iterator, W )`][@stdlib/stats/iter/mprod]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a moving product.</span> 78 - <span class="signature">[`itermrange( iterator, W )`][@stdlib/stats/iter/mrange]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a moving range.</span> 79 - <span class="signature">[`itermsum( iterator, W )`][@stdlib/stats/iter/msum]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a moving sum.</span> 80 - <span class="signature">[`itermsumabs( iterator, W )`][@stdlib/stats/iter/msumabs]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a moving sum of absolute values.</span> 81 - <span class="signature">[`itermsumabs2( iterator, W )`][@stdlib/stats/iter/msumabs2]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively computes a moving sum of squared absolute values.</span> 82 - <span class="signature">[`iterprod( iterator )`][@stdlib/stats/iter/prod]</span><span class="delimiter">: </span><span class="description">compute the product of all iterated values.</span> 83 - <span class="signature">[`iterrange( iterator )`][@stdlib/stats/iter/range]</span><span class="delimiter">: </span><span class="description">compute the range of all iterated values.</span> 84 - <span class="signature">[`iterstdev( iterator[, mean] )`][@stdlib/stats/iter/stdev]</span><span class="delimiter">: </span><span class="description">compute the corrected sample standard deviation over all iterated values.</span> 85 - <span class="signature">[`itersum( iterator )`][@stdlib/stats/iter/sum]</span><span class="delimiter">: </span><span class="description">compute the sum of all iterated values.</span> 86 - <span class="signature">[`itersumabs( iterator )`][@stdlib/stats/iter/sumabs]</span><span class="delimiter">: </span><span class="description">compute the sum of absolute values for all iterated values.</span> 87 - <span class="signature">[`itersumabs2( iterator )`][@stdlib/stats/iter/sumabs2]</span><span class="delimiter">: </span><span class="description">compute the sum of squared absolute values for all iterated values.</span> 88 - <span class="signature">[`itervariance( iterator[, mean] )`][@stdlib/stats/iter/variance]</span><span class="delimiter">: </span><span class="description">compute the unbiased sample variance over all iterated values.</span> 89 90 </div> 91 92 <!-- </toc> --> 93 94 </section> 95 96 <!-- /.usage --> 97 98 <section class="examples"> 99 100 ## Examples 101 102 <!-- TODO: better examples --> 103 104 <!-- eslint no-undef: "error" --> 105 106 ```javascript 107 var getKeys = require( '@stdlib/utils/keys' ); 108 var ns = require( '@stdlib/stats/iter' ); 109 110 console.log( getKeys( ns ) ); 111 ``` 112 113 </section> 114 115 <!-- /.examples --> 116 117 <section class="links"> 118 119 <!-- <toc-links> --> 120 121 [@stdlib/stats/iter/cugmean]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/cugmean 122 123 [@stdlib/stats/iter/cuhmean]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/cuhmean 124 125 [@stdlib/stats/iter/cumax]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/cumax 126 127 [@stdlib/stats/iter/cumaxabs]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/cumaxabs 128 129 [@stdlib/stats/iter/cumean]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/cumean 130 131 [@stdlib/stats/iter/cumeanabs]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/cumeanabs 132 133 [@stdlib/stats/iter/cumeanabs2]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/cumeanabs2 134 135 [@stdlib/stats/iter/cumidrange]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/cumidrange 136 137 [@stdlib/stats/iter/cumin]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/cumin 138 139 [@stdlib/stats/iter/cuminabs]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/cuminabs 140 141 [@stdlib/stats/iter/cuprod]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/cuprod 142 143 [@stdlib/stats/iter/curange]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/curange 144 145 [@stdlib/stats/iter/cusum]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/cusum 146 147 [@stdlib/stats/iter/cusumabs]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/cusumabs 148 149 [@stdlib/stats/iter/cusumabs2]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/cusumabs2 150 151 [@stdlib/stats/iter/max]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/max 152 153 [@stdlib/stats/iter/maxabs]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/maxabs 154 155 [@stdlib/stats/iter/mean]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/mean 156 157 [@stdlib/stats/iter/meanabs]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/meanabs 158 159 [@stdlib/stats/iter/meanabs2]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/meanabs2 160 161 [@stdlib/stats/iter/midrange]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/midrange 162 163 [@stdlib/stats/iter/min]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/min 164 165 [@stdlib/stats/iter/minabs]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/minabs 166 167 [@stdlib/stats/iter/mmax]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/mmax 168 169 [@stdlib/stats/iter/mmaxabs]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/mmaxabs 170 171 [@stdlib/stats/iter/mmean]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/mmean 172 173 [@stdlib/stats/iter/mmeanabs]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/mmeanabs 174 175 [@stdlib/stats/iter/mmeanabs2]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/mmeanabs2 176 177 [@stdlib/stats/iter/mmidrange]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/mmidrange 178 179 [@stdlib/stats/iter/mmin]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/mmin 180 181 [@stdlib/stats/iter/mminabs]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/mminabs 182 183 [@stdlib/stats/iter/mprod]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/mprod 184 185 [@stdlib/stats/iter/mrange]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/mrange 186 187 [@stdlib/stats/iter/msum]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/msum 188 189 [@stdlib/stats/iter/msumabs]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/msumabs 190 191 [@stdlib/stats/iter/msumabs2]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/msumabs2 192 193 [@stdlib/stats/iter/prod]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/prod 194 195 [@stdlib/stats/iter/range]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/range 196 197 [@stdlib/stats/iter/stdev]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/stdev 198 199 [@stdlib/stats/iter/sum]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/sum 200 201 [@stdlib/stats/iter/sumabs]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/sumabs 202 203 [@stdlib/stats/iter/sumabs2]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/sumabs2 204 205 [@stdlib/stats/iter/variance]: https://www.npmjs.com/package/@stdlib/stats/tree/main/iter/variance 206 207 <!-- </toc-links> --> 208 209 </section> 210 211 <!-- /.links -->