@stdlib/stats-base-snanvariance 0.0.6 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CITATION.cff +30 -0
- package/LICENSE +0 -304
- package/NOTICE +1 -1
- package/README.md +32 -20
- package/dist/index.d.ts +3 -0
- package/dist/index.js +9 -0
- package/dist/index.js.map +7 -0
- package/docs/types/index.d.ts +1 -1
- package/lib/index.js +8 -2
- package/package.json +18 -17
- package/docs/repl.txt +0 -120
- package/docs/types/test.ts +0 -187
package/CITATION.cff
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
cff-version: 1.2.0
|
|
2
|
+
title: stdlib
|
|
3
|
+
message: >-
|
|
4
|
+
If you use this software, please cite it using the
|
|
5
|
+
metadata from this file.
|
|
6
|
+
|
|
7
|
+
type: software
|
|
8
|
+
|
|
9
|
+
authors:
|
|
10
|
+
- name: The Stdlib Authors
|
|
11
|
+
url: https://github.com/stdlib-js/stdlib/graphs/contributors
|
|
12
|
+
|
|
13
|
+
repository-code: https://github.com/stdlib-js/stdlib
|
|
14
|
+
url: https://stdlib.io
|
|
15
|
+
|
|
16
|
+
abstract: |
|
|
17
|
+
Standard library for JavaScript and Node.js.
|
|
18
|
+
|
|
19
|
+
keywords:
|
|
20
|
+
- JavaScript
|
|
21
|
+
- Node.js
|
|
22
|
+
- TypeScript
|
|
23
|
+
- standard library
|
|
24
|
+
- scientific computing
|
|
25
|
+
- numerical computing
|
|
26
|
+
- statistical computing
|
|
27
|
+
|
|
28
|
+
license: Apache-2.0 AND BSL-1.0
|
|
29
|
+
|
|
30
|
+
date-released: 2016
|
package/LICENSE
CHANGED
|
@@ -175,307 +175,3 @@
|
|
|
175
175
|
of your accepting any such warranty or additional liability.
|
|
176
176
|
|
|
177
177
|
END OF TERMS AND CONDITIONS
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
Boost Software License - Version 1.0 - August 17th, 2003
|
|
182
|
-
|
|
183
|
-
Permission is hereby granted, free of charge, to any person or organization
|
|
184
|
-
obtaining a copy of the software and accompanying documentation covered by this
|
|
185
|
-
license (the "Software") to use, reproduce, display, distribute, execute, and
|
|
186
|
-
transmit the Software, and to prepare derivative works of the Software, and to
|
|
187
|
-
permit third-parties to whom the Software is furnished to do so, all subject to
|
|
188
|
-
the following:
|
|
189
|
-
|
|
190
|
-
The copyright notices in the Software and this entire statement, including the
|
|
191
|
-
above license grant, this restriction and the following disclaimer, must be
|
|
192
|
-
included in all copies of the Software, in whole or in part, and all derivative
|
|
193
|
-
works of the Software, unless such copies or derivative works are solely in the
|
|
194
|
-
form of machine-executable object code generated by a source language processor.
|
|
195
|
-
|
|
196
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
197
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
198
|
-
FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
|
|
199
|
-
COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES
|
|
200
|
-
OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
|
|
201
|
-
OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
DEPENDENCIES
|
|
207
|
-
|
|
208
|
-
The library links against the following external libraries, which have their own
|
|
209
|
-
licenses:
|
|
210
|
-
|
|
211
|
-
* OpenBLAS <https://raw.githubusercontent.com/xianyi/OpenBLAS/
|
|
212
|
-
def146efed8d5908ea04e22668feeab7099599a0/LICENSE>
|
|
213
|
-
|
|
214
|
-
Copyright (c) 2011-2014, The OpenBLAS Project
|
|
215
|
-
All rights reserved.
|
|
216
|
-
|
|
217
|
-
Redistribution and use in source and binary forms, with or without
|
|
218
|
-
modification, are permitted provided that the following conditions are
|
|
219
|
-
met:
|
|
220
|
-
|
|
221
|
-
1. Redistributions of source code must retain the above copyright
|
|
222
|
-
notice, this list of conditions and the following disclaimer.
|
|
223
|
-
|
|
224
|
-
2. Redistributions in binary form must reproduce the above copyright
|
|
225
|
-
notice, this list of conditions and the following disclaimer in
|
|
226
|
-
the documentation and/or other materials provided with the
|
|
227
|
-
distribution.
|
|
228
|
-
|
|
229
|
-
3. Neither the name of the OpenBLAS project nor the names of
|
|
230
|
-
its contributors may be used to endorse or promote products
|
|
231
|
-
derived from this software without specific prior written
|
|
232
|
-
permission.
|
|
233
|
-
|
|
234
|
-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
235
|
-
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
236
|
-
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
237
|
-
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
238
|
-
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
239
|
-
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
|
240
|
-
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
241
|
-
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
242
|
-
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
|
|
243
|
-
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
* Electron <https://raw.githubusercontent.com/electron/electron/
|
|
247
|
-
c4cfb3e7110266b9d7ad80e1ae097c4db564501c/LICENSE>
|
|
248
|
-
|
|
249
|
-
Copyright (c) 2013-2017 GitHub Inc.
|
|
250
|
-
|
|
251
|
-
Permission is hereby granted, free of charge, to any person obtaining
|
|
252
|
-
a copy of this software and associated documentation files (the
|
|
253
|
-
"Software"), to deal in the Software without restriction, including
|
|
254
|
-
without limitation the rights to use, copy, modify, merge, publish,
|
|
255
|
-
distribute, sublicense, and/or sell copies of the Software, and to
|
|
256
|
-
permit persons to whom the Software is furnished to do so, subject to
|
|
257
|
-
the following conditions:
|
|
258
|
-
|
|
259
|
-
The above copyright notice and this permission notice shall be
|
|
260
|
-
included in all copies or substantial portions of the Software.
|
|
261
|
-
|
|
262
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
263
|
-
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
264
|
-
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
265
|
-
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
266
|
-
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
267
|
-
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
268
|
-
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
* Boost <http://www.boost.org/LICENSE_1_0.txt>
|
|
272
|
-
|
|
273
|
-
Boost Software License - Version 1.0 - August 17th, 2003
|
|
274
|
-
|
|
275
|
-
Permission is hereby granted, free of charge, to any person or organization
|
|
276
|
-
obtaining a copy of the software and accompanying documentation covered by
|
|
277
|
-
this license (the "Software") to use, reproduce, display, distribute,
|
|
278
|
-
execute, and transmit the Software, and to prepare derivative works of the
|
|
279
|
-
Software, and to permit third-parties to whom the Software is furnished to
|
|
280
|
-
do so, all subject to the following:
|
|
281
|
-
|
|
282
|
-
The copyright notices in the Software and this entire statement, including
|
|
283
|
-
the above license grant, this restriction and the following disclaimer,
|
|
284
|
-
must be included in all copies of the Software, in whole or in part, and
|
|
285
|
-
all derivative works of the Software, unless such copies or derivative
|
|
286
|
-
works are solely in the form of machine-executable object code generated by
|
|
287
|
-
a source language processor.
|
|
288
|
-
|
|
289
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
290
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
291
|
-
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
|
|
292
|
-
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
|
|
293
|
-
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
|
|
294
|
-
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
295
|
-
DEALINGS IN THE SOFTWARE.
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
* Cephes <http://www.netlib.org/cephes/readme>
|
|
299
|
-
|
|
300
|
-
Copyright (c) 1984-2000 Stephen L. Moshier
|
|
301
|
-
|
|
302
|
-
Some software in this archive may be from the book _Methods and Programs for
|
|
303
|
-
Mathematical Functions_ (Prentice-Hall or Simon & Schuster International, 1989)
|
|
304
|
-
or from the Cephes Mathematical Library, a commercial product. In either event,
|
|
305
|
-
it is copyrighted by the author. What you see here may be used freely but it
|
|
306
|
-
comes with no support or guarantee.
|
|
307
|
-
|
|
308
|
-
Stephen L. Moshier
|
|
309
|
-
moshier@na-net.ornl.gov
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
ATTRIBUTION
|
|
314
|
-
|
|
315
|
-
The library contains implementations from the following external libraries,
|
|
316
|
-
which have their own licenses:
|
|
317
|
-
|
|
318
|
-
* FreeBSD <https://svnweb.freebsd.org/>
|
|
319
|
-
|
|
320
|
-
Copyright (C) 1993-2004 by Sun Microsystems, Inc. All rights reserved.
|
|
321
|
-
|
|
322
|
-
Developed at SunPro, a Sun Microsystems, Inc. business.
|
|
323
|
-
Permission to use, copy, modify, and distribute this
|
|
324
|
-
software is freely granted, provided that this notice
|
|
325
|
-
is preserved.
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
* FDLIBM <http://www.netlib.org/fdlibm/>
|
|
329
|
-
|
|
330
|
-
Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved.
|
|
331
|
-
|
|
332
|
-
Developed at SunPro, a Sun Microsystems, Inc. business.
|
|
333
|
-
Permission to use, copy, modify, and distribute this
|
|
334
|
-
software is freely granted, provided that this notice
|
|
335
|
-
is preserved.
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
* Go <https://raw.githubusercontent.com/golang/go/master/LICENSE>
|
|
339
|
-
|
|
340
|
-
Copyright (c) 2009 The Go Authors. All rights reserved.
|
|
341
|
-
|
|
342
|
-
Redistribution and use in source and binary forms, with or without
|
|
343
|
-
modification, are permitted provided that the following conditions are
|
|
344
|
-
met:
|
|
345
|
-
|
|
346
|
-
* Redistributions of source code must retain the above copyright
|
|
347
|
-
notice, this list of conditions and the following disclaimer.
|
|
348
|
-
* Redistributions in binary form must reproduce the above
|
|
349
|
-
copyright notice, this list of conditions and the following disclaimer
|
|
350
|
-
in the documentation and/or other materials provided with the
|
|
351
|
-
distribution.
|
|
352
|
-
* Neither the name of Google Inc. nor the names of its
|
|
353
|
-
contributors may be used to endorse or promote products derived from
|
|
354
|
-
this software without specific prior written permission.
|
|
355
|
-
|
|
356
|
-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
357
|
-
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
358
|
-
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
359
|
-
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
360
|
-
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
361
|
-
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
362
|
-
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
363
|
-
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
364
|
-
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
365
|
-
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
366
|
-
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
* SLATEC Common Mathematical Library <http://www.netlib.no/netlib/slatec/>
|
|
370
|
-
|
|
371
|
-
Public domain.
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
* ESLint <https://raw.githubusercontent.com/eslint/eslint/master/LICENSE>
|
|
375
|
-
|
|
376
|
-
Copyright JS Foundation and other contributors, https://js.foundation
|
|
377
|
-
|
|
378
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
379
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
380
|
-
in the Software without restriction, including without limitation the rights
|
|
381
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
382
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
383
|
-
furnished to do so, subject to the following conditions:
|
|
384
|
-
|
|
385
|
-
The above copyright notice and this permission notice shall be included in
|
|
386
|
-
all copies or substantial portions of the Software.
|
|
387
|
-
|
|
388
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
389
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
390
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
391
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
392
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
393
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
394
|
-
THE SOFTWARE.
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
* StatsFuns.jl <https://raw.githubusercontent.com/JuliaStats/StatsFuns.jl/
|
|
398
|
-
e66dd973650c375bc1739c820e5b96bb5bd000a8/LICENSE.md>
|
|
399
|
-
|
|
400
|
-
Copyright (c) 2015: Dahua Lin.
|
|
401
|
-
|
|
402
|
-
Permission is hereby granted, free of charge, to any person obtaining
|
|
403
|
-
a copy of this software and associated documentation files (the
|
|
404
|
-
"Software"), to deal in the Software without restriction, including
|
|
405
|
-
without limitation the rights to use, copy, modify, merge, publish,
|
|
406
|
-
distribute, sublicense, and/or sell copies of the Software, and to
|
|
407
|
-
permit persons to whom the Software is furnished to do so, subject to
|
|
408
|
-
the following conditions:
|
|
409
|
-
|
|
410
|
-
The above copyright notice and this permission notice shall be
|
|
411
|
-
included in all copies or substantial portions of the Software.
|
|
412
|
-
|
|
413
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
414
|
-
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
415
|
-
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
416
|
-
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
417
|
-
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
418
|
-
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
419
|
-
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
* SpecialFunctions.jl <https://raw.githubusercontent.com/JuliaMath/
|
|
423
|
-
SpecialFunctions.jl/02a173fbe24a61c4b392aec17a9764ac5727feb1/LICENSE>
|
|
424
|
-
|
|
425
|
-
The MIT License (MIT)
|
|
426
|
-
|
|
427
|
-
Copyright (c) 2017 Jeff Bezanson, Stefan Karpinski, Viral B. Shah, and others:
|
|
428
|
-
|
|
429
|
-
https://github.com/JuliaMath/SpecialFunctions.jl/graphs/contributors
|
|
430
|
-
|
|
431
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
432
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
433
|
-
in the Software without restriction, including without limitation the rights
|
|
434
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
435
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
436
|
-
furnished to do so, subject to the following conditions:
|
|
437
|
-
|
|
438
|
-
The above copyright notice and this permission notice shall be included in all
|
|
439
|
-
copies or substantial portions of the Software.
|
|
440
|
-
|
|
441
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
442
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
443
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
444
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
445
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
446
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
447
|
-
SOFTWARE.
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
* MT19937 <http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/CODES/
|
|
451
|
-
mt19937ar.c>
|
|
452
|
-
|
|
453
|
-
Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
|
|
454
|
-
All rights reserved.
|
|
455
|
-
|
|
456
|
-
Redistribution and use in source and binary forms, with or without
|
|
457
|
-
modification, are permitted provided that the following conditions
|
|
458
|
-
are met:
|
|
459
|
-
|
|
460
|
-
1. Redistributions of source code must retain the above copyright
|
|
461
|
-
notice, this list of conditions and the following disclaimer.
|
|
462
|
-
|
|
463
|
-
2. Redistributions in binary form must reproduce the above copyright
|
|
464
|
-
notice, this list of conditions and the following disclaimer in the
|
|
465
|
-
documentation and/or other materials provided with the distribution.
|
|
466
|
-
|
|
467
|
-
3. The names of its contributors may not be used to endorse or promote
|
|
468
|
-
products derived from this software without specific prior written
|
|
469
|
-
permission.
|
|
470
|
-
|
|
471
|
-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
472
|
-
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
473
|
-
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
474
|
-
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
475
|
-
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
476
|
-
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
477
|
-
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
478
|
-
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
479
|
-
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
480
|
-
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
481
|
-
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
package/NOTICE
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
Copyright (c) 2016-
|
|
1
|
+
Copyright (c) 2016-2023 The Stdlib Authors.
|
package/README.md
CHANGED
|
@@ -18,6 +18,17 @@ limitations under the License.
|
|
|
18
18
|
|
|
19
19
|
-->
|
|
20
20
|
|
|
21
|
+
|
|
22
|
+
<details>
|
|
23
|
+
<summary>
|
|
24
|
+
About stdlib...
|
|
25
|
+
</summary>
|
|
26
|
+
<p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
|
|
27
|
+
<p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
|
|
28
|
+
<p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
|
|
29
|
+
<p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
|
|
30
|
+
</details>
|
|
31
|
+
|
|
21
32
|
# snanvariance
|
|
22
33
|
|
|
23
34
|
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
|
|
@@ -33,7 +44,7 @@ The population [variance][variance] of a finite size population of size `N` is g
|
|
|
33
44
|
<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">
|
|
34
45
|
<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.">
|
|
35
46
|
<br>
|
|
36
|
-
</div>
|
|
47
|
+
</div> -->
|
|
37
48
|
|
|
38
49
|
<!-- </equation> -->
|
|
39
50
|
|
|
@@ -41,10 +52,10 @@ where the population mean is given by
|
|
|
41
52
|
|
|
42
53
|
<!-- <equation class="equation" label="eq:population_mean" align="center" raw="\mu = \frac{1}{N} \sum_{i=0}^{N-1} x_i" alt="Equation for the population mean."> -->
|
|
43
54
|
|
|
44
|
-
<div class="equation" align="center" data-raw-text="\mu = \frac{1}{N} \sum_{i=0}^{N-1} x_i" data-equation="eq:population_mean">
|
|
55
|
+
<!-- <div class="equation" align="center" data-raw-text="\mu = \frac{1}{N} \sum_{i=0}^{N-1} x_i" data-equation="eq:population_mean">
|
|
45
56
|
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@9ccc2be07b155022bc78ae97c29f16f55c37adde/lib/node_modules/@stdlib/stats/base/snanvariance/docs/img/equation_population_mean.svg" alt="Equation for the population mean.">
|
|
46
57
|
<br>
|
|
47
|
-
</div>
|
|
58
|
+
</div> -->
|
|
48
59
|
|
|
49
60
|
<!-- </equation> -->
|
|
50
61
|
|
|
@@ -52,10 +63,10 @@ Often in the analysis of data, the true population [variance][variance] is not k
|
|
|
52
63
|
|
|
53
64
|
<!-- <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."> -->
|
|
54
65
|
|
|
55
|
-
<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">
|
|
66
|
+
<!-- <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">
|
|
56
67
|
<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.">
|
|
57
68
|
<br>
|
|
58
|
-
</div>
|
|
69
|
+
</div> -->
|
|
59
70
|
|
|
60
71
|
<!-- </equation> -->
|
|
61
72
|
|
|
@@ -63,7 +74,7 @@ where the sample mean is given by
|
|
|
63
74
|
|
|
64
75
|
<!-- <equation class="equation" label="eq:sample_mean" align="center" raw="\bar{x} = \frac{1}{n} \sum_{i=0}^{n-1} x_i" alt="Equation for the sample mean."> -->
|
|
65
76
|
|
|
66
|
-
<div class="equation" align="center" data-raw-text="\bar{x} = \frac{1}{n} \sum_{i=0}^{n-1} x_i" data-equation="eq:sample_mean">
|
|
77
|
+
<!-- <div class="equation" align="center" data-raw-text="\bar{x} = \frac{1}{n} \sum_{i=0}^{n-1} x_i" data-equation="eq:sample_mean">
|
|
67
78
|
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@9ccc2be07b155022bc78ae97c29f16f55c37adde/lib/node_modules/@stdlib/stats/base/snanvariance/docs/img/equation_sample_mean.svg" alt="Equation for the sample mean.">
|
|
68
79
|
<br>
|
|
69
80
|
</div>
|
|
@@ -232,10 +243,10 @@ console.log( v );
|
|
|
232
243
|
|
|
233
244
|
## See Also
|
|
234
245
|
|
|
235
|
-
- <span class="package-name">[`@stdlib/stats
|
|
236
|
-
- <span class="package-name">[`@stdlib/stats
|
|
237
|
-
- <span class="package-name">[`@stdlib/stats
|
|
238
|
-
- <span class="package-name">[`@stdlib/stats
|
|
246
|
+
- <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>
|
|
247
|
+
- <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>
|
|
248
|
+
- <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>
|
|
249
|
+
- <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>
|
|
239
250
|
|
|
240
251
|
</section>
|
|
241
252
|
|
|
@@ -267,7 +278,7 @@ See [LICENSE][stdlib-license].
|
|
|
267
278
|
|
|
268
279
|
## Copyright
|
|
269
280
|
|
|
270
|
-
Copyright © 2016-
|
|
281
|
+
Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors].
|
|
271
282
|
|
|
272
283
|
</section>
|
|
273
284
|
|
|
@@ -280,8 +291,8 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
280
291
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-snanvariance.svg
|
|
281
292
|
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-snanvariance
|
|
282
293
|
|
|
283
|
-
[test-image]: https://github.com/stdlib-js/stats-base-snanvariance/actions/workflows/test.yml/badge.svg
|
|
284
|
-
[test-url]: https://github.com/stdlib-js/stats-base-snanvariance/actions/workflows/test.yml
|
|
294
|
+
[test-image]: https://github.com/stdlib-js/stats-base-snanvariance/actions/workflows/test.yml/badge.svg?branch=v0.1.0
|
|
295
|
+
[test-url]: https://github.com/stdlib-js/stats-base-snanvariance/actions/workflows/test.yml?query=branch:v0.1.0
|
|
285
296
|
|
|
286
297
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-snanvariance/main.svg
|
|
287
298
|
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-snanvariance?branch=main
|
|
@@ -293,19 +304,20 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
293
304
|
|
|
294
305
|
-->
|
|
295
306
|
|
|
307
|
+
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
|
308
|
+
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
|
|
309
|
+
|
|
310
|
+
[stdlib]: https://github.com/stdlib-js/stdlib
|
|
311
|
+
|
|
312
|
+
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
|
|
313
|
+
|
|
296
314
|
[umd]: https://github.com/umdjs/umd
|
|
297
315
|
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
|
|
298
316
|
|
|
299
317
|
[deno-url]: https://github.com/stdlib-js/stats-base-snanvariance/tree/deno
|
|
300
318
|
[umd-url]: https://github.com/stdlib-js/stats-base-snanvariance/tree/umd
|
|
301
319
|
[esm-url]: https://github.com/stdlib-js/stats-base-snanvariance/tree/esm
|
|
302
|
-
|
|
303
|
-
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
|
304
|
-
[chat-url]: https://gitter.im/stdlib-js/stdlib/
|
|
305
|
-
|
|
306
|
-
[stdlib]: https://github.com/stdlib-js/stdlib
|
|
307
|
-
|
|
308
|
-
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
|
|
320
|
+
[branches-url]: https://github.com/stdlib-js/stats-base-snanvariance/blob/main/branches.md
|
|
309
321
|
|
|
310
322
|
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-snanvariance/main/LICENSE
|
|
311
323
|
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";var i=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var u=i(function(h,t){
|
|
2
|
+
var x=require('@stdlib/stats-base-snanvariancepn/dist');function f(e,r,a,n){return x(e,r,a,n)}t.exports=f
|
|
3
|
+
});var c=i(function(k,v){
|
|
4
|
+
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
|
|
5
|
+
});var p=i(function(w,o){
|
|
6
|
+
var l=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),q=u(),R=c();l(q,"ndarray",R);o.exports=q
|
|
7
|
+
});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;
|
|
8
|
+
/** @license Apache-2.0 */
|
|
9
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../lib/snanvariance.js", "../lib/ndarray.js", "../lib/main.js", "../lib/index.js"],
|
|
4
|
+
"sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar 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"],
|
|
5
|
+
"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",
|
|
6
|
+
"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"]
|
|
7
|
+
}
|
package/docs/types/index.d.ts
CHANGED
package/lib/index.js
CHANGED
|
@@ -48,13 +48,17 @@
|
|
|
48
48
|
|
|
49
49
|
var join = require( 'path' ).join;
|
|
50
50
|
var tryRequire = require( '@stdlib/utils-try-require' );
|
|
51
|
-
var
|
|
51
|
+
var isError = require( '@stdlib/assert-is-error' );
|
|
52
|
+
var main = require( './main.js' );
|
|
52
53
|
|
|
53
54
|
|
|
54
55
|
// MAIN //
|
|
55
56
|
|
|
57
|
+
var snanvariance;
|
|
56
58
|
var tmp = tryRequire( join( __dirname, './native.js' ) );
|
|
57
|
-
if (
|
|
59
|
+
if ( isError( tmp ) ) {
|
|
60
|
+
snanvariance = main;
|
|
61
|
+
} else {
|
|
58
62
|
snanvariance = tmp;
|
|
59
63
|
}
|
|
60
64
|
|
|
@@ -62,3 +66,5 @@ if ( !(tmp instanceof Error) ) {
|
|
|
62
66
|
// EXPORTS //
|
|
63
67
|
|
|
64
68
|
module.exports = snanvariance;
|
|
69
|
+
|
|
70
|
+
// exports: { "ndarray": "snanvariance.ndarray" }
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stdlib/stats-base-snanvariance",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.1.0",
|
|
4
4
|
"description": "Calculate the variance of a single-precision floating-point strided array ignoring NaN values.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": {
|
|
@@ -41,25 +41,26 @@
|
|
|
41
41
|
"url": "https://github.com/stdlib-js/stdlib/issues"
|
|
42
42
|
},
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"@stdlib/
|
|
45
|
-
"@stdlib/
|
|
46
|
-
"@stdlib/utils-
|
|
47
|
-
"@stdlib/utils-
|
|
44
|
+
"@stdlib/assert-is-error": "^0.1.0",
|
|
45
|
+
"@stdlib/stats-base-snanvariancepn": "^0.1.0",
|
|
46
|
+
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0",
|
|
47
|
+
"@stdlib/utils-library-manifest": "^0.1.0",
|
|
48
|
+
"@stdlib/utils-try-require": "^0.1.0"
|
|
48
49
|
},
|
|
49
50
|
"devDependencies": {
|
|
50
|
-
"@stdlib/array-float32": "^0.0
|
|
51
|
-
"@stdlib/assert-is-browser": "^0.0
|
|
52
|
-
"@stdlib/bench": "^0.0
|
|
53
|
-
"@stdlib/math-base-assert-is-nanf": "^0.0
|
|
54
|
-
"@stdlib/math-base-special-floor": "^0.0
|
|
55
|
-
"@stdlib/math-base-special-pow": "^0.0.
|
|
56
|
-
"@stdlib/math-base-special-round": "^0.0
|
|
57
|
-
"@stdlib/number-float64-base-to-float32": "^0.0
|
|
58
|
-
"@stdlib/random-base-randu": "^0.0.
|
|
51
|
+
"@stdlib/array-float32": "^0.1.0",
|
|
52
|
+
"@stdlib/assert-is-browser": "^0.1.0",
|
|
53
|
+
"@stdlib/bench": "^0.1.0",
|
|
54
|
+
"@stdlib/math-base-assert-is-nanf": "^0.1.0",
|
|
55
|
+
"@stdlib/math-base-special-floor": "^0.1.0",
|
|
56
|
+
"@stdlib/math-base-special-pow": "^0.0.7",
|
|
57
|
+
"@stdlib/math-base-special-round": "^0.1.0",
|
|
58
|
+
"@stdlib/number-float64-base-to-float32": "^0.1.0",
|
|
59
|
+
"@stdlib/random-base-randu": "^0.0.8",
|
|
59
60
|
"proxyquire": "^2.0.0",
|
|
60
61
|
"tape": "git+https://github.com/kgryte/tape.git#fix/globby",
|
|
61
62
|
"istanbul": "^0.4.1",
|
|
62
|
-
"tap-
|
|
63
|
+
"tap-min": "git+https://github.com/Planeshifter/tap-min.git"
|
|
63
64
|
},
|
|
64
65
|
"engines": {
|
|
65
66
|
"node": ">=0.10.0",
|
|
@@ -103,7 +104,7 @@
|
|
|
103
104
|
],
|
|
104
105
|
"__stdlib__": {},
|
|
105
106
|
"funding": {
|
|
106
|
-
"type": "
|
|
107
|
-
"url": "https://
|
|
107
|
+
"type": "opencollective",
|
|
108
|
+
"url": "https://opencollective.com/stdlib"
|
|
108
109
|
}
|
|
109
110
|
}
|
package/docs/repl.txt
DELETED
|
@@ -1,120 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
{{alias}}( N, correction, x, stride )
|
|
3
|
-
Computes the variance of a single-precision floating-point strided array
|
|
4
|
-
ignoring `NaN` values.
|
|
5
|
-
|
|
6
|
-
The `N` and `stride` parameters determine which elements in `x` are accessed
|
|
7
|
-
at runtime.
|
|
8
|
-
|
|
9
|
-
Indexing is relative to the first index. To introduce an offset, use a typed
|
|
10
|
-
array view.
|
|
11
|
-
|
|
12
|
-
If `N <= 0`, the function returns `NaN`.
|
|
13
|
-
|
|
14
|
-
If every indexed element is `NaN`, the function returns `NaN`.
|
|
15
|
-
|
|
16
|
-
Parameters
|
|
17
|
-
----------
|
|
18
|
-
N: integer
|
|
19
|
-
Number of indexed elements.
|
|
20
|
-
|
|
21
|
-
correction: number
|
|
22
|
-
Degrees of freedom adjustment. Setting this parameter to a value other
|
|
23
|
-
than `0` has the effect of adjusting the divisor during the calculation
|
|
24
|
-
of the variance according to `n - c` where `c` corresponds to the
|
|
25
|
-
provided degrees of freedom adjustment and `n` corresponds to the number
|
|
26
|
-
of non-`NaN` indexed elements. When computing the variance of a
|
|
27
|
-
population, setting this parameter to `0` is the standard choice (i.e.,
|
|
28
|
-
the provided array contains data constituting an entire population).
|
|
29
|
-
When computing the unbiased sample variance, setting this parameter to
|
|
30
|
-
`1` is the standard choice (i.e., the provided array contains data
|
|
31
|
-
sampled from a larger population; this is commonly referred to as
|
|
32
|
-
Bessel's correction).
|
|
33
|
-
|
|
34
|
-
x: Float32Array
|
|
35
|
-
Input array.
|
|
36
|
-
|
|
37
|
-
stride: integer
|
|
38
|
-
Index increment.
|
|
39
|
-
|
|
40
|
-
Returns
|
|
41
|
-
-------
|
|
42
|
-
out: number
|
|
43
|
-
The variance.
|
|
44
|
-
|
|
45
|
-
Examples
|
|
46
|
-
--------
|
|
47
|
-
// Standard Usage:
|
|
48
|
-
> var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, NaN, 2.0 ] );
|
|
49
|
-
> {{alias}}( x.length, 1, x, 1 )
|
|
50
|
-
~4.3333
|
|
51
|
-
|
|
52
|
-
// Using `N` and `stride` parameters:
|
|
53
|
-
> x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );
|
|
54
|
-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
|
|
55
|
-
> {{alias}}( N, 1, x, 2 )
|
|
56
|
-
~4.3333
|
|
57
|
-
|
|
58
|
-
// Using view offsets:
|
|
59
|
-
> var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
|
|
60
|
-
> var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
|
|
61
|
-
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
|
|
62
|
-
> {{alias}}( N, 1, x1, 2 )
|
|
63
|
-
~4.3333
|
|
64
|
-
|
|
65
|
-
{{alias}}.ndarray( N, correction, x, stride, offset )
|
|
66
|
-
Computes the variance of a single-precision floating-point strided array
|
|
67
|
-
ignoring `NaN` values and using alternative indexing semantics.
|
|
68
|
-
|
|
69
|
-
While typed array views mandate a view offset based on the underlying
|
|
70
|
-
buffer, the `offset` parameter supports indexing semantics based on a
|
|
71
|
-
starting index.
|
|
72
|
-
|
|
73
|
-
Parameters
|
|
74
|
-
----------
|
|
75
|
-
N: integer
|
|
76
|
-
Number of indexed elements.
|
|
77
|
-
|
|
78
|
-
correction: number
|
|
79
|
-
Degrees of freedom adjustment. Setting this parameter to a value other
|
|
80
|
-
than `0` has the effect of adjusting the divisor during the calculation
|
|
81
|
-
of the variance according to `n - c` where `c` corresponds to the
|
|
82
|
-
provided degrees of freedom adjustment and `n` corresponds to the number
|
|
83
|
-
of non-`NaN` indexed elements. When computing the variance of a
|
|
84
|
-
population, setting this parameter to `0` is the standard choice (i.e.,
|
|
85
|
-
the provided array contains data constituting an entire population).
|
|
86
|
-
When computing the unbiased sample variance, setting this parameter to
|
|
87
|
-
`1` is the standard choice (i.e., the provided array contains data
|
|
88
|
-
sampled from a larger population; this is commonly referred to as
|
|
89
|
-
Bessel's correction).
|
|
90
|
-
|
|
91
|
-
x: Float32Array
|
|
92
|
-
Input array.
|
|
93
|
-
|
|
94
|
-
stride: integer
|
|
95
|
-
Index increment.
|
|
96
|
-
|
|
97
|
-
offset: integer
|
|
98
|
-
Starting index.
|
|
99
|
-
|
|
100
|
-
Returns
|
|
101
|
-
-------
|
|
102
|
-
out: number
|
|
103
|
-
The variance.
|
|
104
|
-
|
|
105
|
-
Examples
|
|
106
|
-
--------
|
|
107
|
-
// Standard Usage:
|
|
108
|
-
> var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, NaN, 2.0 ] );
|
|
109
|
-
> {{alias}}.ndarray( x.length, 1, x, 1, 0 )
|
|
110
|
-
~4.3333
|
|
111
|
-
|
|
112
|
-
// Using offset parameter:
|
|
113
|
-
> var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
|
|
114
|
-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
|
|
115
|
-
> {{alias}}.ndarray( N, 1, x, 2, 1 )
|
|
116
|
-
~4.3333
|
|
117
|
-
|
|
118
|
-
See Also
|
|
119
|
-
--------
|
|
120
|
-
|
package/docs/types/test.ts
DELETED
|
@@ -1,187 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* @license Apache-2.0
|
|
3
|
-
*
|
|
4
|
-
* Copyright (c) 2020 The Stdlib Authors.
|
|
5
|
-
*
|
|
6
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
7
|
-
* you may not use this file except in compliance with the License.
|
|
8
|
-
* You may obtain a copy of the License at
|
|
9
|
-
*
|
|
10
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
11
|
-
*
|
|
12
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
13
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
14
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
15
|
-
* See the License for the specific language governing permissions and
|
|
16
|
-
* limitations under the License.
|
|
17
|
-
*/
|
|
18
|
-
|
|
19
|
-
import snanvariance = require( './index' );
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
// TESTS //
|
|
23
|
-
|
|
24
|
-
// The function returns a number...
|
|
25
|
-
{
|
|
26
|
-
const x = new Float32Array( 10 );
|
|
27
|
-
|
|
28
|
-
snanvariance( x.length, 1, x, 1 ); // $ExpectType number
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
// The compiler throws an error if the function is provided a first argument which is not a number...
|
|
32
|
-
{
|
|
33
|
-
const x = new Float32Array( 10 );
|
|
34
|
-
|
|
35
|
-
snanvariance( '10', 1, x, 1 ); // $ExpectError
|
|
36
|
-
snanvariance( true, 1, x, 1 ); // $ExpectError
|
|
37
|
-
snanvariance( false, 1, x, 1 ); // $ExpectError
|
|
38
|
-
snanvariance( null, 1, x, 1 ); // $ExpectError
|
|
39
|
-
snanvariance( undefined, 1, x, 1 ); // $ExpectError
|
|
40
|
-
snanvariance( [], 1, x, 1 ); // $ExpectError
|
|
41
|
-
snanvariance( {}, 1, x, 1 ); // $ExpectError
|
|
42
|
-
snanvariance( ( x: number ): number => x, 1, x, 1 ); // $ExpectError
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
// The compiler throws an error if the function is provided a second argument which is not a number...
|
|
46
|
-
{
|
|
47
|
-
const x = new Float32Array( 10 );
|
|
48
|
-
|
|
49
|
-
snanvariance( x.length, '10', x, 1 ); // $ExpectError
|
|
50
|
-
snanvariance( x.length, true, x, 1 ); // $ExpectError
|
|
51
|
-
snanvariance( x.length, false, x, 1 ); // $ExpectError
|
|
52
|
-
snanvariance( x.length, null, x, 1 ); // $ExpectError
|
|
53
|
-
snanvariance( x.length, undefined, x, 1 ); // $ExpectError
|
|
54
|
-
snanvariance( x.length, [], x, 1 ); // $ExpectError
|
|
55
|
-
snanvariance( x.length, {}, x, 1 ); // $ExpectError
|
|
56
|
-
snanvariance( x.length, ( x: number ): number => x, x, 1 ); // $ExpectError
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
// The compiler throws an error if the function is provided a third argument which is not a Float32Array...
|
|
60
|
-
{
|
|
61
|
-
const x = new Float32Array( 10 );
|
|
62
|
-
|
|
63
|
-
snanvariance( x.length, 1, 10, 1 ); // $ExpectError
|
|
64
|
-
snanvariance( x.length, 1, '10', 1 ); // $ExpectError
|
|
65
|
-
snanvariance( x.length, 1, true, 1 ); // $ExpectError
|
|
66
|
-
snanvariance( x.length, 1, false, 1 ); // $ExpectError
|
|
67
|
-
snanvariance( x.length, 1, null, 1 ); // $ExpectError
|
|
68
|
-
snanvariance( x.length, 1, undefined, 1 ); // $ExpectError
|
|
69
|
-
snanvariance( x.length, 1, [], 1 ); // $ExpectError
|
|
70
|
-
snanvariance( x.length, 1, {}, 1 ); // $ExpectError
|
|
71
|
-
snanvariance( x.length, 1, ( x: number ): number => x, 1 ); // $ExpectError
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
// The compiler throws an error if the function is provided a fourth argument which is not a number...
|
|
75
|
-
{
|
|
76
|
-
const x = new Float32Array( 10 );
|
|
77
|
-
|
|
78
|
-
snanvariance( x.length, 1, x, '10' ); // $ExpectError
|
|
79
|
-
snanvariance( x.length, 1, x, true ); // $ExpectError
|
|
80
|
-
snanvariance( x.length, 1, x, false ); // $ExpectError
|
|
81
|
-
snanvariance( x.length, 1, x, null ); // $ExpectError
|
|
82
|
-
snanvariance( x.length, 1, x, undefined ); // $ExpectError
|
|
83
|
-
snanvariance( x.length, 1, x, [] ); // $ExpectError
|
|
84
|
-
snanvariance( x.length, 1, x, {} ); // $ExpectError
|
|
85
|
-
snanvariance( x.length, 1, x, ( x: number ): number => x ); // $ExpectError
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
// The compiler throws an error if the function is provided an unsupported number of arguments...
|
|
89
|
-
{
|
|
90
|
-
const x = new Float32Array( 10 );
|
|
91
|
-
|
|
92
|
-
snanvariance(); // $ExpectError
|
|
93
|
-
snanvariance( x.length ); // $ExpectError
|
|
94
|
-
snanvariance( x.length, 1 ); // $ExpectError
|
|
95
|
-
snanvariance( x.length, 1, x ); // $ExpectError
|
|
96
|
-
snanvariance( x.length, 1, x, 1, 10 ); // $ExpectError
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
// Attached to main export is an `ndarray` method which returns a number...
|
|
100
|
-
{
|
|
101
|
-
const x = new Float32Array( 10 );
|
|
102
|
-
|
|
103
|
-
snanvariance.ndarray( x.length, 1, x, 1, 0 ); // $ExpectType number
|
|
104
|
-
}
|
|
105
|
-
|
|
106
|
-
// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number...
|
|
107
|
-
{
|
|
108
|
-
const x = new Float32Array( 10 );
|
|
109
|
-
|
|
110
|
-
snanvariance.ndarray( '10', 1, x, 1, 0 ); // $ExpectError
|
|
111
|
-
snanvariance.ndarray( true, 1, x, 1, 0 ); // $ExpectError
|
|
112
|
-
snanvariance.ndarray( false, 1, x, 1, 0 ); // $ExpectError
|
|
113
|
-
snanvariance.ndarray( null, 1, x, 1, 0 ); // $ExpectError
|
|
114
|
-
snanvariance.ndarray( undefined, 1, x, 1, 0 ); // $ExpectError
|
|
115
|
-
snanvariance.ndarray( [], 1, x, 1, 0 ); // $ExpectError
|
|
116
|
-
snanvariance.ndarray( {}, 1, x, 1, 0 ); // $ExpectError
|
|
117
|
-
snanvariance.ndarray( ( x: number ): number => x, 1, x, 1, 0 ); // $ExpectError
|
|
118
|
-
}
|
|
119
|
-
|
|
120
|
-
// The compiler throws an error if the `ndarray` method is provided a second argument which is not a number...
|
|
121
|
-
{
|
|
122
|
-
const x = new Float32Array( 10 );
|
|
123
|
-
|
|
124
|
-
snanvariance.ndarray( x.length, '10', x, 1, 0 ); // $ExpectError
|
|
125
|
-
snanvariance.ndarray( x.length, true, x, 1, 0 ); // $ExpectError
|
|
126
|
-
snanvariance.ndarray( x.length, false, x, 1, 0 ); // $ExpectError
|
|
127
|
-
snanvariance.ndarray( x.length, null, x, 1, 0 ); // $ExpectError
|
|
128
|
-
snanvariance.ndarray( x.length, undefined, x, 1, 0 ); // $ExpectError
|
|
129
|
-
snanvariance.ndarray( x.length, [], x, 1, 0 ); // $ExpectError
|
|
130
|
-
snanvariance.ndarray( x.length, {}, x, 1, 0 ); // $ExpectError
|
|
131
|
-
snanvariance.ndarray( x.length, ( x: number ): number => x, x, 1, 0 ); // $ExpectError
|
|
132
|
-
}
|
|
133
|
-
|
|
134
|
-
// The compiler throws an error if the `ndarray` method is provided a third argument which is not a Float32Array...
|
|
135
|
-
{
|
|
136
|
-
const x = new Float32Array( 10 );
|
|
137
|
-
|
|
138
|
-
snanvariance.ndarray( x.length, 1, 10, 1, 0 ); // $ExpectError
|
|
139
|
-
snanvariance.ndarray( x.length, 1, '10', 1, 0 ); // $ExpectError
|
|
140
|
-
snanvariance.ndarray( x.length, 1, true, 1, 0 ); // $ExpectError
|
|
141
|
-
snanvariance.ndarray( x.length, 1, false, 1, 0 ); // $ExpectError
|
|
142
|
-
snanvariance.ndarray( x.length, 1, null, 1, 0 ); // $ExpectError
|
|
143
|
-
snanvariance.ndarray( x.length, 1, undefined, 1, 0 ); // $ExpectError
|
|
144
|
-
snanvariance.ndarray( x.length, 1, [], 1, 0 ); // $ExpectError
|
|
145
|
-
snanvariance.ndarray( x.length, 1, {}, 1, 0 ); // $ExpectError
|
|
146
|
-
snanvariance.ndarray( x.length, 1, ( x: number ): number => x, 1, 0 ); // $ExpectError
|
|
147
|
-
}
|
|
148
|
-
|
|
149
|
-
// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number...
|
|
150
|
-
{
|
|
151
|
-
const x = new Float32Array( 10 );
|
|
152
|
-
|
|
153
|
-
snanvariance.ndarray( x.length, 1, x, '10', 0 ); // $ExpectError
|
|
154
|
-
snanvariance.ndarray( x.length, 1, x, true, 0 ); // $ExpectError
|
|
155
|
-
snanvariance.ndarray( x.length, 1, x, false, 0 ); // $ExpectError
|
|
156
|
-
snanvariance.ndarray( x.length, 1, x, null, 0 ); // $ExpectError
|
|
157
|
-
snanvariance.ndarray( x.length, 1, x, undefined, 0 ); // $ExpectError
|
|
158
|
-
snanvariance.ndarray( x.length, 1, x, [], 0 ); // $ExpectError
|
|
159
|
-
snanvariance.ndarray( x.length, 1, x, {}, 0 ); // $ExpectError
|
|
160
|
-
snanvariance.ndarray( x.length, 1, x, ( x: number ): number => x, 0 ); // $ExpectError
|
|
161
|
-
}
|
|
162
|
-
|
|
163
|
-
// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a number...
|
|
164
|
-
{
|
|
165
|
-
const x = new Float32Array( 10 );
|
|
166
|
-
|
|
167
|
-
snanvariance.ndarray( x.length, 1, x, 1, '10' ); // $ExpectError
|
|
168
|
-
snanvariance.ndarray( x.length, 1, x, 1, true ); // $ExpectError
|
|
169
|
-
snanvariance.ndarray( x.length, 1, x, 1, false ); // $ExpectError
|
|
170
|
-
snanvariance.ndarray( x.length, 1, x, 1, null ); // $ExpectError
|
|
171
|
-
snanvariance.ndarray( x.length, 1, x, 1, undefined ); // $ExpectError
|
|
172
|
-
snanvariance.ndarray( x.length, 1, x, 1, [] ); // $ExpectError
|
|
173
|
-
snanvariance.ndarray( x.length, 1, x, 1, {} ); // $ExpectError
|
|
174
|
-
snanvariance.ndarray( x.length, 1, x, 1, ( x: number ): number => x ); // $ExpectError
|
|
175
|
-
}
|
|
176
|
-
|
|
177
|
-
// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments...
|
|
178
|
-
{
|
|
179
|
-
const x = new Float32Array( 10 );
|
|
180
|
-
|
|
181
|
-
snanvariance.ndarray(); // $ExpectError
|
|
182
|
-
snanvariance.ndarray( x.length ); // $ExpectError
|
|
183
|
-
snanvariance.ndarray( x.length, 1 ); // $ExpectError
|
|
184
|
-
snanvariance.ndarray( x.length, 1, x ); // $ExpectError
|
|
185
|
-
snanvariance.ndarray( x.length, 1, x, 1 ); // $ExpectError
|
|
186
|
-
snanvariance.ndarray( x.length, 1, x, 1, 0, 10 ); // $ExpectError
|
|
187
|
-
}
|