Skip to content

Commit 7546cdf

Browse files
gururaj1512gururaj1512
committed
feat: add stats/strided/sdsnanmeanors
Ref: #4797 --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - task: lint_c_examples status: missing_dependencies - task: lint_c_benchmarks status: missing_dependencies - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent 9cf630c commit 7546cdf

34 files changed

+3576
-0
lines changed

‎lib/node_modules/@stdlib/stats/strided/sdsnanmeanors/README.md‎

Lines changed: 310 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,310 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2020 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# sdsnanmeanors
22+
23+
> Calculate the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array, ignoring `NaN` values and using ordinary recursive summation with extended accumulation.
24+
25+
<section class="intro">
26+
27+
The [arithmetic mean][arithmetic-mean] is defined as
28+
29+
<!-- <equation class="equation" label="eq:arithmetic_mean" align="center" raw="\mu = \frac{1}{n} \sum_{i=0}^{n-1} x_i" alt="Equation for the arithmetic mean."> -->
30+
31+
```math
32+
\mu = \frac{1}{n} \sum_{i=0}^{n-1} x_i
33+
```
34+
35+
<!-- <div class="equation" align="center" data-raw-text="\mu = \frac{1}{n} \sum_{i=0}^{n-1} x_i" data-equation="eq:arithmetic_mean">
36+
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@82c213aa9e50a526a211738bd131d252b5c9db6d/lib/node_modules/@stdlib/stats/strided/sdsnanmeanors/docs/img/equation_arithmetic_mean.svg" alt="Equation for the arithmetic mean.">
37+
<br>
38+
</div> -->
39+
40+
<!-- </equation> -->
41+
42+
</section>
43+
44+
<!-- /.intro -->
45+
46+
<section class="usage">
47+
48+
## Usage
49+
50+
```javascript
51+
var sdsnanmeanors = require( '@stdlib/stats/strided/sdsnanmeanors' );
52+
```
53+
54+
#### sdsnanmeanors( N, x, strideX )
55+
56+
Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array, ignoring `NaN` values and using ordinary recursive summation with extended accumulation.
57+
58+
```javascript
59+
var Float32Array = require( '@stdlib/array/float32' );
60+
61+
var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );
62+
63+
var v = sdsnanmeanors( x.length, x, 1 );
64+
// returns ~0.3333
65+
```
66+
67+
The function has the following parameters:
68+
69+
- **N**: number of indexed elements.
70+
- **x**: input [`Float32Array`][@stdlib/array/float32].
71+
- **strideX**: stride length for `x`.
72+
73+
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the [arithmetic mean][arithmetic-mean] of every other element in `x`,
74+
75+
```javascript
76+
var Float32Array = require( '@stdlib/array/float32' );
77+
78+
var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN ] );
79+
80+
var v = sdsnanmeanors( 5, x, 2 );
81+
// returns 1.25
82+
```
83+
84+
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
85+
86+
<!-- eslint-disable stdlib/capitalized-comments -->
87+
88+
```javascript
89+
var Float32Array = require( '@stdlib/array/float32' );
90+
91+
var x0 = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );
92+
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
93+
94+
var v = sdsnanmeanors( 4, x1, 2 );
95+
// returns 1.25
96+
```
97+
98+
#### sdsnanmeanors.ndarray( N, x, strideX, offsetX )
99+
100+
Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array, ignoring `NaN` values and using ordinary recursive summation with extended accumulation and alternative indexing semantics.
101+
102+
```javascript
103+
var Float32Array = require( '@stdlib/array/float32' );
104+
105+
var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );
106+
107+
var v = sdsnanmeanors.ndarray( x.length, x, 1, 0 );
108+
// returns ~0.33333
109+
```
110+
111+
The function has the following additional parameters:
112+
113+
- **offsetX**: starting index for `x`.
114+
115+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the [arithmetic mean][arithmetic-mean] for every other element in `x` starting from the second element
116+
117+
```javascript
118+
var Float32Array = require( '@stdlib/array/float32' );
119+
120+
var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );
121+
122+
var v = sdsnanmeanors.ndarray( 4, x, 2, 1 );
123+
// returns 1.25
124+
```
125+
126+
</section>
127+
128+
<!-- /.usage -->
129+
130+
<section class="notes">
131+
132+
## Notes
133+
134+
- If `N <= 0`, both functions return `NaN`.
135+
- If every indexed element is `NaN`, both functions return `NaN`.
136+
- Accumulated intermediate values are stored as double-precision floating-point numbers.
137+
138+
</section>
139+
140+
<!-- /.notes -->
141+
142+
<section class="examples">
143+
144+
## Examples
145+
146+
<!-- eslint no-undef: "error" -->
147+
148+
```javascript
149+
var uniform = require( '@stdlib/random/base/uniform' );
150+
var filledarrayBy = require( '@stdlib/array/filled-by' );
151+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
152+
var sdsnanmeanors = require( '@stdlib/stats/strided/sdsnanmeanors' );
153+
154+
function rand() {
155+
if ( bernoulli( 0.8 ) < 1 ) {
156+
return NaN;
157+
}
158+
return uniform( -50.0, 50.0 );
159+
}
160+
161+
var x = filledarrayBy( 10, 'float32', rand );
162+
console.log( x );
163+
164+
var v = sdsnanmeanors( x.length, x, 1 );
165+
console.log( v );
166+
```
167+
168+
</section>
169+
170+
<!-- /.examples -->
171+
172+
<!-- C usage documentation. -->
173+
174+
* * *
175+
176+
<section class="usage">
177+
178+
### Usage
179+
180+
```c
181+
#include "stdlib/stats/strided/sdsnanmeanors.h"
182+
```
183+
184+
#### stdlib_strided_sdsnanmeanors( N, \*X, strideX )
185+
186+
Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array, ignoring `NaN` values and using ordinary recursive summation with extended accumulation.
187+
188+
```c
189+
const float x[] = { 1.0f, -2.0f, 0.0f/0.0f, 2.0f };
190+
191+
float v = stdlib_strided_sdsnanmeanors( x.length, x, 1 );
192+
// returns ~0.3333f
193+
```
194+
195+
The function accepts the following arguments:
196+
197+
- **N**: `[in] CBLAS_INT` number of indexed elements.
198+
- **X**: `[in] float*` input array.
199+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
200+
201+
```c
202+
float stdlib_strided_sdsnanmeanors( const CBLAS_INT N, const float *X, const CBLAS_INT strideX );
203+
```
204+
205+
#### stdlib_strided_sdsnanmeanors_ndarray( N, \*X, strideX, offsetX )
206+
207+
Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array, ignoring `NaN` values and using ordinary recursive summation with extended accumulation and alternative indexing semantics.
208+
209+
```c
210+
const float x[] = { 1.0f, -2.0f, 0.0f/0.0f, 2.0f };
211+
212+
float v = stdlib_strided_sdsnanmeanors_ndarray( x.length, x, 1, 0 );
213+
// returns ~0.3333f
214+
```
215+
216+
The function accepts the following arguments:
217+
218+
- **N**: `[in] CBLAS_INT` number of indexed elements.
219+
- **X**: `[in] float*` input array.
220+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
221+
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
222+
223+
```c
224+
float stdlib_strided_sdsnanmeanors_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
225+
```
226+
227+
</section>
228+
229+
<!-- /.usage -->
230+
231+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
232+
233+
<section class="notes">
234+
235+
</section>
236+
237+
<!-- /.notes -->
238+
239+
<!-- C API usage examples. -->
240+
241+
<section class="examples">
242+
243+
### Examples
244+
245+
```c
246+
#include "stdlib/stats/strided/sdsnanmeanors.h"
247+
#include <stdio.h>
248+
249+
int main( void ) {
250+
// Create a strided array:
251+
const float x[] = { 1.0f, 2.0f, 0.0f/0.0f, 3.0f, 0.0f/0.0f, 4.0f, 5.0f, 6.0f, 0.0f/0.0f, 7.0f, 8.0f, 0.0f/0.0f };
252+
253+
// Specify the number of elements:
254+
const int N = 6;
255+
256+
// Specify the stride length:
257+
const int strideX = 2;
258+
259+
// Compute the arithmetic mean:
260+
float v = stdlib_strided_sdsnanmeanors( N, x, strideX );
261+
262+
// Print the result:
263+
printf( "mean: %f\n", v );
264+
}
265+
```
266+
267+
</section>
268+
269+
<!-- /.examples -->
270+
271+
</section>
272+
273+
<!-- /.c -->
274+
275+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
276+
277+
<section class="related">
278+
279+
* * *
280+
281+
## See Also
282+
283+
- <span class="package-name">[`@stdlib/stats/strided/sdsmeanors`][@stdlib/stats/strided/sdsmeanors]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a single-precision floating-point strided array using ordinary recursive summation with extended accumulation.</span>
284+
- <span class="package-name">[`@stdlib/stats/base/sdsnanmean`][@stdlib/stats/base/sdsnanmean]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a single-precision floating-point strided array, ignoring NaN values and using extended accumulation.</span>
285+
286+
</section>
287+
288+
<!-- /.related -->
289+
290+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
291+
292+
<section class="links">
293+
294+
[arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean
295+
296+
[@stdlib/array/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float32
297+
298+
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
299+
300+
<!-- <related-links> -->
301+
302+
[@stdlib/stats/strided/sdsmeanors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/sdsmeanors
303+
304+
[@stdlib/stats/base/sdsnanmean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/sdsnanmean
305+
306+
<!-- </related-links> -->
307+
308+
</section>
309+
310+
<!-- /.links -->

0 commit comments

Comments
 (0)