Skip to content

Commit fd335df

Browse files
docs: fix grammar typo in stats/base/*
PR-URL: #4780 Reviewed-by: Athan Reines <[email protected]> Co-authored-by: stdlib-bot <[email protected]>
1 parent 421c4cf commit fd335df

File tree

9 files changed

+48
-9
lines changed

9 files changed

+48
-9
lines changed

lib/node_modules/@stdlib/stats/base/dcumax/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ The function has the following additional parameters:
108108
- **offsetX**: starting index for `x`.
109109
- **offsetY**: starting index for `y`.
110110

111-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on a starting indices. For example, to calculate the cumulative maximum of every other element in `x` starting from the second element and to store in the last `N` elements of `y` starting from the last element
111+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to calculate the cumulative maximum of every other element in `x` starting from the second element and to store in the last `N` elements of `y` starting from the last element
112112

113113
```javascript
114114
var Float64Array = require( '@stdlib/array/float64' );

lib/node_modules/@stdlib/stats/base/dcumaxabs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ The function has the following additional parameters:
110110
- **offsetX**: starting index for `x`.
111111
- **offsetY**: starting index for `y`.
112112

113-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on a starting indices. For example, to calculate the cumulative maximum absolute value of every other element in `x` starting from the second element and to store in the last `N` elements of `y` starting from the last element
113+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to calculate the cumulative maximum absolute value of every other element in `x` starting from the second element and to store in the last `N` elements of `y` starting from the last element
114114

115115
```javascript
116116
var Float64Array = require( '@stdlib/array/float64' );

lib/node_modules/@stdlib/stats/base/dcumin/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ The function has the following additional parameters:
110110
- **offsetX**: starting index for `x`.
111111
- **offsetY**: starting index for `y`.
112112

113-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on a starting indices. For example, to calculate the cumulative minimum of every other element in `x` starting from the second element and to store in the last `N` elements of `y` starting from the last element
113+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to calculate the cumulative minimum of every other element in `x` starting from the second element and to store in the last `N` elements of `y` starting from the last element
114114

115115
```javascript
116116
var Float64Array = require( '@stdlib/array/float64' );

lib/node_modules/@stdlib/stats/base/dcuminabs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ The function has the following additional parameters:
110110
- **offsetX**: starting index for `x`.
111111
- **offsetY**: starting index for `y`.
112112

113-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on a starting indices. For example, to calculate the cumulative minimum absolute value of every other element in `x` starting from the second element and to store in the last `N` elements of `y` starting from the last element
113+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to calculate the cumulative minimum absolute value of every other element in `x` starting from the second element and to store in the last `N` elements of `y` starting from the last element
114114

115115
```javascript
116116
var Float64Array = require( '@stdlib/array/float64' );

lib/node_modules/@stdlib/stats/base/scumax/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ The function has the following additional parameters:
110110
- **offsetX**: starting index for `x`.
111111
- **offsetY**: starting index for `y`.
112112

113-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on a starting indices. For example, to calculate the cumulative maximum of every other element in `x` starting from the second element and to store in the last `N` elements of `y` starting from the last element
113+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to calculate the cumulative maximum of every other element in `x` starting from the second element and to store in the last `N` elements of `y` starting from the last element
114114

115115
```javascript
116116
var Float32Array = require( '@stdlib/array/float32' );

lib/node_modules/@stdlib/stats/base/scumaxabs/README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ The function has the following additional parameters:
108108
- **offsetX**: starting index for `x`.
109109
- **offsetY**: starting index for `y`.
110110

111-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, offset parameters support indexing semantics based on a starting indices. For example, to calculate the cumulative maximum absolute value of every other element in `x` starting from the second element and to store in the last `N` elements of `y` starting from the last element
111+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, offset parameters support indexing semantics based on starting indices. For example, to calculate the cumulative maximum absolute value of every other element in `x` starting from the second element and to store in the last `N` elements of `y` starting from the last element
112112

113113
```javascript
114114
var Float32Array = require( '@stdlib/array/float32' );
@@ -213,6 +213,45 @@ void stdlib_strided_scumaxabs( const CBLAS_INT N, const float *X, const CBLAS_IN
213213

214214
Computes the cumulative maximum absolute value of single-precision floating-point strided array elements using alternative indexing semantics.
215215

216+
```c
217+
const float x[] = { 1.0f, 2.0f, -3.0f, 4.0f, -5.0f, 6.0f, 7.0f, 8.0f };
218+
float y[] = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f };
219+
220+
stdlib_strided_scumaxabs_ndarray( 4, x, 2, 0, y, -2, 0 );
221+
```
222+
223+
The function accepts the following arguments:
224+
225+
- **N**: `[in] CBLAS_INT` number of indexed elements.
226+
- **X**: `[in] float*` input array.
227+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
228+
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
229+
- **Y**: `[out] float*` output array.
230+
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
231+
- **offsetY**: `[in] CBLAS_INT` starting index for `Y`.
232+
233+
```c
234+
void stdlib_strided_scumaxabs_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY );
235+
```
236+
237+
</section>
238+
239+
<!-- /.usage -->
240+
241+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
242+
243+
<section class="notes">
244+
245+
</section>
246+
247+
<!-- /.notes -->
248+
249+
<!-- C API usage examples. -->
250+
251+
<section class="examples">
252+
253+
### Examples
254+
216255
```c
217256
#include "stdlib/stats/base/scumaxabs.h"
218257
#include <stdio.h>

lib/node_modules/@stdlib/stats/base/scumin/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ The function has the following additional parameters:
108108
- **offsetX**: starting index for `x`.
109109
- **offsetY**: starting index for `y`.
110110

111-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, offset parameters support indexing semantics based on a starting indices. For example, to calculate the cumulative minimum of every other element in `x` starting from the second element and to store in the last `N` elements of `y` starting from the last element
111+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, offset parameters support indexing semantics based on starting indices. For example, to calculate the cumulative minimum of every other element in `x` starting from the second element and to store in the last `N` elements of `y` starting from the last element
112112

113113
```javascript
114114
var Float32Array = require( '@stdlib/array/float32' );

lib/node_modules/@stdlib/stats/base/scuminabs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ The function has the following additional parameters:
108108
- **offsetX**: starting index for `x`.
109109
- **offsetY**: starting index for `y`.
110110

111-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, `offsetX` and `offsetY` parameters support indexing semantics based on a starting indices. For example, to calculate the cumulative minimum absolute value of every other value in `x` starting from the second value and to store in the last `N` elements of `y` starting from the last element
111+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, `offsetX` and `offsetY` parameters support indexing semantics based on starting indices. For example, to calculate the cumulative minimum absolute value of every other value in `x` starting from the second value and to store in the last `N` elements of `y` starting from the last element
112112

113113
```javascript
114114
var Float32Array = require( '@stdlib/array/float32' );

lib/node_modules/@stdlib/stats/base/sstdevtk/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ int main( void ) {
313313
// Specify the stride length:
314314
const int strideX = 2;
315315

316-
// Compute the variance:
316+
// Compute the standard deviation:
317317
float v = stdlib_strided_sstdevtk( N, 1.0f, x, strideX );
318318

319319
// Print the result:

0 commit comments

Comments
 (0)