Skip to content

Commit 5d88af6

Browse files
docs: improve clarity in README and documentation for ssort2hp function
--- 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: passed - 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: passed - task: lint_c_benchmarks status: passed - 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 73de076 commit 5d88af6

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -227,9 +227,9 @@ The function accepts the following arguments:
227227
228228
- **N**: `[in] CBLAS_INT` number of indexed elements.
229229
- **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.
230-
- **X**: `[inout] float*` input array.
230+
- **X**: `[inout] float*` first input array.
231231
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
232-
- **Y**: `[inout] float*` input array.
232+
- **Y**: `[inout] float*` second input array.
233233
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
234234
235235
```c
@@ -255,10 +255,10 @@ The function accepts the following arguments:
255255
256256
- **N**: `[in] CBLAS_INT` number of indexed elements.
257257
- **order**: `[in] float` sort order.
258-
- **X**: `[inout] float*` input array.
258+
- **X**: `[inout] float*` first input array.
259259
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
260260
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
261-
- **Y**: `[inout] float*` input array.
261+
- **Y**: `[inout] float*` second input array.
262262
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
263263
- **offsetY**: `[in] CBLAS_INT` starting index for `Y`.
264264
@@ -306,7 +306,7 @@ int main( void ) {
306306
// Print the result:
307307
for ( int i = 0; i < 8; i++ ) {
308308
printf( "x[ %i ] = %f\n", i, x[ i ] );
309-
printf( "y[ %i ] = %lf\n", i, y[ i ] );
309+
printf( "y[ %i ] = %f\n", i, y[ i ] );
310310
}
311311
}
312312
```

lib/node_modules/@stdlib/blas/ext/base/ssort2hp/benchmark/c/benchmark.unsorted_random.length.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,8 @@ static double benchmark2( int iterations, int len ) {
138138
float *y;
139139
int i;
140140

141-
x = (float *)malloc( len * sizeof(float) );
142-
y = (float *)malloc( len * sizeof(float) );
141+
x = ( float * )malloc( len * sizeof(float) );
142+
y = ( float * )malloc( len * sizeof(float) );
143143
for ( i = 0; i < len; i++ ) {
144144
x[ i ] = ( rand_float()*20.0f ) - 10.0f;
145145
y[ i ] = ( rand_float()*20.0f ) - 10.0f;

lib/node_modules/@stdlib/blas/ext/base/ssort2hp/docs/repl.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@
110110
Stride length for `x`.
111111

112112
offsetX: integer
113-
Starting index of `x`.
113+
Starting index for `x`.
114114

115115
y: Float32Array
116116
Second input array.
@@ -119,7 +119,7 @@
119119
Stride length for `y`.
120120

121121
offsetY: integer
122-
Starting index of `y`.
122+
Starting index for `y`.
123123

124124
Returns
125125
-------

lib/node_modules/@stdlib/blas/ext/base/ssort2hp/examples/c/example.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,6 @@ int main( void ) {
3737
// Print the result:
3838
for ( int i = 0; i < 8; i++ ) {
3939
printf( "x[ %i ] = %f\n", i, x[ i ] );
40-
printf( "y[ %i ] = %lf\n", i, y[ i ] );
40+
printf( "y[ %i ] = %f\n", i, y[ i ] );
4141
}
4242
}

lib/node_modules/@stdlib/blas/ext/base/ssort2hp/src/main.c

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@
3838
* @param N number of indexed elements
3939
* @param order sort order
4040
* @param X first input array
41-
* @param strideX stride length for `x`
41+
* @param strideX stride length for `X`
4242
* @param Y second input array
43-
* @param strideY stride length for `y`
43+
* @param strideY stride length for `Y`
4444
*/
4545
void API_SUFFIX(stdlib_strided_ssort2hp)( const CBLAS_INT N, const float order, float *X, const CBLAS_INT strideX, float *Y, const CBLAS_INT strideY ) {
4646
CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX );
@@ -55,11 +55,11 @@ void API_SUFFIX(stdlib_strided_ssort2hp)( const CBLAS_INT N, const float order,
5555
* @param N number of indexed elements
5656
* @param order sort order
5757
* @param X first input array
58-
* @param strideX stride length for `x`
59-
* @param offsetX starting index for `x`
58+
* @param strideX stride length for `X`
59+
* @param offsetX starting index for `X`
6060
* @param Y second input array
61-
* @param strideY stride length for `y`
62-
* @param offsetY starting index for `y`
61+
* @param strideY stride length for `Y`
62+
* @param offsetY starting index for `Y`
6363
*/
6464
void API_SUFFIX(stdlib_strided_ssort2hp_ndarray)( const CBLAS_INT N, const float order, float *X, CBLAS_INT strideX, CBLAS_INT offsetX, float *Y, CBLAS_INT strideY, CBLAS_INT offsetY ) {
6565
CBLAS_INT parent;

0 commit comments

Comments
 (0)