Skip to content

Commit b148617

Browse files
committed
chore: clean-up
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent b4493b9 commit b148617

File tree

7 files changed

+41
-71
lines changed

7 files changed

+41
-71
lines changed

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

Lines changed: 8 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ var incrnanskewness = require( '@stdlib/stats/incr/nanskewness' );
8585

8686
#### incrnanskewness()
8787

88-
Returns an accumulator `function` which incrementally computes a [corrected sample skewness][sample-skewness], ignoring `NaN` values.
88+
Returns an accumulator function which incrementally computes a [corrected sample skewness][sample-skewness], ignoring `NaN` values.
8989

9090
```javascript
9191
var accumulator = incrnanskewness();
@@ -110,10 +110,10 @@ skewness = accumulator( -5.0 );
110110
skewness = accumulator( -10.0 );
111111
// returns ~0.492
112112

113-
skewness = accumulator();
113+
skewness = accumulator( NaN );
114114
// returns ~0.492
115115

116-
skewness = accumulator(NaN);
116+
skewness = accumulator();
117117
// returns ~0.492
118118
```
119119

@@ -138,24 +138,17 @@ skewness = accumulator(NaN);
138138
<!-- eslint no-undef: "error" -->
139139

140140
```javascript
141-
var randu = require( '@stdlib/random/base/randu' );
141+
var uniform = require( '@stdlib/random/base/uniform' );
142+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
142143
var incrnanskewness = require( '@stdlib/stats/incr/nanskewness' );
143144

144-
var accumulator;
145-
var v;
146-
var i;
147-
148145
// Initialize an accumulator:
149-
accumulator = incrnanskewness();
146+
var accumulator = incrnanskewness();
150147

151148
// For each simulated datum, update the corrected sample skewness...
149+
var i;
152150
for ( i = 0; i < 100; i++ ) {
153-
if ( randu() < 0.2 ) {
154-
v = NaN;
155-
} else {
156-
v = randu() * 100.0;
157-
}
158-
accumulator( v );
151+
accumulator( ( bernoulli( 0.8 ) < 1 ) ? NaN : uniform( 0.0, 100.0 ) );
159152
}
160153
console.log( accumulator() );
161154
```
@@ -164,8 +157,6 @@ console.log( accumulator() );
164157

165158
<!-- /.examples -->
166159

167-
* * *
168-
169160
<section class="references">
170161

171162
</section>
@@ -176,16 +167,6 @@ console.log( accumulator() );
176167

177168
<section class="related">
178169

179-
* * *
180-
181-
## See Also
182-
183-
- <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>
184-
- <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>
185-
- <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 incrementally.</span>
186-
- <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>
187-
- <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>
188-
189170
</section>
190171

191172
<!-- /.related -->
@@ -196,20 +177,6 @@ console.log( accumulator() );
196177

197178
[sample-skewness]: https://en.wikipedia.org/wiki/Skewness
198179

