From 51e520423c7c2ebeac8ff319d00cc0cc9495c05c Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Mon, 14 Jul 2025 02:41:35 +0000 Subject: [PATCH 1/2] docs: update related packages sections --- .../@stdlib/blas/ext/base/ssort2ins/README.md | 131 ------------------ .../base/dists/gumbel/quantile/README.md | 1 - .../@stdlib/utils/some-own-by/README.md | 4 +- 3 files changed, 2 insertions(+), 134 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/base/dists/gumbel/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/gumbel/quantile/README.md index 04cfb4c57aea..fce85ef92c63 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/quantile/README.md @@ -177,7 +177,6 @@ for ( i = 0; i < 100; i++ ) { #### stdlib_base_dists_gumbel_quantile( p, mu, beta ) - Evaluates the [quantile-function][quantile-function] of a [gumbel-distribution][gumbel-distribution] with parameter probability `p`, location parameter `mu` and scale parameter `beta`. ```c diff --git a/lib/node_modules/@stdlib/utils/some-own-by/README.md b/lib/node_modules/@stdlib/utils/some-own-by/README.md index 38c90d246b78..99bc6829d7e3 100644 --- a/lib/node_modules/@stdlib/utils/some-own-by/README.md +++ b/lib/node_modules/@stdlib/utils/some-own-by/README.md @@ -222,7 +222,7 @@ bool = someOwnBy( obj, 5, threshold ); - [`@stdlib/utils/any-own-by`][@stdlib/utils/any-own-by]: test whether whether any 'own' property of a provided object satisfies a predicate function. - [`@stdlib/object/every-own-by`][@stdlib/object/every-own-by]: test whether all own properties of an object pass a test implemented by a predicate function. - [`@stdlib/utils/some-by`][@stdlib/utils/some-by]: test whether a collection contains at least `n` elements which pass a test implemented by a predicate function. -- [`@stdlib/utils/some-in-by`][@stdlib/utils/some-in-by]: test whether an object contains at least n properties (own and inherited) which pass a test implemented by a predicate function. +- [`@stdlib/object/some-in-by`][@stdlib/object/some-in-by]: test whether an object contains at least n properties (own and inherited) which pass a test implemented by a predicate function. @@ -242,7 +242,7 @@ bool = someOwnBy( obj, 5, threshold ); [@stdlib/utils/some-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-by -[@stdlib/utils/some-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-in-by +[@stdlib/object/some-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/some-in-by From 53d63c0eab0b4c41c1b857293dc5f96a737b6962 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 13 Jul 2025 22:27:50 -0500 Subject: [PATCH 2/2] chore: fix section tags and restore removed content Signed-off-by: Philipp Burckhardt --- .../@stdlib/blas/ext/base/ssort2ins/README.md | 137 +++++++++++++++++- 1 file changed, 135 insertions(+), 2 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 6f891c574113..d45f5bc5b97b 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ssort2ins/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ssort2ins/README.md @@ -187,12 +187,145 @@ console.log( y ); - -