Skip to content

Commit d108c14

Browse files
committed
docs: update missing documentation
--- 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: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 134669c commit d108c14

File tree

2 files changed

+40
-1
lines changed

2 files changed

+40
-1
lines changed

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

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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/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)