@stdlib/stats-base-snanvariancepn 0.0.7 → 0.1.0

package/CITATION.cff

@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+title: stdlib
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+
+type: software
+
+authors:
+  - name: The Stdlib Authors
+    url: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+repository-code: https://github.com/stdlib-js/stdlib
+url: https://stdlib.io
+
+abstract: |
+  Standard library for JavaScript and Node.js.
+
+keywords:
+  - JavaScript
+  - Node.js
+  - TypeScript
+  - standard library
+  - scientific computing
+  - numerical computing
+  - statistical computing
+
+license: Apache-2.0 AND BSL-1.0
+
+date-released: 2016

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2022 The Stdlib Authors.
+Copyright (c) 2016-2023 The Stdlib Authors.

package/README.md

@@ -18,6 +18,17 @@ limitations under the License.
 
 -->
 
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <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>
+  <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>
+  <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>
+  <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>
+</details>
+
 # snanvariancepn
 
 [![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 [variance][variance] of a finite size population of size `N` is g
 <div class="equation" align="center" data-raw-text="\sigma^2 = \frac{1}{N} \sum_{i=0}^{N-1} (x_i - \mu)^2" data-equation="eq:population_variance">
     <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@d78f524f2ccddb696670f1a30bb4a39b5b6e8e19/lib/node_modules/@stdlib/stats/base/snanvariancepn/docs/img/equation_population_variance.svg" alt="Equation for the population variance.">
     <br>
-</div>
+</div> -->
 
 <!-- </equation> -->
 
@@ -41,10 +52,10 @@ where the population mean is given by
 
 <!-- <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."> -->
 
-<div class="equation" align="center" data-raw-text="\mu = \frac{1}{N} \sum_{i=0}^{N-1} x_i" data-equation="eq:population_mean">
+<!-- <div class="equation" align="center" data-raw-text="\mu = \frac{1}{N} \sum_{i=0}^{N-1} x_i" data-equation="eq:population_mean">
     <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@d78f524f2ccddb696670f1a30bb4a39b5b6e8e19/lib/node_modules/@stdlib/stats/base/snanvariancepn/docs/img/equation_population_mean.svg" alt="Equation for the population mean.">
     <br>
-</div>
+</div> -->
 
 <!-- </equation> -->
 
@@ -52,10 +63,10 @@ Often in the analysis of data, the true population [variance][variance] is not k
 
 <!-- <equation class="equation" label="eq:unbiased_sample_variance" align="center" raw="s^2 = \frac{1}{n-1} \sum_{i=0}^{n-1} (x_i - \bar{x})^2" alt="Equation for computing an unbiased sample variance."> -->
 
-<div class="equation" align="center" data-raw-text="s^2 = \frac{1}{n-1} \sum_{i=0}^{n-1} (x_i - \bar{x})^2" data-equation="eq:unbiased_sample_variance">
+<!-- <div class="equation" align="center" data-raw-text="s^2 = \frac{1}{n-1} \sum_{i=0}^{n-1} (x_i - \bar{x})^2" data-equation="eq:unbiased_sample_variance">
     <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@d78f524f2ccddb696670f1a30bb4a39b5b6e8e19/lib/node_modules/@stdlib/stats/base/snanvariancepn/docs/img/equation_unbiased_sample_variance.svg" alt="Equation for computing an unbiased sample variance.">
     <br>
-</div>
+</div> -->
 
 <!-- </equation> -->
 
@@ -63,7 +74,7 @@ where the sample mean is given by
 
 <!-- <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."> -->
 
-<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">
+<!-- <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">
     <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@d78f524f2ccddb696670f1a30bb4a39b5b6e8e19/lib/node_modules/@stdlib/stats/base/snanvariancepn/docs/img/equation_sample_mean.svg" alt="Equation for the sample mean.">
     <br>
 </div>
@@ -239,11 +250,11 @@ console.log( v );
 
 ## See Also
 
--   <span class="package-name">[`@stdlib/stats/base/dnanvariancepn`][@stdlib/stats/base/dnanvariancepn]</span><span class="delimiter">: </span><span class="description">calculate the variance of a double-precision floating-point strided array ignoring NaN values and using a two-pass algorithm.</span>
--   <span class="package-name">[`@stdlib/stats/base/nanvariancepn`][@stdlib/stats/base/nanvariancepn]</span><span class="delimiter">: </span><span class="description">calculate the variance of a strided array ignoring NaN values and using a two-pass algorithm.</span>
--   <span class="package-name">[`@stdlib/stats/base/snanstdevpn`][@stdlib/stats/base/snanstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array ignoring NaN values and using a two-pass algorithm.</span>
--   <span class="package-name">[`@stdlib/stats/base/snanvariance`][@stdlib/stats/base/snanvariance]</span><span class="delimiter">: </span><span class="description">calculate the variance of a single-precision floating-point strided array ignoring NaN values.</span>
--   <span class="package-name">[`@stdlib/stats/base/svariancepn`][@stdlib/stats/base/svariancepn]</span><span class="delimiter">: </span><span class="description">calculate the variance of a single-precision floating-point strided array using a two-pass algorithm.</span>
+-   <span class="package-name">[`@stdlib/stats-base/dnanvariancepn`][@stdlib/stats/base/dnanvariancepn]</span><span class="delimiter">: </span><span class="description">calculate the variance of a double-precision floating-point strided array ignoring NaN values and using a two-pass algorithm.</span>
+-   <span class="package-name">[`@stdlib/stats-base/nanvariancepn`][@stdlib/stats/base/nanvariancepn]</span><span class="delimiter">: </span><span class="description">calculate the variance of a strided array ignoring NaN values and using a two-pass algorithm.</span>
+-   <span class="package-name">[`@stdlib/stats-base/snanstdevpn`][@stdlib/stats/base/snanstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array ignoring NaN values and using a two-pass algorithm.</span>
+-   <span class="package-name">[`@stdlib/stats-base/snanvariance`][@stdlib/stats/base/snanvariance]</span><span class="delimiter">: </span><span class="description">calculate the variance of a single-precision floating-point strided array ignoring NaN values.</span>
+-   <span class="package-name">[`@stdlib/stats-base/svariancepn`][@stdlib/stats/base/svariancepn]</span><span class="delimiter">: </span><span class="description">calculate the variance of a single-precision floating-point strided array using a two-pass algorithm.</span>
 
 </section>
 
@@ -275,7 +286,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -288,8 +299,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-snanvariancepn.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-snanvariancepn
 
-[test-image]: https://github.com/stdlib-js/stats-base-snanvariancepn/actions/workflows/test.yml/badge.svg?branch=v0.0.7
-[test-url]: https://github.com/stdlib-js/stats-base-snanvariancepn/actions/workflows/test.yml?query=branch:v0.0.7
+[test-image]: https://github.com/stdlib-js/stats-base-snanvariancepn/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/stats-base-snanvariancepn/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-snanvariancepn/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-snanvariancepn?branch=main
@@ -302,7 +313,7 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 -->
 
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import snanvariancepn from '../docs/types/index';
+export = snanvariancepn;

package/dist/index.js

@@ -0,0 +1,11 @@
+"use strict";var C=function(v,e){return function(){return e||v((e={exports:{}}).exports,e),e.exports}};var K=C(function($,A){
+var u=require('@stdlib/number-float64-base-to-float32/dist'),g=require('@stdlib/math-base-special-floor/dist'),h=128;function F(v,e,i,n,R){var a,t,c,o,p,q,s,l,E,T,O,f,r,y;if(a=R,v<8){for(O=0,f=0,y=0;y<v;y++)r=i[a],r===r&&(O=u(O+r),f+=1),a+=n;return e[0]=u(e[0]+O),e[1]+=f,e}if(v<=h){for(t=0,c=0,o=0,p=0,q=0,s=0,l=0,E=0,f=0,T=v%8,y=0;y<v-T;y+=8)r=i[a],r===r&&(t=u(t+r),f+=1),a+=n,r=i[a],r===r&&(c=u(c+r),f+=1),a+=n,r=i[a],r===r&&(o=u(o+r),f+=1),a+=n,r=i[a],r===r&&(p=u(p+r),f+=1),a+=n,r=i[a],r===r&&(q=u(q+r),f+=1),a+=n,r=i[a],r===r&&(s=u(s+r),f+=1),a+=n,r=i[a],r===r&&(l=u(l+r),f+=1),a+=n,r=i[a],r===r&&(E=u(E+r),f+=1),a+=n;for(O=u(u(u(t+c)+u(o+p))+u(u(q+s)+u(l+E))),y;y<v;y++)r=i[a],r===r&&(O=u(O+r),f+=1),a+=n;return e[0]=u(e[0]+O),e[1]+=f,e}return f=g(v/2),f-=f%8,u(F(f,e,i,n,a)+F(v-f,e,i,n,a+f*n))}A.exports=F
+});var W=C(function(N,P){
+var m=require('@stdlib/number-float64-base-to-float32/dist'),k=K(),j=[0,0];function z(v,e,i,n){var R,a,t,c,o,p,q,s,l;if(v<=0)return NaN;if(v===1||n===0)return q=i[0],q===q&&v-e>0?0:NaN;if(n<0?a=(1-v)*n:a=0,j[0]=0,j[1]=0,k(v,j,i,n,a),s=j[1],c=s-e,c<=0)return NaN;for(R=m(j[0]/s),t=0,o=0,l=0;l<v;l++)q=i[a],q===q&&(p=m(q-R),t=m(t+m(p*p)),o=m(o+p),s+=1),a+=n;return m(m(t/c)-m(m(o/s)*m(o/c)))}P.exports=z
+});var B=C(function(x,_){
+var M=require('@stdlib/number-float64-base-to-float32/dist'),D=K(),w=[0,0];function G(v,e,i,n,R){var a,t,c,o,p,q,s,l,E;if(v<=0)return NaN;if(v===1||n===0)return s=i[R],s===s&&v-e>0?0:NaN;if(t=R,w[0]=0,w[1]=0,D(v,w,i,n,t),l=w[1],o=l-e,o<=0)return NaN;for(a=M(w[0]/l),c=0,p=0,E=0;E<v;E++)s=i[t],s===s&&(q=M(s-a),c=M(c+M(q*q)),p=M(p+q),l+=1),t+=n;return M(M(c/o)-M(M(p/l)*M(p/o)))}_.exports=G
+});var Z=C(function(d,L){
+var H=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),I=W(),J=B();H(I,"ndarray",J);L.exports=I
+});var Q=require("path").join,U=require('@stdlib/utils-try-require/dist'),V=require('@stdlib/assert-is-error/dist'),X=Z(),S,b=U(Q(__dirname,"./native.js"));V(b)?S=X:S=b;module.exports=S;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/snansumpw.js", "../lib/snanvariancepn.js", "../lib/ndarray.js", "../lib/main.js", "../lib/index.js"],
+  "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 floor = require( '@stdlib/math-base-special-floor' );\n\n\n// VARIABLES //\n\n// Blocksize for pairwise summation (NOTE: decreasing the blocksize decreases rounding error as more pairs are summed, but also decreases performance. Because the inner loop is unrolled eight times, the blocksize is effectively `16`.):\nvar BLOCKSIZE = 128;\n\n\n// MAIN //\n\n/**\n* Computes the sum of a double-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation.\n*\n* ## Method\n*\n* -   This implementation uses pairwise summation, which accrues rounding error `O(log2 N)` instead of `O(N)`. The recursion depth is also `O(log2 N)`.\n*\n* ## References\n*\n* -   Higham, Nicholas J. 1993. \"The Accuracy of Floating Point Summation.\" _SIAM Journal on Scientific Computing_ 14 (4): 783\u201399. doi:[10.1137/0914050](https://doi.org/10.1137/0914050).\n*\n* @private\n* @param {PositiveInteger} N - number of indexed elements\n* @param {NumericArray} out - two-element output array whose first element is the accumulated sum and whose second element is the accumulated number of summed values\n* @param {Float32Array} x - input array\n* @param {integer} stride - stride length\n* @param {NonNegativeInteger} offset - starting index\n* @returns {NumericArray} output array\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 out = [ 0.0, 0 ];\n* var v = snansumpw( N, out, x, 2, 1 );\n* // returns [ 5.0, 4 ]\n*/\nfunction snansumpw( N, out, x, stride, offset ) {\n\tvar ix;\n\tvar s0;\n\tvar s1;\n\tvar s2;\n\tvar s3;\n\tvar s4;\n\tvar s5;\n\tvar s6;\n\tvar s7;\n\tvar M;\n\tvar s;\n\tvar n;\n\tvar v;\n\tvar i;\n\n\tix = offset;\n\tif ( N < 8 ) {\n\t\t// Use simple summation...\n\t\ts = 0.0;\n\t\tn = 0;\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\tv = x[ ix ];\n\t\t\tif ( v === v ) {\n\t\t\t\ts = float64ToFloat32( s + v );\n\t\t\t\tn += 1;\n\t\t\t}\n\t\t\tix += stride;\n\t\t}\n\t\tout[ 0 ] = float64ToFloat32( out[ 0 ] + s );\n\t\tout[ 1 ] += n;\n\t\treturn out;\n\t}\n\tif ( N <= BLOCKSIZE ) {\n\t\t// Sum a block with 8 accumulators (by loop unrolling, we lower the effective blocksize to 16)...\n\t\ts0 = 0.0;\n\t\ts1 = 0.0;\n\t\ts2 = 0.0;\n\t\ts3 = 0.0;\n\t\ts4 = 0.0;\n\t\ts5 = 0.0;\n\t\ts6 = 0.0;\n\t\ts7 = 0.0;\n\t\tn = 0;\n\n\t\tM = N % 8;\n\t\tfor ( i = 0; i < N-M; i += 8 ) {\n\t\t\tv = x[ ix ];\n\t\t\tif ( v === v ) {\n\t\t\t\ts0 = float64ToFloat32( s0 + v );\n\t\t\t\tn += 1;\n\t\t\t}\n\t\t\tix += stride;\n\t\t\tv = x[ ix ];\n\t\t\tif ( v === v ) {\n\t\t\t\ts1 = float64ToFloat32( s1 + v );\n\t\t\t\tn += 1;\n\t\t\t}\n\t\t\tix += stride;\n\t\t\tv = x[ ix ];\n\t\t\tif ( v === v ) {\n\t\t\t\ts2 = float64ToFloat32( s2 + v );\n\t\t\t\tn += 1;\n\t\t\t}\n\t\t\tix += stride;\n\t\t\tv = x[ ix ];\n\t\t\tif ( v === v ) {\n\t\t\t\ts3 = float64ToFloat32( s3 + v );\n\t\t\t\tn += 1;\n\t\t\t}\n\t\t\tix += stride;\n\t\t\tv = x[ ix ];\n\t\t\tif ( v === v ) {\n\t\t\t\ts4 = float64ToFloat32( s4 + v );\n\t\t\t\tn += 1;\n\t\t\t}\n\t\t\tix += stride;\n\t\t\tv = x[ ix ];\n\t\t\tif ( v === v ) {\n\t\t\t\ts5 = float64ToFloat32( s5 + v );\n\t\t\t\tn += 1;\n\t\t\t}\n\t\t\tix += stride;\n\t\t\tv = x[ ix ];\n\t\t\tif ( v === v ) {\n\t\t\t\ts6 = float64ToFloat32( s6 + v );\n\t\t\t\tn += 1;\n\t\t\t}\n\t\t\tix += stride;\n\t\t\tv = x[ ix ];\n\t\t\tif ( v === v ) {\n\t\t\t\ts7 = float64ToFloat32( s7 + v );\n\t\t\t\tn += 1;\n\t\t\t}\n\t\t\tix += stride;\n\t\t}\n\t\t// Pairwise sum the accumulators:\n\t\ts = float64ToFloat32( float64ToFloat32(float64ToFloat32(s0+s1) + float64ToFloat32(s2+s3)) + float64ToFloat32(float64ToFloat32(s4+s5) + float64ToFloat32(s6+s7)) ); // eslint-disable-line max-len\n\n\t\t// Clean-up loop...\n\t\tfor ( i; i < N; i++ ) {\n\t\t\tv = x[ ix ];\n\t\t\tif ( v === v ) {\n\t\t\t\ts = float64ToFloat32( s + v );\n\t\t\t\tn += 1;\n\t\t\t}\n\t\t\tix += stride;\n\t\t}\n\t\tout[ 0 ] = float64ToFloat32( out[ 0 ] + s );\n\t\tout[ 1 ] += n;\n\t\treturn out;\n\t}\n\t// Recurse by dividing by two, but avoiding non-multiples of unroll factor...\n\tn = floor( N/2 );\n\tn -= n % 8;\n\treturn float64ToFloat32( snansumpw( n, out, x, stride, ix ) + snansumpw( N-n, out, x, stride, ix+(n*stride) ) ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = snansumpw;\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 snansumpw = require( './snansumpw.js' );\n\n\n// VARIABLES //\n\nvar WORKSPACE = [ 0.0, 0 ];\n\n\n// MAIN //\n\n/**\n* Computes the variance of a single-precision floating-point strided array ignoring `NaN` values and using a two-pass algorithm.\n*\n* ## Method\n*\n* -   This implementation uses a two-pass approach, as suggested by Neely (1966).\n*\n* ## References\n*\n* -   Neely, Peter M. 1966. \"Comparison of Several Algorithms for Computation of Means, Standard Deviations and Correlation Coefficients.\" _Communications of the ACM_ 9 (7). Association for Computing Machinery: 496\u201399. doi:[10.1145/365719.365958](https://doi.org/10.1145/365719.365958).\n* -   Schubert, Erich, and Michael Gertz. 2018. \"Numerically Stable Parallel Computation of (Co-)Variance.\" In _Proceedings of the 30th International Conference on Scientific and Statistical Database Management_. New York, NY, USA: Association for Computing Machinery. doi:[10.1145/3221269.3223036](https://doi.org/10.1145/3221269.3223036).\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} variance\n*\n* @example\n* var Float32Array = require( '@stdlib/array-float32' );\n*\n* var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );\n* var N = x.length;\n*\n* var v = snanvariancepn( N, 1, x, 1 );\n* // returns ~4.3333\n*/\nfunction snanvariancepn( N, correction, x, stride ) {\n\tvar mu;\n\tvar ix;\n\tvar M2;\n\tvar nc;\n\tvar M;\n\tvar d;\n\tvar v;\n\tvar n;\n\tvar i;\n\n\tif ( N <= 0 ) {\n\t\treturn NaN;\n\t}\n\tif ( N === 1 || stride === 0 ) {\n\t\tv = x[ 0 ];\n\t\tif ( v === v && N-correction > 0.0 ) {\n\t\t\treturn 0.0;\n\t\t}\n\t\treturn NaN;\n\t}\n\tif ( stride < 0 ) {\n\t\tix = (1-N) * stride;\n\t} else {\n\t\tix = 0;\n\t}\n\t// Compute an estimate for the mean...\n\tWORKSPACE[ 0 ] = 0.0;\n\tWORKSPACE[ 1 ] = 0;\n\tsnansumpw( N, WORKSPACE, x, stride, ix );\n\tn = WORKSPACE[ 1 ];\n\tnc = n - correction;\n\tif ( nc <= 0.0 ) {\n\t\treturn NaN;\n\t}\n\tmu = float64ToFloat32( WORKSPACE[ 0 ] / n );\n\n\t// Compute the variance...\n\tM2 = 0.0;\n\tM = 0.0;\n\tfor ( i = 0; i < N; i++ ) {\n\t\tv = x[ ix ];\n\t\tif ( v === v ) {\n\t\t\td = float64ToFloat32( v - mu );\n\t\t\tM2 = float64ToFloat32( M2 + float64ToFloat32( d*d ) );\n\t\t\tM = float64ToFloat32( M + d );\n\t\t\tn += 1;\n\t\t}\n\t\tix += stride;\n\t}\n\treturn float64ToFloat32( float64ToFloat32(M2/nc) - float64ToFloat32(float64ToFloat32(M/n)*float64ToFloat32(M/nc)) ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = snanvariancepn;\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 snansumpw = require( './snansumpw.js' );\n\n\n// VARIABLES //\n\nvar WORKSPACE = [ 0.0, 0 ];\n\n\n// MAIN //\n\n/**\n* Computes the variance of a single-precision floating-point strided array ignoring `NaN` values and using a two-pass algorithm.\n*\n* ## Method\n*\n* -   This implementation uses a two-pass approach, as suggested by Neely (1966).\n*\n* ## References\n*\n* -   Neely, Peter M. 1966. \"Comparison of Several Algorithms for Computation of Means, Standard Deviations and Correlation Coefficients.\" _Communications of the ACM_ 9 (7). Association for Computing Machinery: 496\u201399. doi:[10.1145/365719.365958](https://doi.org/10.1145/365719.365958).\n* -   Schubert, Erich, and Michael Gertz. 2018. \"Numerically Stable Parallel Computation of (Co-)Variance.\" In _Proceedings of the 30th International Conference on Scientific and Statistical Database Management_. New York, NY, USA: Association for Computing Machinery. doi:[10.1145/3221269.3223036](https://doi.org/10.1145/3221269.3223036).\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} variance\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 = snanvariancepn( N, 1, x, 2, 1 );\n* // returns 6.25\n*/\nfunction snanvariancepn( N, correction, x, stride, offset ) {\n\tvar mu;\n\tvar ix;\n\tvar M2;\n\tvar nc;\n\tvar M;\n\tvar d;\n\tvar v;\n\tvar n;\n\tvar i;\n\n\tif ( N <= 0 ) {\n\t\treturn NaN;\n\t}\n\tif ( N === 1 || stride === 0 ) {\n\t\tv = x[ offset ];\n\t\tif ( v === v && N-correction > 0.0 ) {\n\t\t\treturn 0.0;\n\t\t}\n\t\treturn NaN;\n\t}\n\tix = offset;\n\n\t// Compute an estimate for the mean...\n\tWORKSPACE[ 0 ] = 0.0;\n\tWORKSPACE[ 1 ] = 0;\n\tsnansumpw( N, WORKSPACE, x, stride, ix );\n\tn = WORKSPACE[ 1 ];\n\tnc = n - correction;\n\tif ( nc <= 0.0 ) {\n\t\treturn NaN;\n\t}\n\tmu = float64ToFloat32( WORKSPACE[ 0 ] / n );\n\n\t// Compute the variance...\n\tM2 = 0.0;\n\tM = 0.0;\n\tfor ( i = 0; i < N; i++ ) {\n\t\tv = x[ ix ];\n\t\tif ( v === v ) {\n\t\t\td = float64ToFloat32( v - mu );\n\t\t\tM2 = float64ToFloat32( M2 + float64ToFloat32( d*d ) );\n\t\t\tM = float64ToFloat32( M + d );\n\t\t\tn += 1;\n\t\t}\n\t\tix += stride;\n\t}\n\treturn float64ToFloat32( float64ToFloat32(M2/nc) - float64ToFloat32(float64ToFloat32(M/n)*float64ToFloat32(M/nc)) ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = snanvariancepn;\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 snanvariancepn = require( './snanvariancepn.js' );\nvar ndarray = require( './ndarray.js' );\n\n\n// MAIN //\n\nsetReadOnly( snanvariancepn, 'ndarray', ndarray );\n\n\n// EXPORTS //\n\nmodule.exports = snanvariancepn;\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 variance of a single-precision floating-point strided array ignoring `NaN` values and using a two-pass algorithm.\n*\n* @module @stdlib/stats-base-snanvariancepn\n*\n* @example\n* var Float32Array = require( '@stdlib/array-float32' );\n* var snanvariancepn = require( '@stdlib/stats-base-snanvariancepn' );\n*\n* var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );\n*\n* var v = snanvariancepn( x.length, 1, x, 1 );\n* // returns ~4.3333\n*\n* @example\n* var Float32Array = require( '@stdlib/array-float32' );\n* var floor = require( '@stdlib/math-base-special-floor' );\n* var snanvariancepn = require( '@stdlib/stats-base-snanvariancepn' );\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 = snanvariancepn.ndarray( N, 1, x, 2, 1 );\n* // returns 6.25\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 snanvariancepn;\nvar tmp = tryRequire( join( __dirname, './native.js' ) );\nif ( isError( tmp ) ) {\n\tsnanvariancepn = main;\n} else {\n\tsnanvariancepn = tmp;\n}\n\n\n// EXPORTS //\n\nmodule.exports = snanvariancepn;\n\n// exports: { \"ndarray\": \"snanvariancepn.ndarray\" }\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,wCAAyC,EACrEC,EAAQ,QAAS,iCAAkC,EAMnDC,EAAY,IAmChB,SAASC,EAAWC,EAAGC,EAAKC,EAAGC,EAAQC,EAAS,CAC/C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAGJ,GADAb,EAAKD,EACAJ,EAAI,EAAI,CAIZ,IAFAe,EAAI,EACJC,EAAI,EACEE,EAAI,EAAGA,EAAIlB,EAAGkB,IACnBD,EAAIf,EAAGG,CAAG,EACLY,IAAMA,IACVF,EAAInB,EAAkBmB,EAAIE,CAAE,EAC5BD,GAAK,GAENX,GAAMF,EAEP,OAAAF,EAAK,CAAE,EAAIL,EAAkBK,EAAK,CAAE,EAAIc,CAAE,EAC1Cd,EAAK,CAAE,GAAKe,EACLf,CACR,CACA,GAAKD,GAAKF,EAAY,CAarB,IAXAQ,EAAK,EACLC,EAAK,EACLC,EAAK,EACLC,EAAK,EACLC,EAAK,EACLC,EAAK,EACLC,EAAK,EACLC,EAAK,EACLG,EAAI,EAEJF,EAAId,EAAI,EACFkB,EAAI,EAAGA,EAAIlB,EAAEc,EAAGI,GAAK,EAC1BD,EAAIf,EAAGG,CAAG,EACLY,IAAMA,IACVX,EAAKV,EAAkBU,EAAKW,CAAE,EAC9BD,GAAK,GAENX,GAAMF,EACNc,EAAIf,EAAGG,CAAG,EACLY,IAAMA,IACVV,EAAKX,EAAkBW,EAAKU,CAAE,EAC9BD,GAAK,GAENX,GAAMF,EACNc,EAAIf,EAAGG,CAAG,EACLY,IAAMA,IACVT,EAAKZ,EAAkBY,EAAKS,CAAE,EAC9BD,GAAK,GAENX,GAAMF,EACNc,EAAIf,EAAGG,CAAG,EACLY,IAAMA,IACVR,EAAKb,EAAkBa,EAAKQ,CAAE,EAC9BD,GAAK,GAENX,GAAMF,EACNc,EAAIf,EAAGG,CAAG,EACLY,IAAMA,IACVP,EAAKd,EAAkBc,EAAKO,CAAE,EAC9BD,GAAK,GAENX,GAAMF,EACNc,EAAIf,EAAGG,CAAG,EACLY,IAAMA,IACVN,EAAKf,EAAkBe,EAAKM,CAAE,EAC9BD,GAAK,GAENX,GAAMF,EACNc,EAAIf,EAAGG,CAAG,EACLY,IAAMA,IACVL,EAAKhB,EAAkBgB,EAAKK,CAAE,EAC9BD,GAAK,GAENX,GAAMF,EACNc,EAAIf,EAAGG,CAAG,EACLY,IAAMA,IACVJ,EAAKjB,EAAkBiB,EAAKI,CAAE,EAC9BD,GAAK,GAENX,GAAMF,EAMP,IAHAY,EAAInB,EAAkBA,EAAiBA,EAAiBU,EAAGC,CAAE,EAAIX,EAAiBY,EAAGC,CAAE,CAAC,EAAIb,EAAiBA,EAAiBc,EAAGC,CAAE,EAAIf,EAAiBgB,EAAGC,CAAE,CAAC,CAAE,EAG1JK,EAAGA,EAAIlB,EAAGkB,IACfD,EAAIf,EAAGG,CAAG,EACLY,IAAMA,IACVF,EAAInB,EAAkBmB,EAAIE,CAAE,EAC5BD,GAAK,GAENX,GAAMF,EAEP,OAAAF,EAAK,CAAE,EAAIL,EAAkBK,EAAK,CAAE,EAAIc,CAAE,EAC1Cd,EAAK,CAAE,GAAKe,EACLf,CACR,CAEA,OAAAe,EAAInB,EAAOG,EAAE,CAAE,EACfgB,GAAKA,EAAI,EACFpB,EAAkBG,EAAWiB,EAAGf,EAAKC,EAAGC,EAAQE,CAAG,EAAIN,EAAWC,EAAEgB,EAAGf,EAAKC,EAAGC,EAAQE,EAAIW,EAAEb,CAAQ,CAAE,CAC/G,CAKAR,EAAO,QAAUI,ICzLjB,IAAAoB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,wCAAyC,EACrEC,EAAY,IAKZC,EAAY,CAAE,EAAK,CAAE,EAgCzB,SAASC,EAAgBC,EAAGC,EAAYC,EAAGC,EAAS,CACnD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAKZ,GAAK,EACT,MAAO,KAER,GAAKA,IAAM,GAAKG,IAAW,EAE1B,OADAO,EAAIR,EAAG,CAAE,EACJQ,IAAMA,GAAKV,EAAEC,EAAa,EACvB,EAED,IAaR,GAXKE,EAAS,EACbE,GAAM,EAAEL,GAAKG,EAEbE,EAAK,EAGNP,EAAW,CAAE,EAAI,EACjBA,EAAW,CAAE,EAAI,EACjBD,EAAWG,EAAGF,EAAWI,EAAGC,EAAQE,CAAG,EACvCM,EAAIb,EAAW,CAAE,EACjBS,EAAKI,EAAIV,EACJM,GAAM,EACV,MAAO,KAOR,IALAH,EAAKR,EAAkBE,EAAW,CAAE,EAAIa,CAAE,EAG1CL,EAAK,EACLE,EAAI,EACEI,EAAI,EAAGA,EAAIZ,EAAGY,IACnBF,EAAIR,EAAGG,CAAG,EACLK,IAAMA,IACVD,EAAIb,EAAkBc,EAAIN,CAAG,EAC7BE,EAAKV,EAAkBU,EAAKV,EAAkBa,EAAEA,CAAE,CAAE,EACpDD,EAAIZ,EAAkBY,EAAIC,CAAE,EAC5BE,GAAK,GAENN,GAAMF,EAEP,OAAOP,EAAkBA,EAAiBU,EAAGC,CAAE,EAAIX,EAAiBA,EAAiBY,EAAEG,CAAC,EAAEf,EAAiBY,EAAED,CAAE,CAAC,CAAE,CACnH,CAKAZ,EAAO,QAAUI,ICpHjB,IAAAc,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,wCAAyC,EACrEC,EAAY,IAKZC,EAAY,CAAE,EAAK,CAAE,EAkCzB,SAASC,EAAgBC,EAAGC,EAAYC,EAAGC,EAAQC,EAAS,CAC3D,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAKb,GAAK,EACT,MAAO,KAER,GAAKA,IAAM,GAAKG,IAAW,EAE1B,OADAQ,EAAIT,EAAGE,CAAO,EACTO,IAAMA,GAAKX,EAAEC,EAAa,EACvB,EAED,IAUR,GARAK,EAAKF,EAGLN,EAAW,CAAE,EAAI,EACjBA,EAAW,CAAE,EAAI,EACjBD,EAAWG,EAAGF,EAAWI,EAAGC,EAAQG,CAAG,EACvCM,EAAId,EAAW,CAAE,EACjBU,EAAKI,EAAIX,EACJO,GAAM,EACV,MAAO,KAOR,IALAH,EAAKT,EAAkBE,EAAW,CAAE,EAAIc,CAAE,EAG1CL,EAAK,EACLE,EAAI,EACEI,EAAI,EAAGA,EAAIb,EAAGa,IACnBF,EAAIT,EAAGI,CAAG,EACLK,IAAMA,IACVD,EAAId,EAAkBe,EAAIN,CAAG,EAC7BE,EAAKX,EAAkBW,EAAKX,EAAkBc,EAAEA,CAAE,CAAE,EACpDD,EAAIb,EAAkBa,EAAIC,CAAE,EAC5BE,GAAK,GAENN,GAAMH,EAEP,OAAOP,EAAkBA,EAAiBW,EAAGC,CAAE,EAAIZ,EAAiBA,EAAiBa,EAAEG,CAAC,EAAEhB,EAAiBa,EAAED,CAAE,CAAC,CAAE,CACnH,CAKAb,EAAO,QAAUI,ICnHjB,IAAAe,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAiB,IACjBC,EAAU,IAKdF,EAAaC,EAAgB,UAAWC,CAAQ,EAKhDH,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,EAAiBD,EAEjBC,EAAiBC,EAMlB,OAAO,QAAUD",
+  "names": ["require_snansumpw", "__commonJSMin", "exports", "module", "float64ToFloat32", "floor", "BLOCKSIZE", "snansumpw", "N", "out", "x", "stride", "offset", "ix", "s0", "s1", "s2", "s3", "s4", "s5", "s6", "s7", "M", "s", "n", "v", "i", "require_snanvariancepn", "__commonJSMin", "exports", "module", "float64ToFloat32", "snansumpw", "WORKSPACE", "snanvariancepn", "N", "correction", "x", "stride", "mu", "ix", "M2", "nc", "M", "d", "v", "n", "i", "require_ndarray", "__commonJSMin", "exports", "module", "float64ToFloat32", "snansumpw", "WORKSPACE", "snanvariancepn", "N", "correction", "x", "stride", "offset", "mu", "ix", "M2", "nc", "M", "d", "v", "n", "i", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "snanvariancepn", "ndarray", "join", "tryRequire", "isError", "main", "snanvariancepn", "tmp"]
+}

package/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Interface describing `snanvariancepn`.

package/lib/index.js

@@ -48,6 +48,7 @@
 
 var join = require( 'path' ).join;
 var tryRequire = require( '@stdlib/utils-try-require' );
+var isError = require( '@stdlib/assert-is-error' );
 var main = require( './main.js' );
 
 
@@ -55,7 +56,7 @@ var main = require( './main.js' );
 
 var snanvariancepn;
 var tmp = tryRequire( join( __dirname, './native.js' ) );
-if ( tmp instanceof Error ) {
+if ( isError( tmp ) ) {
 	snanvariancepn = main;
 } else {
 	snanvariancepn = tmp;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-snanvariancepn",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "Calculate the variance of a single-precision floating-point strided array ignoring NaN values and using a two-pass algorithm.",
   "license": "Apache-2.0",
   "author": {
@@ -41,24 +41,25 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/math-base-special-floor": "^0.0.x",
-    "@stdlib/number-float64-base-to-float32": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x",
-    "@stdlib/utils-library-manifest": "^0.0.x",
-    "@stdlib/utils-try-require": "^0.0.x"
+    "@stdlib/assert-is-error": "^0.1.0",
+    "@stdlib/math-base-special-floor": "^0.1.0",
+    "@stdlib/number-float64-base-to-float32": "^0.1.0",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0",
+    "@stdlib/utils-library-manifest": "^0.1.0",
+    "@stdlib/utils-try-require": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/array-float32": "^0.0.x",
-    "@stdlib/assert-is-browser": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/math-base-assert-is-nanf": "^0.0.x",
-    "@stdlib/math-base-special-pow": "^0.0.x",
-    "@stdlib/math-base-special-round": "^0.0.x",
-    "@stdlib/random-base-randu": "^0.0.x",
+    "@stdlib/array-float32": "^0.1.0",
+    "@stdlib/assert-is-browser": "^0.1.0",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/math-base-assert-is-nanf": "^0.1.0",
+    "@stdlib/math-base-special-pow": "^0.0.7",
+    "@stdlib/math-base-special-round": "^0.1.0",
+    "@stdlib/random-base-randu": "^0.0.8",
     "proxyquire": "^2.0.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -102,7 +103,7 @@
   ],
   "__stdlib__": {},
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,121 +0,0 @@
-
-{{alias}}( N, correction, x, stride )
-    Computes the variance of a single-precision floating-point strided array
-    ignoring `NaN` values and using a two-pass algorithm.
-
-    The `N` and `stride` parameters determine which elements in `x` are accessed
-    at runtime.
-
-    Indexing is relative to the first index. To introduce an offset, use a typed
-    array view.
-
-    If `N <= 0`, the function returns `NaN`.
-
-    If every indexed element is `NaN`, the function returns `NaN`.
-
-    Parameters
-    ----------
-    N: integer
-        Number of indexed elements.
-
-    correction: number
-        Degrees of freedom adjustment. Setting this parameter to a value other
-        than `0` has the effect of adjusting the divisor during the calculation
-        of the variance according to `n - c` where `c` corresponds to the
-        provided degrees of freedom adjustment and `n` corresponds to the number
-        of non-`NaN` indexed elements. When computing the variance of a
-        population, setting this parameter to `0` is the standard choice (i.e.,
-        the provided array contains data constituting an entire population).
-        When computing the unbiased sample variance, setting this parameter to
-        `1` is the standard choice (i.e., the provided array contains data
-        sampled from a larger population; this is commonly referred to as
-        Bessel's correction).
-
-    x: Float32Array
-        Input array.
-
-    stride: integer
-        Index increment.
-
-    Returns
-    -------
-    out: number
-        The variance.
-
-    Examples
-    --------
-    // Standard Usage:
-    > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, NaN, 2.0 ] );
-    > {{alias}}( x.length, 1, x, 1 )
-    ~4.3333
-
-    // Using `N` and `stride` parameters:
-    > x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > {{alias}}( N, 1, x, 2 )
-    ~4.3333
-
-    // Using view offsets:
-    > var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
-    > var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
-    > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
-    > {{alias}}( N, 1, x1, 2 )
-    ~4.3333
-
-{{alias}}.ndarray( N, correction, x, stride, offset )
-    Computes the variance of a single-precision floating-point strided array
-    ignoring `NaN` values and using a two-pass algorithm and alternative
-    indexing semantics.
-
-    While typed array views mandate a view offset based on the underlying
-    buffer, the `offset` parameter supports indexing semantics based on a
-    starting index.
-
-    Parameters
-    ----------
-    N: integer
-        Number of indexed elements.
-
-    correction: number
-        Degrees of freedom adjustment. Setting this parameter to a value other
-        than `0` has the effect of adjusting the divisor during the calculation
-        of the variance according to `n - c` where `c` corresponds to the
-        provided degrees of freedom adjustment and `n` corresponds to the number
-        of non-`NaN` indexed elements. When computing the variance of a
-        population, setting this parameter to `0` is the standard choice (i.e.,
-        the provided array contains data constituting an entire population).
-        When computing the unbiased sample variance, setting this parameter to
-        `1` is the standard choice (i.e., the provided array contains data
-        sampled from a larger population; this is commonly referred to as
-        Bessel's correction).
-
-    x: Float32Array
-        Input array.
-
-    stride: integer
-        Index increment.
-
-    offset: integer
-        Starting index.
-
-    Returns
-    -------
-    out: number
-        The variance.
-
-    Examples
-    --------
-    // Standard Usage:
-    > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, NaN, 2.0 ] );
-    > {{alias}}.ndarray( x.length, 1, x, 1, 0 )
-    ~4.3333
-
-    // Using offset parameter:
-    > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > {{alias}}.ndarray( N, 1, x, 2, 1 )
-    ~4.3333
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,187 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2020 The Stdlib Authors.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-import snanvariancepn = require( './index' );
-
-
-// TESTS //
-
-// The function returns a number...
-{
-	const x = new Float32Array( 10 );
-
-	snanvariancepn( x.length, 1, x, 1 ); // $ExpectType number
-}
-
-// The compiler throws an error if the function is provided a first argument which is not a number...
-{
-	const x = new Float32Array( 10 );
-
-	snanvariancepn( '10', 1, x, 1 ); // $ExpectError
-	snanvariancepn( true, 1, x, 1 ); // $ExpectError
-	snanvariancepn( false, 1, x, 1 ); // $ExpectError
-	snanvariancepn( null, 1, x, 1 ); // $ExpectError
-	snanvariancepn( undefined, 1, x, 1 ); // $ExpectError
-	snanvariancepn( [], 1, x, 1 ); // $ExpectError
-	snanvariancepn( {}, 1, x, 1 ); // $ExpectError
-	snanvariancepn( ( x: number ): number => x, 1, x, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a second argument which is not a number...
-{
-	const x = new Float32Array( 10 );
-
-	snanvariancepn( x.length, '10', x, 1 ); // $ExpectError
-	snanvariancepn( x.length, true, x, 1 ); // $ExpectError
-	snanvariancepn( x.length, false, x, 1 ); // $ExpectError
-	snanvariancepn( x.length, null, x, 1 ); // $ExpectError
-	snanvariancepn( x.length, undefined, x, 1 ); // $ExpectError
-	snanvariancepn( x.length, [], x, 1 ); // $ExpectError
-	snanvariancepn( x.length, {}, x, 1 ); // $ExpectError
-	snanvariancepn( x.length, ( x: number ): number => x, x, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a third argument which is not a Float32Array...
-{
-	const x = new Float32Array( 10 );
-
-	snanvariancepn( x.length, 1, 10, 1 ); // $ExpectError
-	snanvariancepn( x.length, 1, '10', 1 ); // $ExpectError
-	snanvariancepn( x.length, 1, true, 1 ); // $ExpectError
-	snanvariancepn( x.length, 1, false, 1 ); // $ExpectError
-	snanvariancepn( x.length, 1, null, 1 ); // $ExpectError
-	snanvariancepn( x.length, 1, undefined, 1 ); // $ExpectError
-	snanvariancepn( x.length, 1, [], 1 ); // $ExpectError
-	snanvariancepn( x.length, 1, {}, 1 ); // $ExpectError
-	snanvariancepn( x.length, 1, ( x: number ): number => x, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a fourth argument which is not a number...
-{
-	const x = new Float32Array( 10 );
-
-	snanvariancepn( x.length, 1, x, '10' ); // $ExpectError
-	snanvariancepn( x.length, 1, x, true ); // $ExpectError
-	snanvariancepn( x.length, 1, x, false ); // $ExpectError
-	snanvariancepn( x.length, 1, x, null ); // $ExpectError
-	snanvariancepn( x.length, 1, x, undefined ); // $ExpectError
-	snanvariancepn( x.length, 1, x, [] ); // $ExpectError
-	snanvariancepn( x.length, 1, x, {} ); // $ExpectError
-	snanvariancepn( x.length, 1, x, ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an unsupported number of arguments...
-{
-	const x = new Float32Array( 10 );
-
-	snanvariancepn(); // $ExpectError
-	snanvariancepn( x.length ); // $ExpectError
-	snanvariancepn( x.length, 1 ); // $ExpectError
-	snanvariancepn( x.length, 1, x ); // $ExpectError
-	snanvariancepn( x.length, 1, x, 1, 10 ); // $ExpectError
-}
-
-// Attached to main export is an `ndarray` method which returns a number...
-{
-	const x = new Float32Array( 10 );
-
-	snanvariancepn.ndarray( x.length, 1, x, 1, 0 ); // $ExpectType number
-}
-
-// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number...
-{
-	const x = new Float32Array( 10 );
-
-	snanvariancepn.ndarray( '10', 1, x, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( true, 1, x, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( false, 1, x, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( null, 1, x, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( undefined, 1, x, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( [], 1, x, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( {}, 1, x, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( ( x: number ): number => x, 1, x, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a second argument which is not a number...
-{
-	const x = new Float32Array( 10 );
-
-	snanvariancepn.ndarray( x.length, '10', x, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, true, x, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, false, x, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, null, x, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, undefined, x, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, [], x, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, {}, x, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, ( x: number ): number => x, x, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a third argument which is not a Float32Array...
-{
-	const x = new Float32Array( 10 );
-
-	snanvariancepn.ndarray( x.length, 1, 10, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, '10', 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, true, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, false, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, null, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, undefined, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, [], 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, {}, 1, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, ( x: number ): number => x, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number...
-{
-	const x = new Float32Array( 10 );
-
-	snanvariancepn.ndarray( x.length, 1, x, '10', 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, x, true, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, x, false, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, x, null, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, x, undefined, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, x, [], 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, x, {}, 0 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, x, ( x: number ): number => x, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a number...
-{
-	const x = new Float32Array( 10 );
-
-	snanvariancepn.ndarray( x.length, 1, x, 1, '10' ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, x, 1, true ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, x, 1, false ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, x, 1, null ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, x, 1, undefined ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, x, 1, [] ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, x, 1, {} ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, x, 1, ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments...
-{
-	const x = new Float32Array( 10 );
-
-	snanvariancepn.ndarray(); // $ExpectError
-	snanvariancepn.ndarray( x.length ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, x ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, x, 1 ); // $ExpectError
-	snanvariancepn.ndarray( x.length, 1, x, 1, 0, 10 ); // $ExpectError
-}