@stdlib/stats-base-snanvariance 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>
+
 # snanvariance
 
 [![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@9ccc2be07b155022bc78ae97c29f16f55c37adde/lib/node_modules/@stdlib/stats/base/snanvariance/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@9ccc2be07b155022bc78ae97c29f16f55c37adde/lib/node_modules/@stdlib/stats/base/snanvariance/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@9ccc2be07b155022bc78ae97c29f16f55c37adde/lib/node_modules/@stdlib/stats/base/snanvariance/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@9ccc2be07b155022bc78ae97c29f16f55c37adde/lib/node_modules/@stdlib/stats/base/snanvariance/docs/img/equation_sample_mean.svg" alt="Equation for the sample mean.">
     <br>
 </div>
@@ -232,10 +243,10 @@ console.log( v );
 
 ## See Also
 
--   <span class="package-name">[`@stdlib/stats/base/dnanvariance`][@stdlib/stats/base/dnanvariance]</span><span class="delimiter">: </span><span class="description">calculate the variance of a double-precision floating-point strided array ignoring NaN values.</span>
--   <span class="package-name">[`@stdlib/stats/base/nanvariance`][@stdlib/stats/base/nanvariance]</span><span class="delimiter">: </span><span class="description">calculate the variance of a strided array ignoring NaN values.</span>
--   <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>
--   <span class="package-name">[`@stdlib/stats/base/svariance`][@stdlib/stats/base/svariance]</span><span class="delimiter">: </span><span class="description">calculate the variance of a single-precision floating-point strided array.</span>
+-   <span class="package-name">[`@stdlib/stats-base/dnanvariance`][@stdlib/stats/base/dnanvariance]</span><span class="delimiter">: </span><span class="description">calculate the variance of a double-precision floating-point strided array ignoring NaN values.</span>
+-   <span class="package-name">[`@stdlib/stats-base/nanvariance`][@stdlib/stats/base/nanvariance]</span><span class="delimiter">: </span><span class="description">calculate the variance of a strided array ignoring NaN values.</span>
+-   <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>
+-   <span class="package-name">[`@stdlib/stats-base/svariance`][@stdlib/stats/base/svariance]</span><span class="delimiter">: </span><span class="description">calculate the variance of a single-precision floating-point strided array.</span>
 
 </section>
 
@@ -267,7 +278,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>
 
@@ -280,8 +291,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-snanvariance.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-snanvariance
 
-[test-image]: https://github.com/stdlib-js/stats-base-snanvariance/actions/workflows/test.yml/badge.svg?branch=v0.0.7
-[test-url]: https://github.com/stdlib-js/stats-base-snanvariance/actions/workflows/test.yml?query=branch:v0.0.7
+[test-image]: https://github.com/stdlib-js/stats-base-snanvariance/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/stats-base-snanvariance/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-snanvariance/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-snanvariance?branch=main
@@ -294,7 +305,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 snanvariance from '../docs/types/index';
+export = snanvariance;

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";var i=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var u=i(function(h,t){
+var x=require('@stdlib/stats-base-snanvariancepn/dist');function f(e,r,a,n){return x(e,r,a,n)}t.exports=f
+});var c=i(function(k,v){
+var j=require('@stdlib/stats-base-snanvariancepn/dist').ndarray;function m(e,r,a,n,y){return j(e,r,a,n,y)}v.exports=m
+});var p=i(function(w,o){
+var l=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),q=u(),R=c();l(q,"ndarray",R);o.exports=q
+});var _=require("path").join,E=require('@stdlib/utils-try-require/dist'),O=require('@stdlib/assert-is-error/dist'),b=p(),s,d=E(_(__dirname,"./native.js"));O(d)?s=b:s=d;module.exports=s;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/snanvariance.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 snanvariancepn = require( '@stdlib/stats-base-snanvariancepn' );\n\n\n// MAIN //\n\n/**\n* Computes the variance of a single-precision floating-point strided array ignoring `NaN` values.\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 = snanvariance( N, 1, x, 1 );\n* // returns ~4.3333\n*/\nfunction snanvariance( N, correction, x, stride ) {\n\treturn snanvariancepn( N, correction, x, stride );\n}\n\n\n// EXPORTS //\n\nmodule.exports = snanvariance;\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 snanvariancepn = require( '@stdlib/stats-base-snanvariancepn' ).ndarray;\n\n\n// MAIN //\n\n/**\n* Computes the variance of a single-precision floating-point strided array ignoring `NaN` values.\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 = snanvariance( N, 1, x, 2, 1 );\n* // returns 6.25\n*/\nfunction snanvariance( N, correction, x, stride, offset ) {\n\treturn snanvariancepn( N, correction, x, stride, offset );\n}\n\n\n// EXPORTS //\n\nmodule.exports = snanvariance;\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 snanvariance = require( './snanvariance.js' );\nvar ndarray = require( './ndarray.js' );\n\n\n// MAIN //\n\nsetReadOnly( snanvariance, 'ndarray', ndarray );\n\n\n// EXPORTS //\n\nmodule.exports = snanvariance;\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.\n*\n* @module @stdlib/stats-base-snanvariance\n*\n* @example\n* var Float32Array = require( '@stdlib/array-float32' );\n* var snanvariance = require( '@stdlib/stats-base-snanvariance' );\n*\n* var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );\n*\n* var v = snanvariance( 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 snanvariance = require( '@stdlib/stats-base-snanvariance' );\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 = snanvariance.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 snanvariance;\nvar tmp = tryRequire( join( __dirname, './native.js' ) );\nif ( isError( tmp ) ) {\n\tsnanvariance = main;\n} else {\n\tsnanvariance = tmp;\n}\n\n\n// EXPORTS //\n\nmodule.exports = snanvariance;\n\n// exports: { \"ndarray\": \"snanvariance.ndarray\" }\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,mCAAoC,EAuBlE,SAASC,EAAcC,EAAGC,EAAYC,EAAGC,EAAS,CACjD,OAAOL,EAAgBE,EAAGC,EAAYC,EAAGC,CAAO,CACjD,CAKAN,EAAO,QAAUE,ICpDjB,IAAAK,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,mCAAoC,EAAE,QAyBpE,SAASC,EAAcC,EAAGC,EAAYC,EAAGC,EAAQC,EAAS,CACzD,OAAON,EAAgBE,EAAGC,EAAYC,EAAGC,EAAQC,CAAO,CACzD,CAKAP,EAAO,QAAUE,ICtDjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAe,IACfC,EAAU,IAKdF,EAAaC,EAAc,UAAWC,CAAQ,EAK9CH,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,EAAeD,EAEfC,EAAeC,EAMhB,OAAO,QAAUD",
+  "names": ["require_snanvariance", "__commonJSMin", "exports", "module", "snanvariancepn", "snanvariance", "N", "correction", "x", "stride", "require_ndarray", "__commonJSMin", "exports", "module", "snanvariancepn", "snanvariance", "N", "correction", "x", "stride", "offset", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "snanvariance", "ndarray", "join", "tryRequire", "isError", "main", "snanvariance", "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 `snanvariance`.

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 snanvariance;
 var tmp = tryRequire( join( __dirname, './native.js' ) );
-if ( tmp instanceof Error ) {
+if ( isError( tmp ) ) {
 	snanvariance = main;
 } else {
 	snanvariance = tmp;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-snanvariance",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "Calculate the variance of a single-precision floating-point strided array ignoring NaN values.",
   "license": "Apache-2.0",
   "author": {
@@ -41,25 +41,26 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/stats-base-snanvariancepn": "^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/stats-base-snanvariancepn": "^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-floor": "^0.0.x",
-    "@stdlib/math-base-special-pow": "^0.0.x",
-    "@stdlib/math-base-special-round": "^0.0.x",
-    "@stdlib/number-float64-base-to-float32": "^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-floor": "^0.1.0",
+    "@stdlib/math-base-special-pow": "^0.0.7",
+    "@stdlib/math-base-special-round": "^0.1.0",
+    "@stdlib/number-float64-base-to-float32": "^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",
@@ -103,7 +104,7 @@
   ],
   "__stdlib__": {},
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,120 +0,0 @@
-
-{{alias}}( N, correction, x, stride )
-    Computes the variance of a single-precision floating-point strided array
-    ignoring `NaN` values.
-
-    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 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 snanvariance = require( './index' );
-
-
-// TESTS //
-
-// The function returns a number...
-{
-	const x = new Float32Array( 10 );
-
-	snanvariance( 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 );
-
-	snanvariance( '10', 1, x, 1 ); // $ExpectError
-	snanvariance( true, 1, x, 1 ); // $ExpectError
-	snanvariance( false, 1, x, 1 ); // $ExpectError
-	snanvariance( null, 1, x, 1 ); // $ExpectError
-	snanvariance( undefined, 1, x, 1 ); // $ExpectError
-	snanvariance( [], 1, x, 1 ); // $ExpectError
-	snanvariance( {}, 1, x, 1 ); // $ExpectError
-	snanvariance( ( 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 );
-
-	snanvariance( x.length, '10', x, 1 ); // $ExpectError
-	snanvariance( x.length, true, x, 1 ); // $ExpectError
-	snanvariance( x.length, false, x, 1 ); // $ExpectError
-	snanvariance( x.length, null, x, 1 ); // $ExpectError
-	snanvariance( x.length, undefined, x, 1 ); // $ExpectError
-	snanvariance( x.length, [], x, 1 ); // $ExpectError
-	snanvariance( x.length, {}, x, 1 ); // $ExpectError
-	snanvariance( 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 );
-
-	snanvariance( x.length, 1, 10, 1 ); // $ExpectError
-	snanvariance( x.length, 1, '10', 1 ); // $ExpectError
-	snanvariance( x.length, 1, true, 1 ); // $ExpectError
-	snanvariance( x.length, 1, false, 1 ); // $ExpectError
-	snanvariance( x.length, 1, null, 1 ); // $ExpectError
-	snanvariance( x.length, 1, undefined, 1 ); // $ExpectError
-	snanvariance( x.length, 1, [], 1 ); // $ExpectError
-	snanvariance( x.length, 1, {}, 1 ); // $ExpectError
-	snanvariance( 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 );
-
-	snanvariance( x.length, 1, x, '10' ); // $ExpectError
-	snanvariance( x.length, 1, x, true ); // $ExpectError
-	snanvariance( x.length, 1, x, false ); // $ExpectError
-	snanvariance( x.length, 1, x, null ); // $ExpectError
-	snanvariance( x.length, 1, x, undefined ); // $ExpectError
-	snanvariance( x.length, 1, x, [] ); // $ExpectError
-	snanvariance( x.length, 1, x, {} ); // $ExpectError
-	snanvariance( 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 );
-
-	snanvariance(); // $ExpectError
-	snanvariance( x.length ); // $ExpectError
-	snanvariance( x.length, 1 ); // $ExpectError
-	snanvariance( x.length, 1, x ); // $ExpectError
-	snanvariance( x.length, 1, x, 1, 10 ); // $ExpectError
-}
-
-// Attached to main export is an `ndarray` method which returns a number...
-{
-	const x = new Float32Array( 10 );
-
-	snanvariance.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 );
-
-	snanvariance.ndarray( '10', 1, x, 1, 0 ); // $ExpectError
-	snanvariance.ndarray( true, 1, x, 1, 0 ); // $ExpectError
-	snanvariance.ndarray( false, 1, x, 1, 0 ); // $ExpectError
-	snanvariance.ndarray( null, 1, x, 1, 0 ); // $ExpectError
-	snanvariance.ndarray( undefined, 1, x, 1, 0 ); // $ExpectError
-	snanvariance.ndarray( [], 1, x, 1, 0 ); // $ExpectError
-	snanvariance.ndarray( {}, 1, x, 1, 0 ); // $ExpectError
-	snanvariance.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 );
-
-	snanvariance.ndarray( x.length, '10', x, 1, 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, true, x, 1, 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, false, x, 1, 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, null, x, 1, 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, undefined, x, 1, 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, [], x, 1, 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, {}, x, 1, 0 ); // $ExpectError
-	snanvariance.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 );
-
-	snanvariance.ndarray( x.length, 1, 10, 1, 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, '10', 1, 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, true, 1, 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, false, 1, 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, null, 1, 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, undefined, 1, 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, [], 1, 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, {}, 1, 0 ); // $ExpectError
-	snanvariance.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 );
-
-	snanvariance.ndarray( x.length, 1, x, '10', 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, x, true, 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, x, false, 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, x, null, 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, x, undefined, 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, x, [], 0 ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, x, {}, 0 ); // $ExpectError
-	snanvariance.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 );
-
-	snanvariance.ndarray( x.length, 1, x, 1, '10' ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, x, 1, true ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, x, 1, false ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, x, 1, null ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, x, 1, undefined ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, x, 1, [] ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, x, 1, {} ); // $ExpectError
-	snanvariance.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 );
-
-	snanvariance.ndarray(); // $ExpectError
-	snanvariance.ndarray( x.length ); // $ExpectError
-	snanvariance.ndarray( x.length, 1 ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, x ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, x, 1 ); // $ExpectError
-	snanvariance.ndarray( x.length, 1, x, 1, 0, 10 ); // $ExpectError
-}