Skip to content

Commit 6c79b2f

Browse files
committed
docs: update note
--- 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 74fd8e4 commit 6c79b2f

File tree

1 file changed

+1
-1
lines changed
  • lib/node_modules/@stdlib/blas/ext/cusum

1 file changed

+1
-1
lines changed

lib/node_modules/@stdlib/blas/ext/cusum/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ The method accepts the following options:
172172
## Notes
173173

174174
- Both functions iterate over [ndarray][@stdlib/ndarray/ctor] elements according to the memory layout of the input [ndarray][@stdlib/ndarray/ctor]. Accordingly, performance degradation is possible when operating over multiple dimensions of a large non-contiguous multi-dimensional input [ndarray][@stdlib/ndarray/ctor]. In such scenarios, one may want to copy an input [ndarray][@stdlib/ndarray/ctor] to contiguous memory before computing the cumulative sum.
175-
- The output data type [policy][@stdlib/ndarray/output-dtype-policies] only applies to the main function and specifies that, by default, in order to avoid issues arising from integer overflow, the function must return an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] amenable to accumulation. This means that, for integer data types having small value ranges (e.g., `int8`, `uint8`, etc), the main function returns an [ndarray][@stdlib/ndarray/ctor] having at least a 32-bit integer data type. By default, if an input [ndarray][@stdlib/ndarray/ctor] has a floating-point data type, the main function returns an [ndarray][@stdlib/ndarray/ctor] having the same data type. For the `assign` method, the output [ndarray][@stdlib/ndarray/ctor] is allowed to have any [data type][@stdlib/ndarray/dtypes].
175+
- The output data type [policy][@stdlib/ndarray/output-dtype-policies] only applies to the main function and specifies that, by default, in order to avoid issues arising from integer overflow, the function must return an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] amenable to accumulation. This means that, for integer data types having small value ranges (e.g., `int8`, `uint8`, etc), the main function returns an [ndarray][@stdlib/ndarray/ctor] having at least a 32-bit integer data type. By default, if an input [ndarray][@stdlib/ndarray/ctor] has a floating-point data type, the main function returns an [ndarray][@stdlib/ndarray/ctor] having the same data type. For the `assign` method, the output [ndarray][@stdlib/ndarray/ctor] is allowed to have any supported output [data type][@stdlib/ndarray/dtypes].
176176

177177
</section>
178178

0 commit comments

Comments
 (0)