Skip to content

Commit 277024e

Browse files
docs: enhance README for ssort2hp function to clarify sort order behavior
--- 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 b6dbcd6 commit 277024e

File tree

1 file changed

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

1 file changed

+1
-1
lines changed

lib/node_modules/@stdlib/blas/ext/base/ssort2hp/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ stdlib_strided_ssort2hp_ndarray( 4, 1.0f, x, 1, 0, y, 1, 0 );
254254
The function accepts the following arguments:
255255
256256
- **N**: `[in] CBLAS_INT` number of indexed elements.
257-
- **order**: `[in] float` sort order.
257+
- **order**: `[in] float` sort order. If `order < 0.0`, the input strided array `x` is sorted in **decreasing** order. If `order > 0.0`, the input strided array `x` is sorted in **increasing** order. If `order == 0.0`, the input strided arrays are left unchanged.
258258
- **X**: `[inout] float*` first input array.
259259
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
260260
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.

0 commit comments

Comments
 (0)