From bc1a9d3df24dcaebdc9b58e4b0c4209163569ee4 Mon Sep 17 00:00:00 2001
From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
Date: Fri, 21 Mar 2025 02:29:06 +0000
Subject: [PATCH 1/2] docs: update related packages sections
---
.../@stdlib/blas/ext/base/ssort2ins/README.md | 131 ------------------
1 file changed, 131 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 interface documentation. -->
-
-<section class="c">
-
-## C APIs
-
-<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
-
-<section class="intro">
-
-</section>
-
-<!-- /.intro -->
-
-<!-- C usage documentation. -->
-
-<section class="usage">
-
-### 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 );
-```
-
-<!--lint disable maximum-heading-length-->
-
-#### stdlib_strided_ssort2ins_ndarray( N, order, \*X, strideX, offsetX, \*Y, strideY, offsetY )
-
-<!--lint enable maximum-heading-length-->
-
-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 );
-```
-
-</section>
-
-<!-- /.usage -->
-
-<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
-
-<section class="notes">
-
-</section>
-
-<!-- /.notes -->
-
-<!-- C API usage examples. -->
-
-<section class="examples">
-
-### Examples
-
-```c
-#include "stdlib/blas/ext/base/ssort2ins.h"
-#include <stdio.h>
-
-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 ] );
- }
-}
-```
-
-</section>
-
-<!-- /.examples -->
-
-</section>
-
-<!-- /.c -->
-
## See Also
- <span class="package-name">[`@stdlib/blas/ext/base/dsort2ins`][@stdlib/blas/ext/base/dsort2ins]</span><span class="delimiter">: </span><span class="description">simultaneously sort two double-precision floating-point strided arrays based on the sort order of the first array using insertion sort.</span>
From 3ef288fa9fc4e3d4c495d850881a9e9fb4ae5516 Mon Sep 17 00:00:00 2001
From: Athan <kgryte@gmail.com>
Date: Fri, 21 Mar 2025 02:34:45 -0700
Subject: [PATCH 2/2] 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 interface documentation. -->
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### 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 );
+```
+
+<!--lint disable maximum-heading-length-->
+
+#### stdlib_strided_ssort2ins_ndarray( N, order, \*X, strideX, offsetX, \*Y, strideY, offsetY )
+
+<!--lint enable maximum-heading-length-->
+
+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 );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/blas/ext/base/ssort2ins.h"
+#include <stdio.h>
+
+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 ] );
+ }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
## See Also
- <span class="package-name">[`@stdlib/blas/ext/base/dsort2ins`][@stdlib/blas/ext/base/dsort2ins]</span><span class="delimiter">: </span><span class="description">simultaneously sort two double-precision floating-point strided arrays based on the sort order of the first array using insertion sort.</span>