@stdlib/stats-base-snanstdevpn 0.0.7 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CITATION.cff ADDED
@@ -0,0 +1,30 @@
1
+ cff-version: 1.2.0
2
+ title: stdlib
3
+ message: >-
4
+ If you use this software, please cite it using the
5
+ metadata from this file.
6
+
7
+ type: software
8
+
9
+ authors:
10
+ - name: The Stdlib Authors
11
+ url: https://github.com/stdlib-js/stdlib/graphs/contributors
12
+
13
+ repository-code: https://github.com/stdlib-js/stdlib
14
+ url: https://stdlib.io
15
+
16
+ abstract: |
17
+ Standard library for JavaScript and Node.js.
18
+
19
+ keywords:
20
+ - JavaScript
21
+ - Node.js
22
+ - TypeScript
23
+ - standard library
24
+ - scientific computing
25
+ - numerical computing
26
+ - statistical computing
27
+
28
+ license: Apache-2.0 AND BSL-1.0
29
+
30
+ date-released: 2016
package/NOTICE CHANGED
@@ -1 +1 @@
1
- Copyright (c) 2016-2022 The Stdlib Authors.
1
+ Copyright (c) 2016-2023 The Stdlib Authors.
package/README.md CHANGED
@@ -18,6 +18,17 @@ limitations under the License.
18
18
 
19
19
  -->
20
20
 
21
+
22
+ <details>
23
+ <summary>
24
+ About stdlib...
25
+ </summary>
26
+ <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
27
+ <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
28
+ <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
29
+ <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
30
+ </details>
31
+
21
32
  # snanstdevpn
22
33
 
