|
1 | 1 |
|
2 | | -{{alias}}( N, x, strideX ) |
| 2 | +{{alias}}( N, x, stride ) |
3 | 3 | Computes the range of a strided array. |
4 | 4 |
|
5 | | - The `N` and stride parameters determine which elements in the strided |
6 | | - array are accessed at runtime. |
| 5 | + The `N` and `stride` parameters determine which elements in `x` are |
| 6 | + accessed at runtime. |
7 | 7 |
|
8 | 8 | Indexing is relative to the first index. To introduce an offset, use a |
9 | 9 | typed array view. |
|
15 | 15 | N: integer |
16 | 16 | Number of indexed elements. |
17 | 17 |
|
18 | | - x: Array<number> | TypedArray |
| 18 | + x: Array<number>|TypedArray |
19 | 19 | Input array. |
20 | 20 |
|
21 | | - strideX: integer |
22 | | - Stride length. |
| 21 | + stride: integer |
| 22 | + Index increment. |
23 | 23 |
|
24 | 24 | Returns |
25 | 25 | ------- |
|
33 | 33 | > {{alias}}( x.length, x, 1 ) |
34 | 34 | 4.0 |
35 | 35 |
|
36 | | - // Using `N` and stride parameters: |
| 36 | + // Using `N` and `stride` parameters: |
37 | 37 | > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ]; |
| 38 | + > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); |
38 | 39 | > var stride = 2; |
39 | | - > {{alias}}( 3, x, stride ) |
| 40 | + > {{alias}}( N, x, stride ) |
40 | 41 | 4.0 |
41 | 42 |
|
42 | | - // Handling `N <= 0` case: |
43 | | - > x = [ 1.0, -2.0, 2.0 ]; |
44 | | - > {{alias}}( 0, x, 1 ) |
45 | | - NaN |
46 | | - |
47 | 43 | // Using view offsets: |
48 | | - > var x0 = new ({{alias:@stdlib/array/float64}}) |
| 44 | + > var x0 = new {{alias:@stdlib/array/float64}} |
49 | 45 | ( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] ); |
50 | | - > var x1 = new ({{alias:@stdlib/array/float64}}) |
51 | | - ( x0.buffer, x0.BYTES_PER_ELEMENT * 1 ); |
| 46 | + > var x1 = new {{alias:@stdlib/array/float64}} |
| 47 | + ( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); |
| 48 | + > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 ); |
52 | 49 | > stride = 2; |
53 | | - > {{alias}}( 3, x1, stride ) |
| 50 | + > {{alias}}( N, x1, stride ) |
54 | 51 | 4.0 |
55 | 52 |
|
56 | | - |
57 | | -{{alias}}.ndarray( N, x, strideX, offsetX ) |
58 | | - Computes the range of a strided array using alternative indexing |
59 | | - semantics. |
| 53 | +{{alias}}.ndarray( N, x, stride, offset ) |
| 54 | + Computes the range of a strided array using alternative indexing semantics. |
60 | 55 |
|
61 | 56 | While typed array views mandate a view offset based on the underlying |
62 | 57 | buffer, the `offset` parameter supports indexing semantics based on a |
|
67 | 62 | N: integer |
68 | 63 | Number of indexed elements. |
69 | 64 |
|
70 | | - x: Array<number> | TypedArray |
| 65 | + x: Array<number>|TypedArray |
71 | 66 | Input array. |
72 | 67 |
|
73 | | - strideX: integer |
74 | | - Stride length. |
| 68 | + stride: integer |
| 69 | + Index increment. |
75 | 70 |
|
76 | | - offsetX: integer |
| 71 | + offset: integer |
77 | 72 | Starting index. |
78 | 73 |
|
79 | 74 | Returns |
|
90 | 85 |
|
91 | 86 | // Using offset parameter: |
92 | 87 | > var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ]; |
93 | | - > {{alias}}.ndarray( 3, x, 2, 1 ) |
| 88 | + > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); |
| 89 | + > {{alias}}.ndarray( N, x, 2, 1 ) |
94 | 90 | 4.0 |
95 | 91 |
|
96 | | - // Handling `N <= 0` case: |
97 | | - > x = [ 1.0, -2.0, 2.0 ]; |
98 | | - > {{alias}}.ndarray( 0, x, 1, 0 ) |
99 | | - NaN |
100 | | - |
101 | 92 | See Also |
102 | | - -------- |
| 93 | + -------- |
0 commit comments