Skip to content

Commit cf80425

Browse files
pulkitgupta2pulkitgupta2
committed
fixup! refactor: updated docs
--- 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: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - 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 91bfbdd commit cf80425

File tree

5 files changed

+25
-73
lines changed

5 files changed

+25
-73
lines changed

‎lib/node_modules/@stdlib/stats/base/varianceyc/README.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
131131

132132
```javascript
133133
var Float64Array = require( '@stdlib/array/float64' );
134-
var floor = require( '@stdlib/math/base/special/floor' );
135134

136135
var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
137136
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

‎lib/node_modules/@stdlib/stats/base/varianceyc/docs/repl.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
Input array.
3333

3434
strideX: integer
35-
Stride length.
35+
Stride length for `x`.
3636

3737
Returns
3838
-------
@@ -87,10 +87,10 @@
8787
Input array.
8888

8989
strideX: integer
90-
Stride length.
90+
Stride length for `x`.
9191

9292
offsetX: integer
93-
Starting index.
93+
Starting index for `x`.
9494

9595
Returns
9696
-------

‎lib/node_modules/@stdlib/stats/base/varianceyc/docs/types/index.d.ts‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array
2727
*/
2828
type InputArray = NumericArray | Collection<number> | AccessorArrayLike<number>;
2929

30-
3130
/**
3231
* Interface describing `varianceyc`.
3332
*/
@@ -56,7 +55,7 @@ interface Routine {
5655
* @param correction - degrees of freedom adjustment
5756
* @param x - input array
5857
* @param strideX - stride length for `x`
59-
* @param offsetX - starting index
58+
* @param offsetX - starting index for `x`
6059
* @returns variance
6160
*
6261
* @example
@@ -74,7 +73,7 @@ interface Routine {
7473
* @param N - number of indexed elements
7574
* @param correction - degrees of freedom adjustment
7675
* @param x - input array
77-
* @param strideX - stride length
76+
* @param strideX - stride length for `x`
7877
* @returns variance
7978
*
8079
* @example

‎lib/node_modules/@stdlib/stats/base/varianceyc/test/test.ndarray.js‎

Lines changed: 9 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu
144144

145145
x = toAccessorArray( [ 10.0 ] );
146146
v = varianceyc( 0, 0, x, 1, 0 );
147-
t.strictEqual( isnan( v ), true, 'returns expected value when N = 0 with a single value' );
147+
t.strictEqual( isnan( v ), true, 'returns expected value' );
148148

149149
t.end();
150150
});
@@ -165,14 +165,14 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns a populat
165165
var x;
166166
var v;
167167

168-
x = toAccessorArray([ 1.0, -2.0, -4.0, 5.0, 3.0 ]);
168+
x = toAccessorArray( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] );
169169

170170
v = varianceyc( 1, 0, x, 1, 0 );
171171
t.strictEqual( v, 0.0, 'returns expected value' );
172172

173-
x = toAccessorArray([ 5.0 ]);
173+
x = toAccessorArray( [ 5.0 ] );
174174
v = varianceyc( 1, 0, x, 1, 0 );
175-
t.strictEqual( v, 0.0, 'returns expected value with a single value' );
175+
t.strictEqual( v, 0.0, 'returns expected value' );
176176

177177
t.end();
178178
});
@@ -196,17 +196,17 @@ tape( 'if provided a `correction` parameter yielding `N-correction` less than or
196196
var x;
197197
var v;
198198

199-
x = toAccessorArray([ 1.0, -2.0, -4.0, 5.0, 3.0 ]);
199+
x = toAccessorArray( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] );
200200

201201
v = varianceyc( x.length, x.length, x, 1, 0 );
202-
t.strictEqual( isnan( v ), true, 'returns expected value when n = 0' );
202+
t.strictEqual( isnan( v ), true, 'returns expected value' );
203203

204204
v = varianceyc( x.length, x.length+1, x, 1, 0 );
205-
t.strictEqual( isnan( v ), true, 'returns expected value when n < 0' );
205+
t.strictEqual( isnan( v ), true, 'returns expected value' );
206206

207-
x = toAccessorArray([ 7.0, 8.0, 9.0 ]);
207+
x = toAccessorArray( [ 7.0, 8.0, 9.0 ] );
208208
v = varianceyc( x.length, x.length, x, 1, 0 );
209-
t.strictEqual( isnan( v ), true, 'returns expected value when n = 0 with different data' );
209+
t.strictEqual( isnan( v ), true, 'returns expected value' );
210210

211211
t.end();
212212
});
@@ -357,26 +357,3 @@ tape( 'the function supports an `offset` parameter (accessor)', function test( t
357357
t.strictEqual( v, 6.25, 'returns expected value' );
358358
t.end();
359359
});
360-
361-
tape( 'the function handles specific accessor cases for coverage', function test( t ) {
362-
var x;
363-
var v;
364-
365-
x = toAccessorArray([ 999.0 ]);
366-
v = varianceyc( 1, 0, x, 1, 0 );
367-
t.strictEqual( v, 0.0, 'returns expected value for N === 1' );
368-
369-
x = toAccessorArray([ 999.0, 888.0, 777.0 ]);
370-
v = varianceyc( x.length, 1, x, 0, 0 );
371-
t.strictEqual( v, 0.0, 'returns expected value for strideX === 0' );
372-
373-
x = toAccessorArray([ 10.0, 20.0, 30.0 ]);
374-
v = varianceyc( 3, 3, x, 1, 0 );
375-
t.strictEqual( isnan( v ), true, 'returns NaN when n === 0' );
376-
377-
x = toAccessorArray([ 1.0 ]);
378-
v = varianceyc( 0, 0, x, 1, 0 );
379-
t.strictEqual( isnan( v ), true, 'returns NaN when N === 0' );
380-
381-
t.end();
382-
});

‎lib/node_modules/@stdlib/stats/base/varianceyc/test/test.varianceyc.js‎

Lines changed: 11 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -135,17 +135,17 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu
135135
var x;
136136
var v;
137137

138-
x = toAccessorArray([ 1.0, -2.0, -4.0, 5.0, 3.0 ]);
138+
x = toAccessorArray( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] );
139139

140140
v = varianceyc( 0, 1, x, 1 );
141141
t.strictEqual( isnan( v ), true, 'returns expected value' );
142142

143143
v = varianceyc( -1, 1, x, 1 );
144144
t.strictEqual( isnan( v ), true, 'returns expected value' );
145145

146-
x = toAccessorArray([ 10.0 ]);
146+
x = toAccessorArray( [ 10.0 ] );
147147
v = varianceyc( 0, 0, x, 1 );
148-
t.strictEqual( isnan( v ), true, 'returns expected value when N = 0 with a single value' );
148+
t.strictEqual( isnan( v ), true, 'returns expected value' );
149149

150150
t.end();
151151
});
@@ -166,14 +166,14 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns a populat
166166
var x;
167167
var v;
168168

169-
x = toAccessorArray([ 1.0, -2.0, -4.0, 5.0, 3.0 ]);
169+
x = toAccessorArray( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] );
170170

171171
v = varianceyc( 1, 0, x, 1 );
172172
t.strictEqual( v, 0.0, 'returns expected value' );
173173

174-
x = toAccessorArray([ 5.0 ]);
174+
x = toAccessorArray( [ 5.0 ] );
175175
v = varianceyc( 1, 0, x, 1 );
176-
t.strictEqual( v, 0.0, 'returns expected value with a single value' );
176+
t.strictEqual( v, 0.0, 'returns expected value' );
177177

178178
t.end();
179179
});
@@ -197,17 +197,17 @@ tape( 'if provided a `correction` parameter yielding `N-correction` less than or
197197
var x;
198198
var v;
199199

200-
x = toAccessorArray([ 1.0, -2.0, -4.0, 5.0, 3.0 ]);
200+
x = toAccessorArray( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] );
201201

202202
v = varianceyc( x.length, x.length, x, 1 );
203-
t.strictEqual( isnan( v ), true, 'returns expected value when n = 0' );
203+
t.strictEqual( isnan( v ), true, 'returns expected' );
204204

205205
v = varianceyc( x.length, x.length+1, x, 1 );
206-
t.strictEqual( isnan( v ), true, 'returns expected value when n < 0' );
206+
t.strictEqual( isnan( v ), true, 'returns expected' );
207207

208-
x = toAccessorArray([ 7.0, 8.0, 9.0 ]);
208+
x = toAccessorArray( [ 7.0, 8.0, 9.0 ] );
209209
v = varianceyc( x.length, x.length, x, 1 );
210-
t.strictEqual( isnan( v ), true, 'returns expected value when n = 0 with different data' );
210+
t.strictEqual( isnan( v ), true, 'returns expected value' );
211211

212212
t.end();
213213
});
@@ -369,26 +369,3 @@ tape( 'the function supports view offsets (accessor)', function test( t ) {
369369

370370
t.end();
371371
});
372-
373-
tape( 'the function handles specific accessor cases for complete branch coverage', function test( t ) {
374-
var x;
375-
var v;
376-
377-
x = toAccessorArray([ 999.0 ]);
378-
v = varianceyc( 1, 0, x, 1 );
379-
t.strictEqual( v, 0.0, 'returns expected value for N === 1' );
380-
381-
x = toAccessorArray([ 999.0, 888.0, 777.0 ]);
382-
v = varianceyc( x.length, 1, x, 0 );
383-
t.strictEqual( v, 0.0, 'returns expected value for strideX === 0' );
384-
385-
x = toAccessorArray([ 10.0, 20.0, 30.0 ]);
386-
v = varianceyc( 3, 3, x, 1 );
387-
t.strictEqual( isnan( v ), true, 'returns NaN when n === 0' );
388-
389-
x = toAccessorArray([ 1.0 ]);
390-
v = varianceyc( 0, 0, x, 1 );
391-
t.strictEqual( isnan( v ), true, 'returns NaN when N === 0' );
392-
393-
t.end();
394-
});

0 commit comments

Comments
 (0)