Skip to content

Commit 0ce3935

Browse files
committed
refactor: rename files and update paths
--- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 02bedd4 commit 0ce3935

File tree

24 files changed

+116
-228
lines changed

24 files changed

+116
-228
lines changed

lib/node_modules/@stdlib/stats/base/nanstdev/benchmark/benchmark.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ var filledarrayBy = require( '@stdlib/array/filled-by' );
2727
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2828
var pow = require( '@stdlib/math/base/special/pow' );
2929
var pkg = require( './../package.json' ).name;
30-
var nanstdev = require( './../lib/main.js' );
30+
var nanstdev = require( './../lib' );
3131

3232

3333
// FUNCTIONS //

lib/node_modules/@stdlib/stats/base/nanstdev/lib/index.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,14 @@
4242

4343
// MODULES //
4444

45+
var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
4546
var main = require( './main.js' );
47+
var ndarray = require( './ndarray.js' );
48+
49+
50+
// MAIN //
51+
52+
setReadOnly( main, 'ndarray', ndarray );
4653

4754

4855
// EXPORTS //

lib/node_modules/@stdlib/stats/base/nanstdev/lib/main.js

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,30 @@
2020

2121
// MODULES //
2222

23-
var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
24-
var nanstdev = require( './nanstdev.js' );
23+
var stride2offset = require( '@stdlib/strided/base/stride2offset' );
2524
var ndarray = require( './ndarray.js' );
2625

2726

2827
// MAIN //
2928

30-
setReadOnly( nanstdev, 'ndarray', ndarray );
29+
/**
30+
* Computes the standard deviation of a strided array ignoring `NaN` values.
31+
*
32+
* @param {PositiveInteger} N - number of indexed elements
33+
* @param {number} correction - degrees of freedom adjustment
34+
* @param {NumericArray} x - input array
35+
* @param {integer} strideX - stride length
36+
* @returns {number} standard deviation
37+
*
38+
* @example
39+
* var x = [ 1.0, -2.0, NaN, 2.0 ];
40+
*
41+
* var v = nanstdev( x.length, 1, x, 1 );
42+
* // returns ~2.0817
43+
*/
44+
function nanstdev( N, correction, x, strideX ) {
45+
return ndarray( N, correction, x, strideX, stride2offset( N, strideX ) );
46+
}
3147

3248

3349
// EXPORTS //

lib/node_modules/@stdlib/stats/base/nanstdev/lib/nanstdev.js

Lines changed: 0 additions & 51 deletions
This file was deleted.

lib/node_modules/@stdlib/stats/base/nanstdev/test/test.nanstdev.js renamed to lib/node_modules/@stdlib/stats/base/nanstdev/test/test.main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ var sqrt = require( '@stdlib/math/base/special/sqrt' );
2525
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2626
var Float64Array = require( '@stdlib/array/float64' );
2727
var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
28-
var nanstdev = require( './../lib/nanstdev.js' );
28+
var nanstdev = require( './../lib' );
2929

3030

3131
// TESTS //

lib/node_modules/@stdlib/stats/base/nanstdevch/benchmark/benchmark.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ var filledarrayBy = require( '@stdlib/array/filled-by' );
2727
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2828
var pow = require( '@stdlib/math/base/special/pow' );
2929
var pkg = require( './../package.json' ).name;
30-
var nanstdevch = require( './../lib/main.js' );
30+
var nanstdevch = require( './../lib' );
3131

3232

3333
// FUNCTIONS //

lib/node_modules/@stdlib/stats/base/nanstdevch/lib/index.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,14 @@
4242

4343
// MODULES //
4444

45+
var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
4546
var main = require( './main.js' );
47+
var ndarray = require( './ndarray.js' );
48+
49+
50+
// MAIN //
51+
52+
setReadOnly( main, 'ndarray', ndarray );
4653

4754

4855
// EXPORTS //

lib/node_modules/@stdlib/stats/base/nanstdevch/lib/main.js

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,30 @@
2020

2121
// MODULES //
2222

23-
var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
24-
var nanstdevch = require( './nanstdevch.js' );
23+
var stride2offset = require( '@stdlib/strided/base/stride2offset' );
2524
var ndarray = require( './ndarray.js' );
2625

2726

2827
// MAIN //
2928

30-
setReadOnly( nanstdevch, 'ndarray', ndarray );
29+
/**
30+
* Computes the standard deviation of a strided array ignoring `NaN` values and using a one-pass trial mean algorithm.
31+
*
32+
* @param {PositiveInteger} N - number of indexed elements
33+
* @param {number} correction - degrees of freedom adjustment
34+
* @param {NumericArray} x - input array
35+
* @param {integer} strideX - stride length
36+
* @returns {number} standard deviation
37+
*
38+
* @example
39+
* var x = [ 1.0, -2.0, NaN, 2.0 ];
40+
*
41+
* var v = nanstdevch( x.length, 1, x, 1 );
42+
* // returns ~2.0817
43+
*/
44+
function nanstdevch( N, correction, x, strideX ) {
45+
return ndarray( N, correction, x, strideX, stride2offset( N, strideX ) );
46+
}
3147

3248

3349
// EXPORTS //

lib/node_modules/@stdlib/stats/base/nanstdevch/lib/nanstdevch.js

Lines changed: 0 additions & 51 deletions
This file was deleted.

lib/node_modules/@stdlib/stats/base/nanstdevch/test/test.nanstdevch.js renamed to lib/node_modules/@stdlib/stats/base/nanstdevch/test/test.main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ var sqrt = require( '@stdlib/math/base/special/sqrt' );
2525
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2626
var Float64Array = require( '@stdlib/array/float64' );
2727
var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
28-
var nanstdevch = require( './../lib/main.js' );
28+
var nanstdevch = require( './../lib' );
2929

3030

3131
// TESTS //

0 commit comments

Comments
 (0)