From cefe61c401e012a05ae4835aee5729d697ef9cfd Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Wed, 11 Jun 2025 02:33:35 +0000 Subject: [PATCH 1/4] docs: update related packages sections --- .../@stdlib/blas/ext/base/ssort2ins/README.md | 131 ------------------ .../@stdlib/stats/strided/nanmax-by/README.md | 10 -- 2 files changed, 141 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ssort2ins/README.md b/lib/node_modules/@stdlib/blas/ext/base/ssort2ins/README.md index 78476fc5da7f..6f891c574113 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ssort2ins/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ssort2ins/README.md @@ -193,137 +193,6 @@ console.log( y ); * * * - - -
- -## C APIs - - - -
- -
- - - - - -
- -### Usage - -```c -#include "stdlib/blas/ext/base/ssort2ins.h" -``` - -#### stdlib_strided_ssort2ins( N, order, \*X, strideX, \*Y, strideY ) - -Simultaneously sorts two single-precision floating-point strided arrays based on the sort order of the first array using insertion sort. - -```c -float x[] = { 1.0f, -2.0f, 3.0f, -4.0f }; -float y[] = { 0.0f, 1.0f, 2.0f, 3.0f }; - -stdlib_strided_ssort2ins( 4, 1.0f, x, 1, y, 1 ); -``` - -The function accepts the following arguments: - -- **N**: `[in] CBLAS_INT` number of indexed elements. -- **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. -- **X**: `[inout] float*` first input array. -- **strideX**: `[in] CBLAS_INT` stride length for `X`. -- **Y**: `[inout] float*` second input array. -- **strideY**: `[in] CBLAS_INT` stride length for `Y`. - -```c -stdlib_strided_ssort2ins( const CBLAS_INT N, const float order, float *X, const CBLAS_INT strideX, float *Y, const CBLAS_INT strideY ); -``` - - - -#### stdlib_strided_ssort2ins_ndarray( N, order, \*X, strideX, offsetX, \*Y, strideY, offsetY ) - - - -Simultaneously sorts two single-precision floating-point strided arrays based on the sort order of the first array using insertion sort and alternative indexing semantics. - -```c -float x[] = { 1.0f, -2.0f, 3.0f, -4.0f }; -float y[] = { 0.0f, 1.0f, 2.0f, 3.0f }; - -stdlib_strided_ssort2ins_ndarray( 4, 1.0f, x, 1, 0, y, 1, 0 ); -``` - -The function accepts the following arguments: - -- **N**: `[in] CBLAS_INT` number of indexed elements. -- **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. -- **X**: `[inout] float*` first input array. -- **strideX**: `[in] CBLAS_INT` stride length for `X`. -- **offsetX**: `[in] CBLAS_INT` starting index for `X`. -- **Y**: `[inout] float*` second input array. -- **strideY**: `[in] CBLAS_INT` stride length for `Y`. -- **offsetY**: `[in] CBLAS_INT` starting index for `Y`. - -```c -stdlib_strided_ssort2ins_ndarray( const CBLAS_INT N, const float order, float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY ); -``` - -
- - - - - -
- -
- - - - - -
- -### Examples - -```c -#include "stdlib/blas/ext/base/ssort2ins.h" -#include - -int main( void ) { - // Create strided arrays: - float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f }; - float y[] = { 0.0f, 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f }; - - // Specify the number of elements: - int N = 8; - - // Specify the strides: - int strideX = 1; - int strideY = 1; - - // Sort the arrays: - stdlib_strided_ssort2ins( N, 1.0f, x, strideX, y, strideY ); - - // Print the result: - for ( int i = 0; i < 8; i++ ) { - printf( "x[ %i ] = %f\n", i, x[ i ] ); - printf( "y[ %i ] = %f\n", i, y[ i ] ); - } -} -``` - -
- - - -
- - - ## See Also - [`@stdlib/blas/ext/base/dsort2ins`][@stdlib/blas/ext/base/dsort2ins]: simultaneously sort two double-precision floating-point strided arrays based on the sort order of the first array using insertion sort. diff --git a/lib/node_modules/@stdlib/stats/strided/nanmax-by/README.md b/lib/node_modules/@stdlib/stats/strided/nanmax-by/README.md index dfbc5a5d57ca..cf32ced751d5 100644 --- a/lib/node_modules/@stdlib/stats/strided/nanmax-by/README.md +++ b/lib/node_modules/@stdlib/stats/strided/nanmax-by/README.md @@ -229,16 +229,6 @@ console.log( v ); -[@stdlib/stats/strided/dnanmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmax - -[@stdlib/stats/strided/max-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/max-by - -[@stdlib/stats/strided/nanmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanmax - -[@stdlib/stats/strided/nanmin-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanmin-by - -[@stdlib/stats/strided/snanmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/snanmax - From 563241276b67650bd276d15f6194041720b84504 Mon Sep 17 00:00:00 2001 From: Athan Date: Tue, 10 Jun 2025 23:34:06 -0700 Subject: [PATCH 2/4] Discard changes to lib/node_modules/@stdlib/blas/ext/base/ssort2ins/README.md --- .../@stdlib/blas/ext/base/ssort2ins/README.md | 131 ++++++++++++++++++ 1 file changed, 131 insertions(+) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ssort2ins/README.md b/lib/node_modules/@stdlib/blas/ext/base/ssort2ins/README.md index 6f891c574113..78476fc5da7f 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ssort2ins/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ssort2ins/README.md @@ -193,6 +193,137 @@ console.log( y ); * * * + + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/ssort2ins.h" +``` + +#### stdlib_strided_ssort2ins( N, order, \*X, strideX, \*Y, strideY ) + +Simultaneously sorts two single-precision floating-point strided arrays based on the sort order of the first array using insertion sort. + +```c +float x[] = { 1.0f, -2.0f, 3.0f, -4.0f }; +float y[] = { 0.0f, 1.0f, 2.0f, 3.0f }; + +stdlib_strided_ssort2ins( 4, 1.0f, x, 1, y, 1 ); +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **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. +- **X**: `[inout] float*` first input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **Y**: `[inout] float*` second input array. +- **strideY**: `[in] CBLAS_INT` stride length for `Y`. + +```c +stdlib_strided_ssort2ins( const CBLAS_INT N, const float order, float *X, const CBLAS_INT strideX, float *Y, const CBLAS_INT strideY ); +``` + + + +#### stdlib_strided_ssort2ins_ndarray( N, order, \*X, strideX, offsetX, \*Y, strideY, offsetY ) + + + +Simultaneously sorts two single-precision floating-point strided arrays based on the sort order of the first array using insertion sort and alternative indexing semantics. + +```c +float x[] = { 1.0f, -2.0f, 3.0f, -4.0f }; +float y[] = { 0.0f, 1.0f, 2.0f, 3.0f }; + +stdlib_strided_ssort2ins_ndarray( 4, 1.0f, x, 1, 0, y, 1, 0 ); +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **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. +- **X**: `[inout] float*` first input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. +- **Y**: `[inout] float*` second input array. +- **strideY**: `[in] CBLAS_INT` stride length for `Y`. +- **offsetY**: `[in] CBLAS_INT` starting index for `Y`. + +```c +stdlib_strided_ssort2ins_ndarray( const CBLAS_INT N, const float order, float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/ssort2ins.h" +#include + +int main( void ) { + // Create strided arrays: + float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f }; + float y[] = { 0.0f, 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f }; + + // Specify the number of elements: + int N = 8; + + // Specify the strides: + int strideX = 1; + int strideY = 1; + + // Sort the arrays: + stdlib_strided_ssort2ins( N, 1.0f, x, strideX, y, strideY ); + + // Print the result: + for ( int i = 0; i < 8; i++ ) { + printf( "x[ %i ] = %f\n", i, x[ i ] ); + printf( "y[ %i ] = %f\n", i, y[ i ] ); + } +} +``` + +
+ + + +
+ + + ## See Also - [`@stdlib/blas/ext/base/dsort2ins`][@stdlib/blas/ext/base/dsort2ins]: simultaneously sort two double-precision floating-point strided arrays based on the sort order of the first array using insertion sort. From 471b18f8c6b713d212e3906f5db832f988f5d19b Mon Sep 17 00:00:00 2001 From: Athan Date: Tue, 10 Jun 2025 23:35:09 -0700 Subject: [PATCH 3/4] docs: remove related packages Signed-off-by: Athan --- .../@stdlib/stats/strided/nanmax-by/README.md | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/strided/nanmax-by/README.md b/lib/node_modules/@stdlib/stats/strided/nanmax-by/README.md index cf32ced751d5..b7e32b8b5343 100644 --- a/lib/node_modules/@stdlib/stats/strided/nanmax-by/README.md +++ b/lib/node_modules/@stdlib/stats/strided/nanmax-by/README.md @@ -203,16 +203,6 @@ console.log( v );
-* * * - -## See Also - -- [`@stdlib/stats/strided/dnanmax`][@stdlib/stats/strided/dnanmax]: calculate the maximum value of a double-precision floating-point strided array, ignoring NaN values. -- [`@stdlib/stats/strided/max-by`][@stdlib/stats/strided/max-by]: calculate the maximum value of a strided array via a callback function. -- [`@stdlib/stats/strided/nanmax`][@stdlib/stats/strided/nanmax]: calculate the maximum value of a strided array, ignoring NaN values. -- [`@stdlib/stats/strided/nanmin-by`][@stdlib/stats/strided/nanmin-by]: calculate the minimum value of a strided array via a callback function, ignoring NaN values. -- [`@stdlib/stats/strided/snanmax`][@stdlib/stats/strided/snanmax]: calculate the maximum value of a single-precision floating-point strided array, ignoring NaN values. -
@@ -227,10 +217,6 @@ console.log( v ); [@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor - - - - From ec06d41b62c8738e61562ea9aedd58baebcec353 Mon Sep 17 00:00:00 2001 From: Athan Date: Tue, 10 Jun 2025 23:41:09 -0700 Subject: [PATCH 4/4] docs: fix missing definitions Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/strided/nanmax-by/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/strided/nanmax-by/README.md b/lib/node_modules/@stdlib/stats/strided/nanmax-by/README.md index b7e32b8b5343..ec4b9803d1d7 100644 --- a/lib/node_modules/@stdlib/stats/strided/nanmax-by/README.md +++ b/lib/node_modules/@stdlib/stats/strided/nanmax-by/README.md @@ -217,6 +217,12 @@ console.log( v ); [@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor +[@stdlib/stats/strided/dnanmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmax + +[@stdlib/stats/strided/nanmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanmax + +[@stdlib/stats/strided/snanmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/snanmax +