23
34
  [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -33,7 +44,7 @@ The population [standard deviation][standard-deviation] of a finite size populat
33
44
  <div class="equation" align="center" data-raw-text="\sigma = \sqrt{\frac{1}{N} \sum_{i=0}^{N-1} (x_i - \mu)^2}" data-equation="eq:population_standard_deviation">
34
45
  <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@0ddbe81cc0180e06d3ff9b02ff6e1e5b752bb524/lib/node_modules/@stdlib/stats/base/snanstdevpn/docs/img/equation_population_standard_deviation.svg" alt="Equation for the population standard deviation.">
35
46
  <br>
36
- </div>
47
+ </div> -->
37
48
 
38
49
  <!-- </equation> -->
39
50
 
@@ -41,10 +52,10 @@ where the population mean is given by
41
52
 
42
53
  <!-- <equation class="equation" label="eq:population_mean" align="center" raw="\mu = \frac{1}{N} \sum_{i=0}^{N-1} x_i" alt="Equation for the population mean."> -->
43
54
 
44
- <div class="equation" align="center" data-raw-text="\mu = \frac{1}{N} \sum_{i=0}^{N-1} x_i" data-equation="eq:population_mean">
55
+ <!-- <div class="equation" align="center" data-raw-text="\mu = \frac{1}{N} \sum_{i=0}^{N-1} x_i" data-equation="eq:population_mean">
45
56
  <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@0ddbe81cc0180e06d3ff9b02ff6e1e5b752bb524/lib/node_modules/@stdlib/stats/base/snanstdevpn/docs/img/equation_population_mean.svg" alt="Equation for the population mean.">
46
57
  <br>
47
- </div>
58
+ </div> -->
48
59
 
49
60
  <!-- </equation> -->
50
61
 
@@ -52,10 +63,10 @@ Often in the analysis of data, the true population [standard deviation][standard
52
63
 
53
64
  <!-- <equation class="equation" label="eq:corrected_sample_standard_deviation" align="center" raw="s = \sqrt{\frac{1}{n-1} \sum_{i=0}^{n-1} (x_i - \bar{x})^2}" alt="Equation for computing a corrected sample standard deviation."> -->
54
65
 
55
- <div class="equation" align="center" data-raw-text="s = \sqrt{\frac{1}{n-1} \sum_{i=0}^{n-1} (x_i - \bar{x})^2}" data-equation="eq:corrected_sample_standard_deviation">
66
+ <!-- <div class="equation" align="center" data-raw-text="s = \sqrt{\frac{1}{n-1} \sum_{i=0}^{n-1} (x_i - \bar{x})^2}" data-equation="eq:corrected_sample_standard_deviation">
56
67
  <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@0ddbe81cc0180e06d3ff9b02ff6e1e5b752bb524/lib/node_modules/@stdlib/stats/base/snanstdevpn/docs/img/equation_corrected_sample_standard_deviation.svg" alt="Equation for computing a corrected sample standard deviation.">
57
68
  <br>
58
- </div>
69
+ </div> -->
59
70
 
60
71
  <!-- </equation> -->
61
72
 
@@ -63,7 +74,7 @@ where the sample mean is given by
63
74
 
64
75
  <!-- <equation class="equation" label="eq:sample_mean" align="center" raw="\bar{x} = \frac{1}{n} \sum_{i=0}^{n-1} x_i" alt="Equation for the sample mean."> -->
65
76
 
66
- <div class="equation" align="center" data-raw-text="\bar{x} = \frac{1}{n} \sum_{i=0}^{n-1} x_i" data-equation="eq:sample_mean">
77
+ <!-- <div class="equation" align="center" data-raw-text="\bar{x} = \frac{1}{n} \sum_{i=0}^{n-1} x_i" data-equation="eq:sample_mean">
67
78
  <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@0ddbe81cc0180e06d3ff9b02ff6e1e5b752bb524/lib/node_modules/@stdlib/stats/base/snanstdevpn/docs/img/equation_sample_mean.svg" alt="Equation for the sample mean.">
68
79
  <br>
69
80
  </div>
@@ -239,11 +250,11 @@ console.log( v );
239
250
 
240
251
  ## See Also
241
252
 
242
- - <span class="package-name">[`@stdlib/stats/base/dnanstdevpn`][@stdlib/stats/base/dnanstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a double-precision floating-point strided array ignoring NaN values and using a two-pass algorithm.</span>
243
- - <span class="package-name">[`@stdlib/stats/base/nanstdevpn`][@stdlib/stats/base/nanstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a strided array ignoring NaN values and using a two-pass algorithm.</span>
244
- - <span class="package-name">[`@stdlib/stats/base/snanstdev`][@stdlib/stats/base/snanstdev]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array ignoring NaN values.</span>
245
- - <span class="package-name">[`@stdlib/stats/base/snanvariancepn`][@stdlib/stats/base/snanvariancepn]</span><span class="delimiter">: </span><span class="description">calculate the variance of a single-precision floating-point strided array ignoring NaN values and using a two-pass algorithm.</span>
246
- - <span class="package-name">[`@stdlib/stats/base/sstdevpn`][@stdlib/stats/base/sstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a two-pass algorithm.</span>
253
+ - <span class="package-name">[`@stdlib/stats-base/dnanstdevpn`][@stdlib/stats/base/dnanstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a double-precision floating-point strided array ignoring NaN values and using a two-pass algorithm.</span>
254
+ - <span class="package-name">[`@stdlib/stats-base/nanstdevpn`][@stdlib/stats/base/nanstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a strided array ignoring NaN values and using a two-pass algorithm.</span>
255
+ - <span class="package-name">[`@stdlib/stats-base/snanstdev`][@stdlib/stats/base/snanstdev]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array ignoring NaN values.</span>
256
+ - <span class="package-name">[`@stdlib/stats-base/snanvariancepn`][@stdlib/stats/base/snanvariancepn]</span><span class="delimiter">: </span><span class="description">calculate the variance of a single-precision floating-point strided array ignoring NaN values and using a two-pass algorithm.</span>
257
+ - <span class="package-name">[`@stdlib/stats-base/sstdevpn`][@stdlib/stats/base/sstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a two-pass algorithm.</span>
247
258
 
248
259
  </section>
249
260
 
@@ -275,7 +286,7 @@ See [LICENSE][stdlib-license].
275
286
 
276
287
  ## Copyright
277
288
 
278
- Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
289
+ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
279
290
 
280
291
  </section>
281
292
 
@@ -288,8 +299,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
288
299
  [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-snanstdevpn.svg
289
300
  [npm-url]: https://npmjs.org/package/@stdlib/stats-base-snanstdevpn
290
301
 
291
- [test-image]: https://github.com/stdlib-js/stats-base-snanstdevpn/actions/workflows/test.yml/badge.svg?branch=v0.0.7
292
- [test-url]: https://github.com/stdlib-js/stats-base-snanstdevpn/actions/workflows/test.yml?query=branch:v0.0.7
302
+ [test-image]: https://github.com/stdlib-js/stats-base-snanstdevpn/actions/workflows/test.yml/badge.svg?branch=v0.1.0
303
+ [test-url]: https://github.com/stdlib-js/stats-base-snanstdevpn/actions/workflows/test.yml?query=branch:v0.1.0
293
304
 
294
305
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-snanstdevpn/main.svg
295
306
  [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-snanstdevpn?branch=main
@@ -302,7 +313,7 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
302
313
  -->
303
314
 
304
315
  [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
305
- [chat-url]: https://gitter.im/stdlib-js/stdlib/
316
+ [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
306
317
 
307
318
  [stdlib]: https://github.com/stdlib-js/stdlib
308
319
 
@@ -0,0 +1,3 @@
1
+ /// <reference path="../docs/types/index.d.ts" />
2
+ import snanstdevpn from '../docs/types/index';
3
+ export = snanstdevpn;
package/dist/index.js ADDED
@@ -0,0 +1,9 @@
1
+ "use strict";var t=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var u=t(function(w,s){
2
+ var f=require('@stdlib/number-float64-base-to-float32/dist'),y=require('@stdlib/stats-base-snanvariancepn/dist'),x=require('@stdlib/math-base-special-sqrt/dist');function j(e,r,a,n){return f(x(y(e,r,a,n)))}s.exports=j
3
+ });var q=t(function(z,v){
4
+ var m=require('@stdlib/number-float64-base-to-float32/dist'),F=require('@stdlib/stats-base-snanvariancepn/dist').ndarray,R=require('@stdlib/math-base-special-sqrt/dist');function T(e,r,a,n,l){return m(R(F(e,r,a,n,l)))}v.exports=T
5
+ });var d=t(function(A,p){
6
+ var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),o=u(),E=q();_(o,"ndarray",E);p.exports=o
7
+ });var O=require("path").join,b=require('@stdlib/utils-try-require/dist'),g=require('@stdlib/assert-is-error/dist'),h=d(),i,c=b(O(__dirname,"./native.js"));g(c)?i=h:i=c;module.exports=i;
8
+ /** @license Apache-2.0 */
9
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../lib/snanstdevpn.js", "../lib/ndarray.js", "../lib/main.js", "../lib/index.js"],
4
+ "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar float64ToFloat32 = require( '@stdlib/number-float64-base-to-float32' );\nvar snanvariancepn = require( '@stdlib/stats-base-snanvariancepn' );\nvar sqrt = require( '@stdlib/math-base-special-sqrt' );\n\n\n// MAIN //\n\n/**\n* Computes the standard deviation of a single-precision floating-point strided array ignoring `NaN` values and using a two-pass algorithm.\n*\n* @param {PositiveInteger} N - number of indexed elements\n* @param {number} correction - degrees of freedom adjustment\n* @param {Float32Array} x - input array\n* @param {integer} stride - stride length\n* @returns {number} standard deviation\n*\n* @example\n* var Float32Array = require( '@stdlib/array-float32' );\n*\n* var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );\n*\n* var v = snanstdevpn( x.length, 1, x, 1 );\n* // returns ~2.0817\n*/\nfunction snanstdevpn( N, correction, x, stride ) {\n\treturn float64ToFloat32( sqrt( snanvariancepn( N, correction, x, stride ) ) ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = snanstdevpn;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar float64ToFloat32 = require( '@stdlib/number-float64-base-to-float32' );\nvar snanvariancepn = require( '@stdlib/stats-base-snanvariancepn' ).ndarray;\nvar sqrt = require( '@stdlib/math-base-special-sqrt' );\n\n\n// MAIN //\n\n/**\n* Computes the standard deviation of a single-precision floating-point strided array ignoring `NaN` values and using a two-pass algorithm.\n*\n* @param {PositiveInteger} N - number of indexed elements\n* @param {number} correction - degrees of freedom adjustment\n* @param {Float32Array} x - input array\n* @param {integer} stride - stride length\n* @param {NonNegativeInteger} offset - starting index\n* @returns {number} standard deviation\n*\n* @example\n* var Float32Array = require( '@stdlib/array-float32' );\n* var floor = require( '@stdlib/math-base-special-floor' );\n*\n* var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );\n* var N = floor( x.length / 2 );\n*\n* var v = snanstdevpn( N, 1, x, 2, 1 );\n* // returns 2.5\n*/\nfunction snanstdevpn( N, correction, x, stride, offset ) {\n\treturn float64ToFloat32( sqrt( snanvariancepn( N, correction, x, stride, offset ) ) ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = snanstdevpn;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar snanstdevpn = require( './snanstdevpn.js' );\nvar ndarray = require( './ndarray.js' );\n\n\n// MAIN //\n\nsetReadOnly( snanstdevpn, 'ndarray', ndarray );\n\n\n// EXPORTS //\n\nmodule.exports = snanstdevpn;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Compute the standard deviation of a single-precision floating-point strided array ignoring `NaN` values and using a two-pass algorithm.\n*\n* @module @stdlib/stats-base-snanstdevpn\n*\n* @example\n* var Float32Array = require( '@stdlib/array-float32' );\n* var snanstdevpn = require( '@stdlib/stats-base-snanstdevpn' );\n*\n* var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );\n*\n* var v = snanstdevpn( x.length, 1, x, 1 );\n* // returns ~2.0817\n*\n* @example\n* var Float32Array = require( '@stdlib/array-float32' );\n* var floor = require( '@stdlib/math-base-special-floor' );\n* var snanstdevpn = require( '@stdlib/stats-base-snanstdevpn' );\n*\n* var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );\n* var N = floor( x.length / 2 );\n*\n* var v = snanstdevpn.ndarray( N, 1, x, 2, 1 );\n* // returns 2.5\n*/\n\n// MODULES //\n\nvar join = require( 'path' ).join;\nvar tryRequire = require( '@stdlib/utils-try-require' );\nvar isError = require( '@stdlib/assert-is-error' );\nvar main = require( './main.js' );\n\n\n// MAIN //\n\nvar snanstdevpn;\nvar tmp = tryRequire( join( __dirname, './native.js' ) );\nif ( isError( tmp ) ) {\n\tsnanstdevpn = main;\n} else {\n\tsnanstdevpn = tmp;\n}\n\n\n// EXPORTS //\n\nmodule.exports = snanstdevpn;\n\n// exports: { \"ndarray\": \"snanstdevpn.ndarray\" }\n"],
5
+ "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,wCAAyC,EACrEC,EAAiB,QAAS,mCAAoC,EAC9DC,EAAO,QAAS,gCAAiC,EAsBrD,SAASC,EAAaC,EAAGC,EAAYC,EAAGC,EAAS,CAChD,OAAOP,EAAkBE,EAAMD,EAAgBG,EAAGC,EAAYC,EAAGC,CAAO,CAAE,CAAE,CAC7E,CAKAR,EAAO,QAAUI,ICrDjB,IAAAK,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,wCAAyC,EACrEC,EAAiB,QAAS,mCAAoC,EAAE,QAChEC,EAAO,QAAS,gCAAiC,EAyBrD,SAASC,EAAaC,EAAGC,EAAYC,EAAGC,EAAQC,EAAS,CACxD,OAAOR,EAAkBE,EAAMD,EAAgBG,EAAGC,EAAYC,EAAGC,EAAQC,CAAO,CAAE,CAAE,CACrF,CAKAT,EAAO,QAAUI,ICxDjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAc,IACdC,EAAU,IAKdF,EAAaC,EAAa,UAAWC,CAAQ,EAK7CH,EAAO,QAAUE,ICcjB,IAAIE,EAAO,QAAS,MAAO,EAAE,KACzBC,EAAa,QAAS,2BAA4B,EAClDC,EAAU,QAAS,yBAA0B,EAC7CC,EAAO,IAKPC,EACAC,EAAMJ,EAAYD,EAAM,UAAW,aAAc,CAAE,EAClDE,EAASG,CAAI,EACjBD,EAAcD,EAEdC,EAAcC,EAMf,OAAO,QAAUD",
6
+ "names": ["require_snanstdevpn", "__commonJSMin", "exports", "module", "float64ToFloat32", "snanvariancepn", "sqrt", "snanstdevpn", "N", "correction", "x", "stride", "require_ndarray", "__commonJSMin", "exports", "module", "float64ToFloat32", "snanvariancepn", "sqrt", "snanstdevpn", "N", "correction", "x", "stride", "offset", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "snanstdevpn", "ndarray", "join", "tryRequire", "isError", "main", "snanstdevpn", "tmp"]
7
+ }
@@ -16,7 +16,7 @@
16
16
  * limitations under the License.
17
17
  */
18
18
 
19
- // TypeScript Version: 2.0
19
+ // TypeScript Version: 4.1
20
20
 
21
21
  /**
22
22
  * Interface describing `snanstdevpn`.
package/lib/index.js CHANGED
@@ -48,6 +48,7 @@
48
48
 
49
49
  var join = require( 'path' ).join;
50
50
  var tryRequire = require( '@stdlib/utils-try-require' );
51
+ var isError = require( '@stdlib/assert-is-error' );
51
52
  var main = require( './main.js' );
52
53
 
53
54
 
@@ -55,7 +56,7 @@ var main = require( './main.js' );
55
56
 
56
57
  var snanstdevpn;
57
58
  var tmp = tryRequire( join( __dirname, './native.js' ) );
58
- if ( tmp instanceof Error ) {
59
+ if ( isError( tmp ) ) {
59
60
  snanstdevpn = main;
60
61
  } else {
61
62
  snanstdevpn = tmp;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/stats-base-snanstdevpn",
3
- "version": "0.0.7",
3
+ "version": "0.1.0",
4
4
  "description": "Calculate the standard deviation of a single-precision floating-point strided array ignoring NaN values and using a two-pass algorithm.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -41,28 +41,29 @@
41
41
  "url": "https://github.com/stdlib-js/stdlib/issues"
42
42
  },
43
43
  "dependencies": {
44
- "@stdlib/math-base-special-sqrt": "^0.0.x",
45
- "@stdlib/number-float64-base-to-float32": "^0.0.x",
46
- "@stdlib/stats-base-snanvariancepn": "^0.0.x",
47
- "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x",
48
- "@stdlib/utils-library-manifest": "^0.0.x",
49
- "@stdlib/utils-try-require": "^0.0.x"
44
+ "@stdlib/assert-is-error": "^0.1.0",
45
+ "@stdlib/math-base-special-sqrt": "^0.1.0",
46
+ "@stdlib/number-float64-base-to-float32": "^0.1.0",
47
+ "@stdlib/stats-base-snanvariancepn": "^0.1.0",
48
+ "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0",
49
+ "@stdlib/utils-library-manifest": "^0.1.0",
50
+ "@stdlib/utils-try-require": "^0.1.0"
50
51
  },
51
52
  "devDependencies": {
52
- "@stdlib/array-float32": "^0.0.x",
53
- "@stdlib/assert-is-browser": "^0.0.x",
54
- "@stdlib/bench": "^0.0.x",
55
- "@stdlib/constants-float32-eps": "^0.0.x",
56
- "@stdlib/math-base-assert-is-nanf": "^0.0.x",
57
- "@stdlib/math-base-special-abs": "^0.0.x",
58
- "@stdlib/math-base-special-floor": "^0.0.x",
59
- "@stdlib/math-base-special-pow": "^0.0.x",
60
- "@stdlib/math-base-special-round": "^0.0.x",
61
- "@stdlib/random-base-randu": "^0.0.x",
53
+ "@stdlib/array-float32": "^0.1.0",
54
+ "@stdlib/assert-is-browser": "^0.1.0",
55
+ "@stdlib/bench": "^0.1.0",
56
+ "@stdlib/constants-float32-eps": "^0.1.0",
57
+ "@stdlib/math-base-assert-is-nanf": "^0.1.0",
58
+ "@stdlib/math-base-special-abs": "^0.0.6",
59
+ "@stdlib/math-base-special-floor": "^0.1.0",
60
+ "@stdlib/math-base-special-pow": "^0.0.7",
61
+ "@stdlib/math-base-special-round": "^0.1.0",
62
+ "@stdlib/random-base-randu": "^0.0.8",
62
63
  "proxyquire": "^2.0.0",
63
64
  "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
64
65
  "istanbul": "^0.4.1",
65
- "tap-spec": "5.x.x"
66
+ "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
66
67
  },
67
68
  "engines": {
68
69
  "node": ">=0.10.0",
@@ -105,7 +106,7 @@
105
106
  ],
106
107
  "__stdlib__": {},
107
108
  "funding": {
108
- "type": "patreon",
109
- "url": "https://www.patreon.com/athan"
109
+ "type": "opencollective",
110
+ "url": "https://opencollective.com/stdlib"
110
111
  }
111
112
  }
package/docs/repl.txt DELETED
@@ -1,121 +0,0 @@
1
-
2
- {{alias}}( N, correction, x, stride )
3
- Computes the standard deviation of a single-precision floating-point strided
4
- array ignoring `NaN` values and using a two-pass algorithm.
5
-
6
- The `N` and `stride` parameters determine which elements in `x` are accessed
7
- at runtime.
8
-
9
- Indexing is relative to the first index. To introduce an offset, use a typed
10
- array view.
11
-
12
- If `N <= 0`, the function returns `NaN`.
13
-
14
- If every indexed element is `NaN`, the function returns `NaN`.
15
-
16
- Parameters
17
- ----------
18
- N: integer
19
- Number of indexed elements.
20
-
21
- correction: number
22
- Degrees of freedom adjustment. Setting this parameter to a value other
23
- than `0` has the effect of adjusting the divisor during the calculation
24
- of the standard deviation according to `N - c` where `c` corresponds to
25
- the provided degrees of freedom adjustment. When computing the standard
26
- deviation of a population, setting this parameter to `0` is the standard
27
- choice (i.e., the provided array contains data constituting an entire
28
- population). When computing the corrected sample standard deviation,
29
- setting this parameter to `1` is the standard choice (i.e., the provided
30
- array contains data sampled from a larger population; this is commonly
31
- referred to as Bessel's correction).
32
-
33
- x: Float32Array
34
- Input array.
35
-
36
- stride: integer
37
- Index increment.
38
-
39
- Returns
40
- -------
41
- out: number
42
- The standard deviation.
43
-
44
- Examples
45
- --------
46
- // Standard Usage:
47
- > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, NaN, 2.0 ] );
48
- > {{alias}}( x.length, 1, x, 1 )
49
- ~2.0817
50
-
51
- // Using `N` and `stride` parameters:
52
- > x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );
53
- > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
54
- > var stride = 2;
55
- > {{alias}}( N, 1, x, stride )
56
- ~2.0817
57
-
58
- // Using view offsets:
59
- > var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
60
- > var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
61
- > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
62
- > stride = 2;
63
- > {{alias}}( N, 1, x1, stride )
64
- ~2.0817
65
-
66
- {{alias}}.ndarray( N, correction, x, stride, offset )
67
- Computes the standard deviation of a single-precision floating-point strided
68
- array ignoring `NaN` values and using a two-pass algorithm and alternative
69
- indexing semantics.
70
-
71
- While typed array views mandate a view offset based on the underlying
72
- buffer, the `offset` parameter supports indexing semantics based on a
73
- starting index.
74
-
75
- Parameters
76
- ----------
77
- N: integer
78
- Number of indexed elements.
79
-
80
- correction: number
81
- Degrees of freedom adjustment. Setting this parameter to a value other
82
- than `0` has the effect of adjusting the divisor during the calculation
83
- of the standard deviation according to `N - c` where `c` corresponds to
84
- the provided degrees of freedom adjustment. When computing the standard
85
- deviation of a population, setting this parameter to `0` is the standard
86
- choice (i.e., the provided array contains data constituting an entire
87
- population). When computing the corrected sample standard deviation,
88
- setting this parameter to `1` is the standard choice (i.e., the provided
89
- array contains data sampled from a larger population; this is commonly
90
- referred to as Bessel's correction).
91
-
92
- x: Float32Array
93
- Input array.
94
-
95
- stride: integer
96
- Index increment.
97
-
98
- offset: integer
99
- Starting index.
100
-
101
- Returns
102
- -------
103
- out: number
104
- The standard deviation.
105
-
106
- Examples
107
- --------
108
- // Standard Usage:
109
- > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, NaN, 2.0 ] );
110
- > {{alias}}.ndarray( x.length, 1, x, 1, 0 )
111
- ~2.0817
112
-
113
- // Using offset parameter:
114
- > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
115
- > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
116
- > {{alias}}.ndarray( N, 1, x, 2, 1 )
117
- ~2.0817
118
-
119
- See Also
120
- --------
121
-
@@ -1,187 +0,0 @@
1
- /*
2
- * @license Apache-2.0
3
- *
4
- * Copyright (c) 2020 The Stdlib Authors.
5
- *
6
- * Licensed under the Apache License, Version 2.0 (the "License");
7
- * you may not use this file except in compliance with the License.
8
- * You may obtain a copy of the License at
9
- *
10
- * http://www.apache.org/licenses/LICENSE-2.0
11
- *
12
- * Unless required by applicable law or agreed to in writing, software
13
- * distributed under the License is distributed on an "AS IS" BASIS,
14
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
- * See the License for the specific language governing permissions and
16
- * limitations under the License.
17
- */
18
-
19
- import snanstdevpn = require( './index' );
20
-
21
-
22
- // TESTS //
23
-
24
- // The function returns a number...
25
- {
26
- const x = new Float32Array( 10 );
27
-
28
- snanstdevpn( x.length, 1, x, 1 ); // $ExpectType number
29
- }
30
-
31
- // The compiler throws an error if the function is provided a first argument which is not a number...
32
- {
33
- const x = new Float32Array( 10 );
34
-
35
- snanstdevpn( '10', 1, x, 1 ); // $ExpectError
36
- snanstdevpn( true, 1, x, 1 ); // $ExpectError
37
- snanstdevpn( false, 1, x, 1 ); // $ExpectError
38
- snanstdevpn( null, 1, x, 1 ); // $ExpectError
39
- snanstdevpn( undefined, 1, x, 1 ); // $ExpectError
40
- snanstdevpn( [], 1, x, 1 ); // $ExpectError
41
- snanstdevpn( {}, 1, x, 1 ); // $ExpectError
42
- snanstdevpn( ( x: number ): number => x, 1, x, 1 ); // $ExpectError
43
- }
44
-
45
- // The compiler throws an error if the function is provided a second argument which is not a number...
46
- {
47
- const x = new Float32Array( 10 );
48
-
49
- snanstdevpn( x.length, '10', x, 1 ); // $ExpectError
50
- snanstdevpn( x.length, true, x, 1 ); // $ExpectError
51
- snanstdevpn( x.length, false, x, 1 ); // $ExpectError
52
- snanstdevpn( x.length, null, x, 1 ); // $ExpectError
53
- snanstdevpn( x.length, undefined, x, 1 ); // $ExpectError
54
- snanstdevpn( x.length, [], x, 1 ); // $ExpectError
55
- snanstdevpn( x.length, {}, x, 1 ); // $ExpectError
56
- snanstdevpn( x.length, ( x: number ): number => x, x, 1 ); // $ExpectError
57
- }
58
-
59
- // The compiler throws an error if the function is provided a third argument which is not a Float32Array...
60
- {
61
- const x = new Float32Array( 10 );
62
-
63
- snanstdevpn( x.length, 1, 10, 1 ); // $ExpectError
64
- snanstdevpn( x.length, 1, '10', 1 ); // $ExpectError
65
- snanstdevpn( x.length, 1, true, 1 ); // $ExpectError
66
- snanstdevpn( x.length, 1, false, 1 ); // $ExpectError
67
- snanstdevpn( x.length, 1, null, 1 ); // $ExpectError
68
- snanstdevpn( x.length, 1, undefined, 1 ); // $ExpectError
69
- snanstdevpn( x.length, 1, [], 1 ); // $ExpectError
70
- snanstdevpn( x.length, 1, {}, 1 ); // $ExpectError
71
- snanstdevpn( x.length, 1, ( x: number ): number => x, 1 ); // $ExpectError
72
- }
73
-
74
- // The compiler throws an error if the function is provided a fourth argument which is not a number...
75
- {
76
- const x = new Float32Array( 10 );
77
-
78
- snanstdevpn( x.length, 1, x, '10' ); // $ExpectError
79
- snanstdevpn( x.length, 1, x, true ); // $ExpectError
80
- snanstdevpn( x.length, 1, x, false ); // $ExpectError
81
- snanstdevpn( x.length, 1, x, null ); // $ExpectError
82
- snanstdevpn( x.length, 1, x, undefined ); // $ExpectError
83
- snanstdevpn( x.length, 1, x, [] ); // $ExpectError
84
- snanstdevpn( x.length, 1, x, {} ); // $ExpectError
85
- snanstdevpn( x.length, 1, x, ( x: number ): number => x ); // $ExpectError
86
- }
87
-
88
- // The compiler throws an error if the function is provided an unsupported number of arguments...
89
- {
90
- const x = new Float32Array( 10 );
91
-
92
- snanstdevpn(); // $ExpectError
93
- snanstdevpn( x.length ); // $ExpectError
94
- snanstdevpn( x.length, 1 ); // $ExpectError
95
- snanstdevpn( x.length, 1, x ); // $ExpectError
96
- snanstdevpn( x.length, 1, x, 1, 10 ); // $ExpectError
97
- }
98
-
99
- // Attached to main export is an `ndarray` method which returns a number...
100
- {
101
- const x = new Float32Array( 10 );
102
-
103
- snanstdevpn.ndarray( x.length, 1, x, 1, 0 ); // $ExpectType number
104
- }
105
-
106
- // The compiler throws an error if the `ndarray` method is provided a first argument which is not a number...
107
- {
108
- const x = new Float32Array( 10 );
109
-
110
- snanstdevpn.ndarray( '10', 1, x, 1, 0 ); // $ExpectError
111
- snanstdevpn.ndarray( true, 1, x, 1, 0 ); // $ExpectError
112
- snanstdevpn.ndarray( false, 1, x, 1, 0 ); // $ExpectError
113
- snanstdevpn.ndarray( null, 1, x, 1, 0 ); // $ExpectError
114
- snanstdevpn.ndarray( undefined, 1, x, 1, 0 ); // $ExpectError
115
- snanstdevpn.ndarray( [], 1, x, 1, 0 ); // $ExpectError
116
- snanstdevpn.ndarray( {}, 1, x, 1, 0 ); // $ExpectError
117
- snanstdevpn.ndarray( ( x: number ): number => x, 1, x, 1, 0 ); // $ExpectError
118
- }
119
-
120
- // The compiler throws an error if the `ndarray` method is provided a second argument which is not a number...
121
- {
122
- const x = new Float32Array( 10 );
123
-
124
- snanstdevpn.ndarray( x.length, '10', x, 1, 0 ); // $ExpectError
125
- snanstdevpn.ndarray( x.length, true, x, 1, 0 ); // $ExpectError
126
- snanstdevpn.ndarray( x.length, false, x, 1, 0 ); // $ExpectError
127
- snanstdevpn.ndarray( x.length, null, x, 1, 0 ); // $ExpectError
128
- snanstdevpn.ndarray( x.length, undefined, x, 1, 0 ); // $ExpectError
129
- snanstdevpn.ndarray( x.length, [], x, 1, 0 ); // $ExpectError
130
- snanstdevpn.ndarray( x.length, {}, x, 1, 0 ); // $ExpectError
131
- snanstdevpn.ndarray( x.length, ( x: number ): number => x, x, 1, 0 ); // $ExpectError
132
- }
133
-
134
- // The compiler throws an error if the `ndarray` method is provided a third argument which is not a Float32Array...
135
- {
136
- const x = new Float32Array( 10 );
137
-
138
- snanstdevpn.ndarray( x.length, 1, 10, 1, 0 ); // $ExpectError
139
- snanstdevpn.ndarray( x.length, 1, '10', 1, 0 ); // $ExpectError
140
- snanstdevpn.ndarray( x.length, 1, true, 1, 0 ); // $ExpectError
141
- snanstdevpn.ndarray( x.length, 1, false, 1, 0 ); // $ExpectError
142
- snanstdevpn.ndarray( x.length, 1, null, 1, 0 ); // $ExpectError
143
- snanstdevpn.ndarray( x.length, 1, undefined, 1, 0 ); // $ExpectError
144
- snanstdevpn.ndarray( x.length, 1, [], 1, 0 ); // $ExpectError
145
- snanstdevpn.ndarray( x.length, 1, {}, 1, 0 ); // $ExpectError
146
- snanstdevpn.ndarray( x.length, 1, ( x: number ): number => x, 1, 0 ); // $ExpectError
147
- }
148
-
149
- // The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number...
150
- {
151
- const x = new Float32Array( 10 );
152
-
153
- snanstdevpn.ndarray( x.length, 1, x, '10', 0 ); // $ExpectError
154
- snanstdevpn.ndarray( x.length, 1, x, true, 0 ); // $ExpectError
155
- snanstdevpn.ndarray( x.length, 1, x, false, 0 ); // $ExpectError
156
- snanstdevpn.ndarray( x.length, 1, x, null, 0 ); // $ExpectError
157
- snanstdevpn.ndarray( x.length, 1, x, undefined, 0 ); // $ExpectError
158
- snanstdevpn.ndarray( x.length, 1, x, [], 0 ); // $ExpectError
159
- snanstdevpn.ndarray( x.length, 1, x, {}, 0 ); // $ExpectError
160
- snanstdevpn.ndarray( x.length, 1, x, ( x: number ): number => x, 0 ); // $ExpectError
161
- }
162
-
163
- // The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a number...
164
- {
165
- const x = new Float32Array( 10 );
166
-
167
- snanstdevpn.ndarray( x.length, 1, x, 1, '10' ); // $ExpectError
168
- snanstdevpn.ndarray( x.length, 1, x, 1, true ); // $ExpectError
169
- snanstdevpn.ndarray( x.length, 1, x, 1, false ); // $ExpectError
170
- snanstdevpn.ndarray( x.length, 1, x, 1, null ); // $ExpectError
171
- snanstdevpn.ndarray( x.length, 1, x, 1, undefined ); // $ExpectError
172
- snanstdevpn.ndarray( x.length, 1, x, 1, [] ); // $ExpectError
173
- snanstdevpn.ndarray( x.length, 1, x, 1, {} ); // $ExpectError
174
- snanstdevpn.ndarray( x.length, 1, x, 1, ( x: number ): number => x ); // $ExpectError
175
- }
176
-
177
- // The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments...
178
- {
179
- const x = new Float32Array( 10 );
180
-
181
- snanstdevpn.ndarray(); // $ExpectError
182
- snanstdevpn.ndarray( x.length ); // $ExpectError
183
- snanstdevpn.ndarray( x.length, 1 ); // $ExpectError
184
- snanstdevpn.ndarray( x.length, 1, x ); // $ExpectError
185
- snanstdevpn.ndarray( x.length, 1, x, 1 ); // $ExpectError
186
- snanstdevpn.ndarray( x.length, 1, x, 1, 0, 10 ); // $ExpectError
187
- }