@stdlib/stats-base-snanstdevyc 0.0.6 → 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/LICENSE

@@ -175,307 +175,3 @@
       of your accepting any such warranty or additional liability.
 
    END OF TERMS AND CONDITIONS
-
-
-
-Boost Software License - Version 1.0 - August 17th, 2003
-
-Permission is hereby granted, free of charge, to any person or organization
-obtaining a copy of the software and accompanying documentation covered by this
-license (the "Software") to use, reproduce, display, distribute, execute, and
-transmit the Software, and to prepare derivative works of the Software, and to
-permit third-parties to whom the Software is furnished to do so, all subject to
-the following:
-
-The copyright notices in the Software and this entire statement, including the
-above license grant, this restriction and the following disclaimer, must be
-included in all copies of the Software, in whole or in part, and all derivative
-works of the Software, unless such copies or derivative works are solely in the
-form of machine-executable object code generated by a source language processor.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
-COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES
-OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
-OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-
-
-DEPENDENCIES
-
-The library links against the following external libraries, which have their own
-licenses:
-
-* OpenBLAS <https://raw.githubusercontent.com/xianyi/OpenBLAS/
-def146efed8d5908ea04e22668feeab7099599a0/LICENSE>
-
-Copyright (c) 2011-2014, The OpenBLAS Project
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
-
-   1. Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-
-   2. Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in
-      the documentation and/or other materials provided with the
-      distribution.
-
-   3. Neither the name of the OpenBLAS project nor the names of
-      its contributors may be used to endorse or promote products
-      derived from this software without specific prior written
-      permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
-GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
-THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-
-* Electron <https://raw.githubusercontent.com/electron/electron/
-c4cfb3e7110266b9d7ad80e1ae097c4db564501c/LICENSE>
-
-Copyright (c) 2013-2017 GitHub Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-* Boost <http://www.boost.org/LICENSE_1_0.txt>
-
-Boost Software License - Version 1.0 - August 17th, 2003
-
-Permission is hereby granted, free of charge, to any person or organization
-obtaining a copy of the software and accompanying documentation covered by
-this license (the "Software") to use, reproduce, display, distribute,
-execute, and transmit the Software, and to prepare derivative works of the
-Software, and to permit third-parties to whom the Software is furnished to
-do so, all subject to the following:
-
-The copyright notices in the Software and this entire statement, including
-the above license grant, this restriction and the following disclaimer,
-must be included in all copies of the Software, in whole or in part, and
-all derivative works of the Software, unless such copies or derivative
-works are solely in the form of machine-executable object code generated by
-a source language processor.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
-SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
-FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-DEALINGS IN THE SOFTWARE.
-
-
-* Cephes <http://www.netlib.org/cephes/readme>
-
-Copyright (c) 1984-2000 Stephen L. Moshier
-
-Some software in this archive may be from the book _Methods and Programs for
-Mathematical Functions_ (Prentice-Hall or Simon & Schuster International, 1989)
-or from the Cephes Mathematical Library, a commercial product. In either event,
-it is copyrighted by the author. What you see here may be used freely but it
-comes with no support or guarantee.
-
-Stephen L. Moshier
-moshier@na-net.ornl.gov
-
-
-
-ATTRIBUTION
-
-The library contains implementations from the following external libraries,
-which have their own licenses:
-
-* FreeBSD <https://svnweb.freebsd.org/>
-
-Copyright (C) 1993-2004 by Sun Microsystems, Inc. All rights reserved.
-
-Developed at SunPro, a Sun Microsystems, Inc. business.
-Permission to use, copy, modify, and distribute this
-software is freely granted, provided that this notice
-is preserved.
-
-
-* FDLIBM <http://www.netlib.org/fdlibm/>
-
-Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved.
-
-Developed at SunPro, a Sun Microsystems, Inc. business.
-Permission to use, copy, modify, and distribute this
-software is freely granted, provided that this notice
-is preserved.
-
-
-* Go <https://raw.githubusercontent.com/golang/go/master/LICENSE>
-
-Copyright (c) 2009 The Go Authors. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
-
-   * Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
-   * Redistributions in binary form must reproduce the above
-copyright notice, this list of conditions and the following disclaimer
-in the documentation and/or other materials provided with the
-distribution.
-   * Neither the name of Google Inc. nor the names of its
-contributors may be used to endorse or promote products derived from
-this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-
-* SLATEC Common Mathematical Library <http://www.netlib.no/netlib/slatec/>
-
-Public domain.
-
-
-* ESLint <https://raw.githubusercontent.com/eslint/eslint/master/LICENSE>
-
-Copyright JS Foundation and other contributors, https://js.foundation
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
-
-* StatsFuns.jl <https://raw.githubusercontent.com/JuliaStats/StatsFuns.jl/
-e66dd973650c375bc1739c820e5b96bb5bd000a8/LICENSE.md>
-
-Copyright (c) 2015: Dahua Lin.
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-* SpecialFunctions.jl <https://raw.githubusercontent.com/JuliaMath/
-SpecialFunctions.jl/02a173fbe24a61c4b392aec17a9764ac5727feb1/LICENSE>
-
-The MIT License (MIT)
-
-Copyright (c) 2017 Jeff Bezanson, Stefan Karpinski, Viral B. Shah, and others:
-
-https://github.com/JuliaMath/SpecialFunctions.jl/graphs/contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-
-* MT19937 <http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/CODES/
-mt19937ar.c>
-
-Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-
- 1. Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-
- 2. Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in the
-    documentation and/or other materials provided with the distribution.
-
- 3. The names of its contributors may not be used to endorse or promote
-    products derived from this software without specific prior written
-    permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

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>
+
 # snanstdevyc
 
 [![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
 <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">
     <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@b67580460d19ae4dd4a48a0c10d5f218a9c3c7f7/lib/node_modules/@stdlib/stats/base/snanstdevyc/docs/img/equation_population_standard_deviation.svg" alt="Equation for the population standard deviation.">
     <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@b67580460d19ae4dd4a48a0c10d5f218a9c3c7f7/lib/node_modules/@stdlib/stats/base/snanstdevyc/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 [standard deviation][standard
 
 <!-- <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."> -->
 
-<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">
+<!-- <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">
     <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@b67580460d19ae4dd4a48a0c10d5f218a9c3c7f7/lib/node_modules/@stdlib/stats/base/snanstdevyc/docs/img/equation_corrected_sample_standard_deviation.svg" alt="Equation for computing a corrected sample standard deviation.">
     <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@b67580460d19ae4dd4a48a0c10d5f218a9c3c7f7/lib/node_modules/@stdlib/stats/base/snanstdevyc/docs/img/equation_sample_mean.svg" alt="Equation for the sample mean.">
     <br>
 </div>
@@ -238,11 +249,11 @@ console.log( v );
 
 ## See Also
 
--   <span class="package-name">[`@stdlib/stats/base/dnanstdevyc`][@stdlib/stats/base/dnanstdevyc]</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 one-pass algorithm proposed by Youngs and Cramer.</span>
--   <span class="package-name">[`@stdlib/stats/base/nanstdevyc`][@stdlib/stats/base/nanstdevyc]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a strided array ignoring NaN values and using a one-pass algorithm proposed by Youngs and Cramer.</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/snanvarianceyc`][@stdlib/stats/base/snanvarianceyc]</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 one-pass algorithm proposed by Youngs and Cramer.</span>
--   <span class="package-name">[`@stdlib/stats/base/sstdevyc`][@stdlib/stats/base/sstdevyc]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a one-pass algorithm proposed by Youngs and Cramer.</span>
+-   <span class="package-name">[`@stdlib/stats-base/dnanstdevyc`][@stdlib/stats/base/dnanstdevyc]</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 one-pass algorithm proposed by Youngs and Cramer.</span>
+-   <span class="package-name">[`@stdlib/stats-base/nanstdevyc`][@stdlib/stats/base/nanstdevyc]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a strided array ignoring NaN values and using a one-pass algorithm proposed by Youngs and Cramer.</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/snanvarianceyc`][@stdlib/stats/base/snanvarianceyc]</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 one-pass algorithm proposed by Youngs and Cramer.</span>
+-   <span class="package-name">[`@stdlib/stats-base/sstdevyc`][@stdlib/stats/base/sstdevyc]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a one-pass algorithm proposed by Youngs and Cramer.</span>
 
 </section>
 
@@ -274,7 +285,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>
 
@@ -287,8 +298,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-snanstdevyc.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-snanstdevyc
 
-[test-image]: https://github.com/stdlib-js/stats-base-snanstdevyc/actions/workflows/test.yml/badge.svg
-[test-url]: https://github.com/stdlib-js/stats-base-snanstdevyc/actions/workflows/test.yml
+[test-image]: https://github.com/stdlib-js/stats-base-snanstdevyc/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/stats-base-snanstdevyc/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-snanstdevyc/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-snanstdevyc?branch=main
@@ -300,19 +311,20 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 
 -->
 
+[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
+
+[stdlib]: https://github.com/stdlib-js/stdlib
+
+[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
+
 [umd]: https://github.com/umdjs/umd
 [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 
 [deno-url]: https://github.com/stdlib-js/stats-base-snanstdevyc/tree/deno
 [umd-url]: https://github.com/stdlib-js/stats-base-snanstdevyc/tree/umd
 [esm-url]: https://github.com/stdlib-js/stats-base-snanstdevyc/tree/esm
-
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
-
-[stdlib]: https://github.com/stdlib-js/stdlib
-
-[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
+[branches-url]: https://github.com/stdlib-js/stats-base-snanstdevyc/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-snanstdevyc/main/LICENSE
 

package/dist/index.d.ts

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

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(w,s){
+var f=require('@stdlib/number-float64-base-to-float32/dist'),p=require('@stdlib/stats-base-snanvarianceyc/dist'),x=require('@stdlib/math-base-special-sqrt/dist');function j(e,r,a,t){return f(x(p(e,r,a,t)))}s.exports=j
+});var q=i(function(z,v){
+var m=require('@stdlib/number-float64-base-to-float32/dist'),F=require('@stdlib/stats-base-snanvarianceyc/dist').ndarray,R=require('@stdlib/math-base-special-sqrt/dist');function T(e,r,a,t,l){return m(R(F(e,r,a,t,l)))}v.exports=T
+});var y=i(function(A,c){
+var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),o=u(),E=q();_(o,"ndarray",E);c.exports=o
+});var O=require("path").join,b=require('@stdlib/utils-try-require/dist'),g=require('@stdlib/assert-is-error/dist'),h=y(),n,d=b(O(__dirname,"./native.js"));g(d)?n=h:n=d;module.exports=n;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/snanstdevyc.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 snanvarianceyc = require( '@stdlib/stats-base-snanvarianceyc' );\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 one-pass algorithm proposed by Youngs and Cramer.\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 = snanstdevyc( x.length, 1, x, 1 );\n* // returns ~2.0817\n*/\nfunction snanstdevyc( N, correction, x, stride ) {\n\treturn float64ToFloat32( sqrt( snanvarianceyc( N, correction, x, stride ) ) ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = snanstdevyc;\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 snanvarianceyc = require( '@stdlib/stats-base-snanvarianceyc' ).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 one-pass algorithm proposed by Youngs and Cramer.\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 = snanstdevyc( N, 1, x, 2, 1 );\n* // returns 2.5\n*/\nfunction snanstdevyc( N, correction, x, stride, offset ) {\n\treturn float64ToFloat32( sqrt( snanvarianceyc( N, correction, x, stride, offset ) ) ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = snanstdevyc;\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 snanstdevyc = require( './snanstdevyc.js' );\nvar ndarray = require( './ndarray.js' );\n\n\n// MAIN //\n\nsetReadOnly( snanstdevyc, 'ndarray', ndarray );\n\n\n// EXPORTS //\n\nmodule.exports = snanstdevyc;\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 one-pass algorithm proposed by Youngs and Cramer.\n*\n* @module @stdlib/stats-base-snanstdevyc\n*\n* @example\n* var Float32Array = require( '@stdlib/array-float32' );\n* var snanstdevyc = require( '@stdlib/stats-base-snanstdevyc' );\n*\n* var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );\n*\n* var v = snanstdevyc( 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 snanstdevyc = require( '@stdlib/stats-base-snanstdevyc' );\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 = snanstdevyc.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 snanstdevyc;\nvar tmp = tryRequire( join( __dirname, './native.js' ) );\nif ( isError( tmp ) ) {\n\tsnanstdevyc = main;\n} else {\n\tsnanstdevyc = tmp;\n}\n\n\n// EXPORTS //\n\nmodule.exports = snanstdevyc;\n\n// exports: { \"ndarray\": \"snanstdevyc.ndarray\" }\n"],
+  "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",
+  "names": ["require_snanstdevyc", "__commonJSMin", "exports", "module", "float64ToFloat32", "snanvarianceyc", "sqrt", "snanstdevyc", "N", "correction", "x", "stride", "require_ndarray", "__commonJSMin", "exports", "module", "float64ToFloat32", "snanvarianceyc", "sqrt", "snanstdevyc", "N", "correction", "x", "stride", "offset", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "snanstdevyc", "ndarray", "join", "tryRequire", "isError", "main", "snanstdevyc", "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 `snanstdevyc`.

package/lib/index.js

@@ -48,13 +48,17 @@
 
 var join = require( 'path' ).join;
 var tryRequire = require( '@stdlib/utils-try-require' );
-var snanstdevyc = require( './main.js' );
+var isError = require( '@stdlib/assert-is-error' );
+var main = require( './main.js' );
 
 
 // MAIN //
 
+var snanstdevyc;
 var tmp = tryRequire( join( __dirname, './native.js' ) );
-if ( !(tmp instanceof Error) ) {
+if ( isError( tmp ) ) {
+	snanstdevyc = main;
+} else {
 	snanstdevyc = tmp;
 }
 
@@ -62,3 +66,5 @@ if ( !(tmp instanceof Error) ) {
 // EXPORTS //
 
 module.exports = snanstdevyc;
+
+// exports: { "ndarray": "snanstdevyc.ndarray" }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-snanstdevyc",
-  "version": "0.0.6",
+  "version": "0.1.0",
   "description": "Calculate the standard deviation of a single-precision floating-point strided array ignoring NaN values and using a one-pass algorithm proposed by Youngs and Cramer.",
   "license": "Apache-2.0",
   "author": {
@@ -41,28 +41,29 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/math-base-special-sqrt": "^0.0.x",
-    "@stdlib/number-float64-base-to-float32": "^0.0.x",
-    "@stdlib/stats-base-snanvarianceyc": "^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-sqrt": "^0.1.0",
+    "@stdlib/number-float64-base-to-float32": "^0.1.0",
+    "@stdlib/stats-base-snanvarianceyc": "^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/constants-float32-eps": "^0.0.x",
-    "@stdlib/math-base-assert-is-nanf": "^0.0.x",
-    "@stdlib/math-base-special-abs": "^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/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/constants-float32-eps": "^0.1.0",
+    "@stdlib/math-base-assert-is-nanf": "^0.1.0",
+    "@stdlib/math-base-special-abs": "^0.0.6",
+    "@stdlib/math-base-special-floor": "^0.0.8",
+    "@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",
@@ -105,7 +106,7 @@
   ],
   "__stdlib__": {},
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,122 +0,0 @@
-
-{{alias}}( N, correction, x, stride )
-    Computes the standard deviation of a single-precision floating-point strided
-    array ignoring `NaN` values and using a one-pass algorithm proposed by
-    Youngs and Cramer.
-
-    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 standard deviation according to `N - c` where `c` corresponds to
-        the provided degrees of freedom adjustment. When computing the standard
-        deviation 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 corrected sample standard deviation,
-        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 standard deviation.
-
-    Examples
-    --------
-    // Standard Usage:
-    > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, NaN, 2.0 ] );
-    > {{alias}}( x.length, 1, x, 1 )
-    ~2.0817
-
-    // 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 );
-    > var stride = 2;
-    > {{alias}}( N, 1, x, stride )
-    ~2.0817
-
-    // 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 );
-    > stride = 2;
-    > {{alias}}( N, 1, x1, stride )
-    ~2.0817
-
-{{alias}}.ndarray( N, correction, x, stride, offset )
-    Computes the standard deviation of a single-precision floating-point strided
-    array ignoring `NaN` values and using a one-pass algorithm proposed by
-    Youngs and Cramer 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 standard deviation according to `N - c` where `c` corresponds to
-        the provided degrees of freedom adjustment. When computing the standard
-        deviation 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 corrected sample standard deviation,
-        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 standard deviation.
-
-    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 )
-    ~2.0817
-
-    // 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 )
-    ~2.0817
-
-    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 snanstdevyc = require( './index' );
-
-
-// TESTS //
-
-// The function returns a number...
-{
-	const x = new Float32Array( 10 );
-
-	snanstdevyc( 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 );
-
-	snanstdevyc( '10', 1, x, 1 ); // $ExpectError
-	snanstdevyc( true, 1, x, 1 ); // $ExpectError
-	snanstdevyc( false, 1, x, 1 ); // $ExpectError
-	snanstdevyc( null, 1, x, 1 ); // $ExpectError
-	snanstdevyc( undefined, 1, x, 1 ); // $ExpectError
-	snanstdevyc( [], 1, x, 1 ); // $ExpectError
-	snanstdevyc( {}, 1, x, 1 ); // $ExpectError
-	snanstdevyc( ( 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 );
-
-	snanstdevyc( x.length, '10', x, 1 ); // $ExpectError
-	snanstdevyc( x.length, true, x, 1 ); // $ExpectError
-	snanstdevyc( x.length, false, x, 1 ); // $ExpectError
-	snanstdevyc( x.length, null, x, 1 ); // $ExpectError
-	snanstdevyc( x.length, undefined, x, 1 ); // $ExpectError
-	snanstdevyc( x.length, [], x, 1 ); // $ExpectError
-	snanstdevyc( x.length, {}, x, 1 ); // $ExpectError
-	snanstdevyc( 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 );
-
-	snanstdevyc( x.length, 1, 10, 1 ); // $ExpectError
-	snanstdevyc( x.length, 1, '10', 1 ); // $ExpectError
-	snanstdevyc( x.length, 1, true, 1 ); // $ExpectError
-	snanstdevyc( x.length, 1, false, 1 ); // $ExpectError
-	snanstdevyc( x.length, 1, null, 1 ); // $ExpectError
-	snanstdevyc( x.length, 1, undefined, 1 ); // $ExpectError
-	snanstdevyc( x.length, 1, [], 1 ); // $ExpectError
-	snanstdevyc( x.length, 1, {}, 1 ); // $ExpectError
-	snanstdevyc( 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 );
-
-	snanstdevyc( x.length, 1, x, '10' ); // $ExpectError
-	snanstdevyc( x.length, 1, x, true ); // $ExpectError
-	snanstdevyc( x.length, 1, x, false ); // $ExpectError
-	snanstdevyc( x.length, 1, x, null ); // $ExpectError
-	snanstdevyc( x.length, 1, x, undefined ); // $ExpectError
-	snanstdevyc( x.length, 1, x, [] ); // $ExpectError
-	snanstdevyc( x.length, 1, x, {} ); // $ExpectError
-	snanstdevyc( 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 );
-
-	snanstdevyc(); // $ExpectError
-	snanstdevyc( x.length ); // $ExpectError
-	snanstdevyc( x.length, 1 ); // $ExpectError
-	snanstdevyc( x.length, 1, x ); // $ExpectError
-	snanstdevyc( x.length, 1, x, 1, 10 ); // $ExpectError
-}
-
-// Attached to main export is an `ndarray` method which returns a number...
-{
-	const x = new Float32Array( 10 );
-
-	snanstdevyc.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 );
-
-	snanstdevyc.ndarray( '10', 1, x, 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( true, 1, x, 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( false, 1, x, 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( null, 1, x, 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( undefined, 1, x, 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( [], 1, x, 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( {}, 1, x, 1, 0 ); // $ExpectError
-	snanstdevyc.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 );
-
-	snanstdevyc.ndarray( x.length, '10', x, 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, true, x, 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, false, x, 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, null, x, 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, undefined, x, 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, [], x, 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, {}, x, 1, 0 ); // $ExpectError
-	snanstdevyc.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 );
-
-	snanstdevyc.ndarray( x.length, 1, 10, 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, '10', 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, true, 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, false, 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, null, 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, undefined, 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, [], 1, 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, {}, 1, 0 ); // $ExpectError
-	snanstdevyc.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 );
-
-	snanstdevyc.ndarray( x.length, 1, x, '10', 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, x, true, 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, x, false, 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, x, null, 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, x, undefined, 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, x, [], 0 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, x, {}, 0 ); // $ExpectError
-	snanstdevyc.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 );
-
-	snanstdevyc.ndarray( x.length, 1, x, 1, '10' ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, x, 1, true ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, x, 1, false ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, x, 1, null ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, x, 1, undefined ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, x, 1, [] ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, x, 1, {} ); // $ExpectError
-	snanstdevyc.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 );
-
-	snanstdevyc.ndarray(); // $ExpectError
-	snanstdevyc.ndarray( x.length ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, x ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, x, 1 ); // $ExpectError
-	snanstdevyc.ndarray( x.length, 1, x, 1, 0, 10 ); // $ExpectError
-}