1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
{{alias}}( N, x, stride, clbk[, thisArg] )
Calculates the range of a strided array via a callback function, ignoring
`NaN` values.
The `N` and `stride` parameters determine which elements in `x` are accessed
at runtime.
Indexing is relative to the first index. To introduce an offset, use typed
array views.
If `N <= 0`, the function returns `x` unchanged.
The callback function is provided four arguments:
- value: array element
- aidx: array index
- sidx: strided index (offset + aidx*stride)
- array: the input array
The callback function should return a numeric value.
If the callback function returns `NaN`, the value is ignored.
If the callback function does not return any value (or equivalently,
explicitly returns `undefined`), the value is ignored.
Parameters
----------
N: integer
Number of indexed elements.
x: Array|TypedArray|Object
Input array/collection. If provided an object, the object must be array-
like (excluding strings and functions).
stride: integer
Index increment for `x`.
clbk: Function
Callback function.
thisArg: any (optional)
Execution context.
Returns
-------
out: number
Range.
Examples
--------
// Standard Usage:
> function accessor( v ) { return v * 2.0; };
> var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, NaN, -1.0, -3.0 ];
> {{alias}}( x.length, x, 1, accessor )
18.0
// Using `N` and `stride` parameters:
> x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0, 1.0 ];
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
> {{alias}}( N, x, 2, accessor )
14.0
// Using view offsets:
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
> {{alias}}( N, x1, 2, accessor )
8.0
{{alias}}.ndarray( N, x, stride, offset, clbk[, thisArg] )
Calculates the range of a strided array via a callback function, ignoring
`NaN` values and using alternative indexing semantics.
While typed array views mandate a view offset based on the underlying
buffer, the `offset` parameter supports indexing semantics based on a
starting index.
Parameters
----------
N: integer
Number of indexed elements.
x: Array|TypedArray|Object
Input array/collection. If provided an object, the object must be array-
like (excluding strings and functions).
stride: integer
Index increment for `x`.
offset: integer
Starting index of `x`.
clbk: Function
Callback function.
thisArg: any (optional)
Execution context.
Returns
-------
out: number
Range.
Examples
--------
// Standard Usage:
> function accessor( v ) { return v * 2.0; };
> var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, NaN, -1.0, -3.0 ];
> {{alias}}.ndarray( x.length, x, 1, 0, accessor )
18.0
// Using an index offset:
> x = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ];
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
> {{alias}}.ndarray( N, x, 2, 1, accessor )
8.0
See Also
--------
|
