@stdlib/stats-base-snanstdevpn 0.0.2 → 0.0.6

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/NOTICE CHANGED
@@ -1 +1 @@
1
- Copyright (c) 2016-2021 The Stdlib Authors.
1
+ Copyright (c) 2016-2022 The Stdlib Authors.
package/README.md CHANGED
@@ -20,7 +20,7 @@ limitations under the License.
20
20
 
21
21
  # snanstdevpn
22
22
 
23
- [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
23
+ [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
24
24
 
25
25
  > Calculate the [standard deviation][standard-deviation] of a single-precision floating-point strided array ignoring `NaN` values and using a two-pass algorithm.
26
26
 
@@ -31,7 +31,7 @@ The population [standard deviation][standard-deviation] of a finite size populat
31
31
  <!-- <equation class="equation" label="eq:population_standard_deviation" align="center" raw="\sigma = \sqrt{\frac{1}{N} \sum_{i=0}^{N-1} (x_i - \mu)^2}" alt="Equation for the population standard deviation."> -->
32
32
 
33
33
  <div class="equation" align="center" data-raw-text="\sigma = \sqrt{\frac{1}{N} \sum_{i=0}^{N-1} (x_i - \mu)^2}" data-equation="eq:population_standard_deviation">
34
- <img src="https://cdn.rawgit.com/stdlib-js/stdlib/78d37f4c952f08780dfde842c0890f536a3b643d/lib/node_modules/@stdlib/stats/base/snanstdevpn/docs/img/equation_population_standard_deviation.svg" alt="Equation for the population standard deviation.">
34
+ <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@0ddbe81cc0180e06d3ff9b02ff6e1e5b752bb524/lib/node_modules/@stdlib/stats/base/snanstdevpn/docs/img/equation_population_standard_deviation.svg" alt="Equation for the population standard deviation.">
35
35
  <br>
36
36
  </div>
37
37
 
@@ -42,7 +42,7 @@ where the population mean is given by
42
42
  <!-- <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
43
 
44
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">
45
- <img src="https://cdn.rawgit.com/stdlib-js/stdlib/78d37f4c952f08780dfde842c0890f536a3b643d/lib/node_modules/@stdlib/stats/base/snanstdevpn/docs/img/equation_population_mean.svg" alt="Equation for the population mean.">
45
+ <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@0ddbe81cc0180e06d3ff9b02ff6e1e5b752bb524/lib/node_modules/@stdlib/stats/base/snanstdevpn/docs/img/equation_population_mean.svg" alt="Equation for the population mean.">
46
46
  <br>
47
47
  </div>
48
48
 
@@ -53,7 +53,7 @@ Often in the analysis of data, the true population [standard deviation][standard
53
53
  <!-- <equation class="equation" label="eq:corrected_sample_standard_deviation" align="center" raw="s = \sqrt{\frac{1}{n-1} \sum_{i=0}^{n-1} (x_i - \bar{x})^2}" alt="Equation for computing a corrected sample standard deviation."> -->
54
54
 
55
55
  <div class="equation" align="center" data-raw-text="s = \sqrt{\frac{1}{n-1} \sum_{i=0}^{n-1} (x_i - \bar{x})^2}" data-equation="eq:corrected_sample_standard_deviation">
56
- <img src="https://cdn.rawgit.com/stdlib-js/stdlib/78d37f4c952f08780dfde842c0890f536a3b643d/lib/node_modules/@stdlib/stats/base/snanstdevpn/docs/img/equation_corrected_sample_standard_deviation.svg" alt="Equation for computing a corrected sample standard deviation.">
56
+ <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@0ddbe81cc0180e06d3ff9b02ff6e1e5b752bb524/lib/node_modules/@stdlib/stats/base/snanstdevpn/docs/img/equation_corrected_sample_standard_deviation.svg" alt="Equation for computing a corrected sample standard deviation.">
57
57
  <br>
58
58
  </div>
59
59
 
@@ -64,7 +64,7 @@ where the sample mean is given by
64
64
  <!-- <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
65
 
66
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">
67
- <img src="https://cdn.rawgit.com/stdlib-js/stdlib/78d37f4c952f08780dfde842c0890f536a3b643d/lib/node_modules/@stdlib/stats/base/snanstdevpn/docs/img/equation_sample_mean.svg" alt="Equation for the sample mean.">
67
+ <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@0ddbe81cc0180e06d3ff9b02ff6e1e5b752bb524/lib/node_modules/@stdlib/stats/base/snanstdevpn/docs/img/equation_sample_mean.svg" alt="Equation for the sample mean.">
68
68
  <br>
69
69
  </div>
70
70
 
@@ -231,6 +231,26 @@ console.log( v );
231
231
 
232
232
  <!-- /.references -->
233
233
 
234
+ <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
235
+
236
+ <section class="related">
237
+
238
+ * * *
239
+
240
+ ## See Also
241
+
242
+ - <span class="package-name">[`@stdlib/stats/base/dnanstdevpn`][@stdlib/stats/base/dnanstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a double-precision floating-point strided array ignoring NaN values and using a two-pass algorithm.</span>
243
+ - <span class="package-name">[`@stdlib/stats/base/nanstdevpn`][@stdlib/stats/base/nanstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a strided array ignoring NaN values and using a two-pass algorithm.</span>
244
+ - <span class="package-name">[`@stdlib/stats/base/snanstdev`][@stdlib/stats/base/snanstdev]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array ignoring NaN values.</span>
245
+ - <span class="package-name">[`@stdlib/stats/base/snanvariancepn`][@stdlib/stats/base/snanvariancepn]</span><span class="delimiter">: </span><span class="description">calculate the variance of a single-precision floating-point strided array ignoring NaN values and using a two-pass algorithm.</span>
246
+ - <span class="package-name">[`@stdlib/stats/base/sstdevpn`][@stdlib/stats/base/sstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a single-precision floating-point strided array using a two-pass algorithm.</span>
247
+
248
+ </section>
249
+
250
+ <!-- /.related -->
251
+
252
+ <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
253
+
234
254
 
235
255
  <section class="main-repo" >
236
256
 
@@ -242,6 +262,10 @@ This package is part of [stdlib][stdlib], a standard library for JavaScript and
242
262
 
243
263
  For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
244
264
 
265
+ #### Community
266
+
267
+ [![Chat][chat-image]][chat-url]
268
+
245
269
  ---
246
270
 
247
271
  ## License
@@ -251,7 +275,7 @@ See [LICENSE][stdlib-license].
251
275
 
252
276
  ## Copyright
253
277
 
254
- Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
278
+ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
255
279
 
256
280
  </section>
257
281
 
@@ -270,9 +294,23 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
270
294
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-snanstdevpn/main.svg
271
295
  [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-snanstdevpn?branch=main
272
296
 
273
- [dependencies-image]: https://img.shields.io/david/stdlib-js/stats-base-snanstdevpn
297
+ <!--
298
+
299
+ [dependencies-image]: https://img.shields.io/david/stdlib-js/stats-base-snanstdevpn.svg
274
300
  [dependencies-url]: https://david-dm.org/stdlib-js/stats-base-snanstdevpn/main
275
301
 
302
+ -->
303
+
304
+ [umd]: https://github.com/umdjs/umd
305
+ [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
306
+
307
+ [deno-url]: https://github.com/stdlib-js/stats-base-snanstdevpn/tree/deno
308
+ [umd-url]: https://github.com/stdlib-js/stats-base-snanstdevpn/tree/umd
309
+ [esm-url]: https://github.com/stdlib-js/stats-base-snanstdevpn/tree/esm
310
+
311
+ [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
312
+ [chat-url]: https://gitter.im/stdlib-js/stdlib/
313
+
276
314
  [stdlib]: https://github.com/stdlib-js/stdlib
277
315
 
278
316
  [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
@@ -281,7 +319,7 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
281
319
 
282
320
  [standard-deviation]: https://en.wikipedia.org/wiki/Standard_deviation
283
321
 
284
- [@stdlib/array/float32]: https://github.com/stdlib-js/stdlib
322
+ [@stdlib/array/float32]: https://www.npmjs.com/package/@stdlib/array-float32
285
323
 
286
324
  [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
287
325
 
@@ -289,6 +327,20 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
289
327
 
290
328
  [@schubert:2018a]: https://doi.org/10.1145/3221269.3223036
291
329
 
330
+ <!-- <related-links> -->
331
+
332
+ [@stdlib/stats/base/dnanstdevpn]: https://www.npmjs.com/package/@stdlib/stats-base-dnanstdevpn
333
+
334
+ [@stdlib/stats/base/nanstdevpn]: https://www.npmjs.com/package/@stdlib/stats-base-nanstdevpn
335
+
336
+ [@stdlib/stats/base/snanstdev]: https://www.npmjs.com/package/@stdlib/stats-base-snanstdev
337
+
338
+ [@stdlib/stats/base/snanvariancepn]: https://www.npmjs.com/package/@stdlib/stats-base-snanvariancepn
339
+
340
+ [@stdlib/stats/base/sstdevpn]: https://www.npmjs.com/package/@stdlib/stats-base-sstdevpn
341
+
342
+ <!-- </related-links> -->
343
+
292
344
  </section>
293
345
 
294
346
  <!-- /.links -->
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/stats-base-snanstdevpn",
3
- "version": "0.0.2",
3
+ "version": "0.0.6",
4
4
  "description": "Calculate the standard deviation of a single-precision floating-point strided array ignoring NaN values and using a two-pass algorithm.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -15,15 +15,15 @@
15
15
  ],
16
16
  "main": "./lib",
17
17
  "browser": "./lib/main.js",
18
- "gypfile": true,
18
+ "gypfile": false,
19
19
  "directories": {
20
20
  "benchmark": "./benchmark",
21
21
  "doc": "./docs",
22
22
  "example": "./examples",
23
23
  "include": "./include",
24
24
  "lib": "./lib",
25
- "test": "./test",
26
- "src": "./src"
25
+ "src": "./src",
26
+ "test": "./test"
27
27
  },
28
28
  "types": "./docs/types",
29
29
  "scripts": {
@@ -32,7 +32,7 @@
32
32
  "examples": "make examples",
33
33
  "benchmark": "make benchmark"
34
34
  },
35
- "homepage": "https://github.com/stdlib-js/stdlib",
35
+ "homepage": "https://stdlib.io",
36
36
  "repository": {
37
37
  "type": "git",
38
38
  "url": "git://github.com/stdlib-js/stats-base-snanstdevpn.git"
package/CHANGELOG.md DELETED
@@ -1,5 +0,0 @@
1
- # CHANGELOG
2
-
3
- > Package changelog.
4
-
5
- See [GitHub Releases](https://github.com/stdlib-js/stats-base-snanstdevpn/releases) for the changelog.
package/binding.gyp DELETED
@@ -1,170 +0,0 @@
1
- # @license Apache-2.0
2
- #
3
- # Copyright (c) 2020 The Stdlib Authors.
4
- #
5
- # Licensed under the Apache License, Version 2.0 (the "License");
6
- # you may not use this file except in compliance with the License.
7
- # You may obtain a copy of the License at
8
- #
9
- # http://www.apache.org/licenses/LICENSE-2.0
10
- #
11
- # Unless required by applicable law or agreed to in writing, software
12
- # distributed under the License is distributed on an "AS IS" BASIS,
13
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- # See the License for the specific language governing permissions and
15
- # limitations under the License.
16
-
17
- # A `.gyp` file for building a Node.js native add-on.
18
- #
19
- # [1]: https://gyp.gsrc.io/docs/InputFormatReference.md
20
- # [2]: https://gyp.gsrc.io/docs/UserDocumentation.md
21
- {
22
- # List of files to include in this file:
23
- 'includes': [
24
- './include.gypi',
25
- ],
26
-
27
- # Define variables to be used throughout the configuration for all targets:
28
- 'variables': {
29
- # Target name should match the add-on export name:
30
- 'addon_target_name%': 'addon',
31
-
32
- # Set variables based on the host OS:
33
- 'conditions': [
34
- [
35
- 'OS=="win"',
36
- {
37
- # Define the object file suffix:
38
- 'obj': 'obj',
39
- },
40
- {
41
- # Define the object file suffix:
42
- 'obj': 'o',
43
- }
44
- ], # end condition (OS=="win")
45
- ], # end conditions
46
- }, # end variables
47
-
48
- # Define compile targets:
49
- 'targets': [
50
-
51
- # Target to generate an add-on:
52
- {
53
- # The target name should match the add-on export name:
54
- 'target_name': '<(addon_target_name)',
55
-
56
- # Define dependencies:
57
- 'dependencies': [],
58
-
59
- # Define directories which contain relevant include headers:
60
- 'include_dirs': [
61
- # Local include directory:
62
- '<@(include_dirs)',
63
- ],
64
-
65
- # List of source files:
66
- 'sources': [
67
- '<@(src_files)',
68
- ],
69
-
70
- # Settings which should be applied when a target's object files are used as linker input:
71
- 'link_settings': {
72
- # Define libraries:
73
- 'libraries': [
74
- '<@(libraries)',
75
- ],
76
-
77
- # Define library directories:
78
- 'library_dirs': [
79
- '<@(library_dirs)',
80
- ],
81
- },
82
-
83
- # C/C++ compiler flags:
84
- 'cflags': [
85
- # Enable commonly used warning options:
86
- '-Wall',
87
-
88
- # Aggressive optimization:
89
- '-O3',
90
- ],
91
-
92
- # C specific compiler flags:
93
- 'cflags_c': [
94
- # Specify the C standard to which a program is expected to conform:
95
- '-std=c99',
96
- ],
97
-
98
- # C++ specific compiler flags:
99
- 'cflags_cpp': [
100
- # Specify the C++ standard to which a program is expected to conform:
101
- '-std=c++11',
102
- ],
103
-
104
- # Linker flags:
105
- 'ldflags': [],
106
-
107
- # Apply conditions based on the host OS:
108
- 'conditions': [
109
- [
110
- 'OS=="mac"',
111
- {
112
- # Linker flags:
113
- 'ldflags': [
114
- '-undefined dynamic_lookup',
115
- '-Wl,-no-pie',
116
- '-Wl,-search_paths_first',
117
- ],
118
- },
119
- ], # end condition (OS=="mac")
120
- [
121
- 'OS!="win"',
122
- {
123
- # C/C++ flags:
124
- 'cflags': [
125
- # Generate platform-independent code:
126
- '-fPIC',
127
- ],
128
- },
129
- ], # end condition (OS!="win")
130
- ], # end conditions
131
- }, # end target <(addon_target_name)
132
-
133
- # Target to copy a generated add-on to a standard location:
134
- {
135
- 'target_name': 'copy_addon',
136
-
137
- # Declare that the output of this target is not linked:
138
- 'type': 'none',
139
-
140
- # Define dependencies:
141
- 'dependencies': [
142
- # Require that the add-on be generated before building this target:
143
- '<(addon_target_name)',
144
- ],
145
-
146
- # Define a list of actions:
147
- 'actions': [
148
- {
149
- 'action_name': 'copy_addon',
150
- 'message': 'Copying addon...',
151
-
152
- # Explicitly list the inputs in the command-line invocation below:
153
- 'inputs': [],
154
-
155
- # Declare the expected outputs:
156
- 'outputs': [
157
- '<(addon_output_dir)/<(addon_target_name).node',
158
- ],
159
-
160
- # Define the command-line invocation:
161
- 'action': [
162
- 'cp',
163
- '<(PRODUCT_DIR)/<(addon_target_name).node',
164
- '<(addon_output_dir)/<(addon_target_name).node',
165
- ],
166
- },
167
- ], # end actions
168
- }, # end target copy_addon
169
- ], # end targets
170
- }