Skip to content

Commit 03c441f

Browse files
authored
docs: update example
Signed-off-by: Athan <[email protected]>
1 parent 9c18350 commit 03c441f

File tree

1 file changed

+5
-42
lines changed
  • lib/node_modules/@stdlib/stats/incr/nanstdev

1 file changed

+5
-42
lines changed

lib/node_modules/@stdlib/stats/incr/nanstdev/README.md

Lines changed: 5 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -109,24 +109,17 @@ s = accumulator();
109109
<!-- eslint no-undef: "error" -->
110110

111111
```javascript
112-
var randu = require( '@stdlib/random/base/randu' );
112+
var uniform = require( '@stdlib/random/base/uniform' );
113+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
113114
var incrnanstdev = require( '@stdlib/stats/incr/nanstdev' );
114115

115-
var accumulator;
116-
var v;
117-
var i;
118-
119116
// Initialize an accumulator:
120-
accumulator = incrnanstdev();
117+
var accumulator = incrnanstdev();
121118

122119
// For each simulated datum, update the sample standard deviation...
120+
var i;
123121
for ( i = 0; i < 100; i++ ) {
124-
if ( randu() < 0.2 ) {
125-
v = NaN;
126-
} else {
127-
v = randu() * 100.0;
128-
}
129-
accumulator( v );
122+
accumulator( ( bernoulli( 0.8 ) < 1 ) ? NaN : uniform( 0.0, 100.0 ) );
130123
}
131124
console.log( accumulator() );
132125
```
@@ -139,18 +132,6 @@ console.log( accumulator() );
139132

140133
<section class="related">
141134

142-
* * *
143-
144-
## See Also
145-
146-
- <span class="package-name">[`@stdlib/stats/incr/kurtosis`][@stdlib/stats/incr/kurtosis]</span><span class="delimiter">: </span><span class="description">compute a corrected sample excess kurtosis incrementally.</span>
147-
- <span class="package-name">[`@stdlib/stats/incr/mean`][@stdlib/stats/incr/mean]</span><span class="delimiter">: </span><span class="description">compute an arithmetic mean incrementally.</span>
148-
- <span class="package-name">[`@stdlib/stats/incr/mstdev`][@stdlib/stats/incr/mstdev]</span><span class="delimiter">: </span><span class="description">compute a moving corrected sample standard deviation incrementally.</span>
149-
- <span class="package-name">[`@stdlib/stats/incr/skewness`][@stdlib/stats/incr/skewness]</span><span class="delimiter">: </span><span class="description">compute a corrected sample skewness incrementally.</span>
150-
- <span class="package-name">[`@stdlib/stats/incr/summary`][@stdlib/stats/incr/summary]</span><span class="delimiter">: </span><span class="description">compute a statistical summary incrementally.</span>
151-
- <span class="package-name">[`@stdlib/stats/incr/variance`][@stdlib/stats/incr/variance]</span><span class="delimiter">: </span><span class="description">compute an unbiased sample variance incrementally.</span>
152-
- <span class="package-name">[`@stdlib/stats/incr/stdev`][@stdlib/stats/incr/stdev]</span><span class="delimiter">: </span><span class="description">compute a [corrected sample standard deviation][sample-stdev] incrementally.</span>
153-
154135
</section>
155136

156137
<!-- /.related -->
@@ -161,24 +142,6 @@ console.log( accumulator() );
161142

162143
[sample-stdev]: https://en.wikipedia.org/wiki/Standard_deviation
163144

164-
<!-- <related-links> -->
165-
166-
[@stdlib/stats/incr/kurtosis]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/kurtosis
167-
168-
[@stdlib/stats/incr/mean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/mean
169-
170-
[@stdlib/stats/incr/mstdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/mstdev
171-
172-
[@stdlib/stats/incr/skewness]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/skewness
173-
174-
[@stdlib/stats/incr/summary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/summary
175-
176-
[@stdlib/stats/incr/variance]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/variance
177-
178-
[@stdlib/stats/incr/stdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/nanstdev
179-
180-
<!-- </related-links> -->
181-
182145
</section>
183146

184147
<!-- /.links -->

0 commit comments

Comments
 (0)