Skip to content

Commit 5ff04ce

Browse files
committed
docs: update notes
--- 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: passed - 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 640d00d commit 5ff04ce

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

lib/node_modules/@stdlib/ndarray/ctor/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1632,7 +1632,7 @@ int64_t stdlib_ndarray_stride( const struct ndarray *arr, const int64_t i );
16321632

16331633
Notes:
16341634

1635-
- The function does perform bounds checking for the dimension index.
1635+
- The function does **not** perform bounds checking for the dimension index.
16361636

16371637
#### stdlib_ndarray_stride_elements( \*arr, i )
16381638

@@ -1675,7 +1675,8 @@ int64_t stdlib_ndarray_stride_elements( const struct ndarray *arr, const int64_t
16751675

16761676
Notes:
16771677

1678-
- The function does perform bounds checking for the dimension index.
1678+
- The function does **not** perform bounds checking for the dimension index.
1679+
- The function assumes that the ndarray is **aligned** (i.e., the stride in bytes is a multiple of the number of bytes per ndarray element).
16791680

16801681
#### stdlib_ndarray_strides( \*arr )
16811682

lib/node_modules/@stdlib/ndarray/ctor/src/main.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -433,6 +433,7 @@ int64_t stdlib_ndarray_stride( const struct ndarray *arr, const int64_t i ) {
433433
* ## Notes
434434
*
435435
* - The function does not perform any sanity checks.
436+
* - The function assumes that an ndarray is aligned (i.e., stride is a multiple of the number of bytes per ndarray element).
436437
*
437438
* @param arr input ndarray
438439
* @param i dimension index

0 commit comments

Comments
 (0)