199-
<!-- <related-links> -->
200-
201-
[@stdlib/stats/incr/kurtosis]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/kurtosis
202-
203-
[@stdlib/stats/incr/mean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/mean
204-
205-
[@stdlib/stats/incr/stdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/stdev
206-
207-
[@stdlib/stats/incr/summary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/summary
208-
209-
[@stdlib/stats/incr/variance]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/variance
210-
211-
<!-- </related-links> -->
212-
213180
</section>
214181

215182
<!-- /.links -->

lib/node_modules/@stdlib/stats/incr/nanskewness/docs/repl.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
{{alias}}()
33
Returns an accumulator function which incrementally computes a corrected
4-
sample skewness, ingoring `NaN` values.
4+
sample skewness, ignoring `NaN` values.
55

66
If provided a value, the accumulator function returns an updated corrected
77
sample skewness. If not provided a value, the accumulator function returns
@@ -14,16 +14,16 @@
1414

1515
Examples
1616
--------
17-
> var accumulator = {{alias}}();
18-
> var v = accumulator( 2.0 )
17+
> var acc = {{alias}}();
18+
> var v = acc( 2.0 )
1919
null
20-
> v = accumulator( -5.0 )
20+
> v = acc( -5.0 )
2121
null
22-
> v = accumulator( -10.0 )
22+
> v = acc( -10.0 )
2323
~0.492
24-
> v = accumulator()
24+
> v = acc( NaN )
2525
~0.492
26-
> v = accumulator(NaN)
26+
> v = acc()
2727
~0.492
2828

2929
See Also

lib/node_modules/@stdlib/stats/incr/nanskewness/docs/types/index.d.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@ type accumulator = ( x?: number ) => number | null;
3131
/**
3232
* Returns an accumulator function which incrementally computes a corrected sample skewness, ignoring `NaN` values.
3333
*
34+
* ## Notes
35+
*
36+
* - If provided a value, the accumulator function returns an updated corrected sample skewness. If not provided a value, the accumulator function returns the current corrected sample skewness.
37+
*
3438
* @returns accumulator function
3539
*
3640
* @example
@@ -48,10 +52,10 @@ type accumulator = ( x?: number ) => number | null;
4852
* skewness = accumulator( -10.0 );
4953
* // returns ~0.492
5054
*
51-
* skewness = accumulator();
55+
* skewness = accumulator( NaN );
5256
* // returns ~0.492
5357
*
54-
* skewness = accumulator(NaN);
58+
* skewness = accumulator();
5559
* // returns ~0.492
5660
*/
5761
declare function incrnanskewness(): accumulator;

lib/node_modules/@stdlib/stats/incr/nanskewness/examples/index.js

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,31 +18,27 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
21+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
22+
var uniform = require( '@stdlib/random/base/uniform' );
23+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2224
var incrnanskewness = require( './../lib' );
2325

24-
var accumulator;
25-
var skewness;
26-
var v;
27-
var i;
28-
2926
// Initialize an accumulator:
30-
accumulator = incrnanskewness();
27+
var accumulator = incrnanskewness();
3128

3229
// For each simulated datum, update the corrected sample skewness...
3330
console.log( '\nValue\tSkewness\n' );
3431

32+
var skewness;
33+
var v;
34+
var i;
3535
for ( i = 0; i < 100; i++ ) {
36-
if ( randu() < 0.2 ) {
37-
v = NaN;
38-
} else {
39-
v = randu() * 100.0;
40-
}
36+
v = ( bernoulli( 0.8 ) < 1 ) ? NaN : uniform( 0.0, 100.0 );
4137
skewness = accumulator( v );
4238
if ( skewness === null ) {
4339
console.log( '%d\t%s', v.toFixed( 4 ), skewness );
4440
} else {
45-
console.log( '%d\t%d', v.toFixed( 4 ), skewness.toFixed( 4 ) );
41+
console.log( '%d\t%d', ( isnan( v ) ) ? NaN : v.toFixed( 4 ), skewness.toFixed( 4 ) );
4642
}
4743
}
4844
console.log( '\nFinal skewness: %d\n', accumulator() );

lib/node_modules/@stdlib/stats/incr/nanskewness/lib/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@
4040
* skewness = accumulator( -10.0 );
4141
* // returns ~0.492
4242
*
43-
* skewness = accumulator();
43+
* skewness = accumulator( NaN );
4444
* // returns ~0.492
4545
*
46-
* skewness = accumulator(NaN);
46+
* skewness = accumulator();
4747
* // returns ~0.492
4848
*/
4949

lib/node_modules/@stdlib/stats/incr/nanskewness/lib/main.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var incrskewness = require( '@stdlib/stats/incr/skewness' );
3232
* @returns {Function} accumulator function
3333
*
3434
* @example
35-
* var accumulator = incrskewness();
35+
* var accumulator = incrnanskewness();
3636
*
3737
* var skewness = accumulator();
3838
* // returns null
@@ -46,6 +46,9 @@ var incrskewness = require( '@stdlib/stats/incr/skewness' );
4646
* skewness = accumulator( -10.0 );
4747
* // returns ~0.492
4848
*
49+
* skewness = accumulator( NaN );
50+
* // returns ~0.492
51+
*
4952
* skewness = accumulator();
5053
* // returns ~0.492
5154
*/

lib/node_modules/@stdlib/stats/incr/nanskewness/test/test.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,19 +104,19 @@ tape( 'the corrected sample skewness is `null` until at least 3 datums have been
104104
acc = incrnanskewness();
105105

106106
skewness = acc();
107-
t.equal( skewness, null, 'returns null' );
107+
t.equal( skewness, null, 'returns expected value' );
108108

109109
skewness = acc( 2.0 );
110-
t.equal( skewness, null, 'returns null' );
110+
t.equal( skewness, null, 'returns expected value' );
111111

112112
skewness = acc( 2.0 );
113-
t.equal( skewness, null, 'returns null' );
113+
t.equal( skewness, null, 'returns expected value' );
114114

115115
skewness = acc( NaN );
116-
t.equal( skewness, null, 'returns null' );
116+
t.equal( skewness, null, 'returns expected value' );
117117

118118
skewness = acc( 3.0 );
119-
t.notEqual( skewness, null, 'does not return null' );
119+
t.notEqual( skewness, null, 'returns expected value' );
120120

121121
t.end();
122122
});

0 commit comments

Comments
 (0)