Skip to content

Commit c4c4535

Browse files
committed
Auto-generated commit
1 parent 52d222e commit c4c4535

File tree

3 files changed

+42
-3
lines changed

3 files changed

+42
-3
lines changed

.editorconfig

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@ indent_style = tab
8686
[*.{f,f.txt}]
8787
indent_style = space
8888
indent_size = 2
89-
insert_final_newline = false
9089

9190
# Set properties for shell files:
9291
[*.{sh,sh.txt}]

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
<section class="release" id="unreleased">
66

7-
## Unreleased (2025-01-14)
7+
## Unreleased (2025-01-17)
88

99
<section class="features">
1010

@@ -32,6 +32,7 @@
3232

3333
<details>
3434

35+
- [`fd335df`](https://github.com/stdlib-js/stdlib/commit/fd335dfa566f1b68f4561474aedd775270fb9fad) - **docs:** fix grammar typo in `stats/base/*` [(#4780)](https://github.com/stdlib-js/stdlib/pull/4780) _(by Aayush Khanna, stdlib-bot)_
3536
- [`b00d9f1`](https://github.com/stdlib-js/stdlib/commit/b00d9f1064701187f48a05b9753e74ae835b0726) - **docs:** fix typing error in `repl.txt` of `stats/base/*` [(#4750)](https://github.com/stdlib-js/stdlib/pull/4750) _(by Aayush Khanna)_
3637
- [`859e486`](https://github.com/stdlib-js/stdlib/commit/859e4866f3eb237fbbfe4f156d52e429ae8ebe9d) - **docs:** update examples in `stats/base/scumaxabs` [(#4695)](https://github.com/stdlib-js/stdlib/pull/4695) _(by Aayush Khanna)_
3738
- [`0619690`](https://github.com/stdlib-js/stdlib/commit/0619690c1a69a402ba6315631506302f010d6404) - **feat:** add C ndarray interface and refactor implementation for `stats/base/scumaxabs` [(#4684)](https://github.com/stdlib-js/stdlib/pull/4684) _(by Aayush Khanna)_

README.md

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

144-
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
144+
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
145145

146146
```javascript
147147
var Float32Array = require( '@stdlib/array-float32' );
@@ -246,6 +246,45 @@ void stdlib_strided_scumaxabs( const CBLAS_INT N, const float *X, const CBLAS_IN
246246

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

249+
```c
250+
const float x[] = { 1.0f, 2.0f, -3.0f, 4.0f, -5.0f, 6.0f, 7.0f, 8.0f };
251+
float y[] = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f };
252+
253+
stdlib_strided_scumaxabs_ndarray( 4, x, 2, 0, y, -2, 0 );
254+
```
255+
256+
The function accepts the following arguments:
257+
258+
- **N**: `[in] CBLAS_INT` number of indexed elements.
259+
- **X**: `[in] float*` input array.
260+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
261+
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
262+
- **Y**: `[out] float*` output array.
263+
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
264+
- **offsetY**: `[in] CBLAS_INT` starting index for `Y`.
265+
266+
```c
267+
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 );
268+
```
269+
270+
</section>
271+
272+
<!-- /.usage -->
273+
274+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
275+
276+
<section class="notes">
277+
278+
</section>
279+
280+
<!-- /.notes -->
281+
282+
<!-- C API usage examples. -->
283+
284+
<section class="examples">
285+
286+
### Examples
287+
249288
```c
250289
#include "stdlib/stats/base/scumaxabs.h"
251290
#include <stdio.h>

0 commit comments

Comments
 (0)