From 4c152fd61ff5469e861b1e07cd9462c1923d9c1d Mon Sep 17 00:00:00 2001 From: officiallyanee Date: Tue, 23 Jun 2026 13:38:25 +0530 Subject: [PATCH 1/4] docs: fix C examples --- 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_pkg_readmes status: passed - task: lint_markdown_docs status: na - task: lint_markdown status: na - 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: passed - 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- lib/node_modules/@stdlib/blas/base/cgemv/README.md | 2 +- .../@stdlib/blas/ext/base/dnancount/README.md | 4 ++-- .../@stdlib/blas/ext/base/znancount/README.md | 8 ++++---- .../@stdlib/math/base/assert/is-composite/README.md | 2 +- .../@stdlib/math/base/special/atan2/src/main.c | 4 ++-- .../@stdlib/math/base/special/atan2d/src/main.c | 4 ++-- .../@stdlib/math/base/special/cround/src/main.c | 7 ++++++- .../@stdlib/math/base/special/fast/max/src/main.c | 4 ++-- .../@stdlib/math/base/special/gcd/src/main.c | 2 +- .../@stdlib/math/base/special/pow/src/main.c | 8 ++++++-- .../@stdlib/math/base/special/powf/src/main.c | 10 +++++++--- .../@stdlib/ml/base/kmeans/algorithms/README.md | 2 +- lib/node_modules/@stdlib/ndarray/base/every/README.md | 2 ++ .../@stdlib/ndarray/base/nullary/README.md | 2 ++ .../@stdlib/ndarray/base/unary-accumulate/README.md | 2 ++ lib/node_modules/@stdlib/ndarray/base/unary/README.md | 2 ++ .../@stdlib/strided/base/mskunary/README.md | 6 ++++++ lib/node_modules/@stdlib/strided/base/unary/README.md | 2 ++ 18 files changed, 51 insertions(+), 22 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/cgemv/README.md b/lib/node_modules/@stdlib/blas/base/cgemv/README.md index c6f74f3a2699..5230aa8909b2 100644 --- a/lib/node_modules/@stdlib/blas/base/cgemv/README.md +++ b/lib/node_modules/@stdlib/blas/base/cgemv/README.md @@ -309,7 +309,7 @@ float y[] = { 1.0f, 1.0f, 2.0f, 2.0f, 3.0f, 3.0f, 4.0f, 4.0f }; const stdlib_complex64_t alpha = stdlib_complex64( 0.5f, 0.5f ); const stdlib_complex64_t beta = stdlib_complex64( 0.5f, -0.5f ); -c_cgemv( CblasNoTrans, 4, 2, alpha, (void *)A, 1, 4, (void *)x, 1, 0, beta, (void *)y, 1, 0 ); +c_cgemv_ndarray( CblasNoTrans, 4, 2, alpha, (void *)A, 1, 4, 0, (void *)x, 1, 0, beta, (void *)y, 1, 0 ); ``` The function accepts the following arguments: diff --git a/lib/node_modules/@stdlib/blas/ext/base/dnancount/README.md b/lib/node_modules/@stdlib/blas/ext/base/dnancount/README.md index d759b8cdc627..59d28f89b434 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dnancount/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dnancount/README.md @@ -177,7 +177,7 @@ console.log( v ); Computes the number of non-`NaN` elements in a double-precision floating-point strided array. ```c -const double x[] = { 1.0, 2.0, NaN, 4.0, 5.0, 6.0, NaN, 8.0 }; +const double x[] = { 1.0, 2.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 8.0 }; int v = stdlib_strided_dnancount( 4, x, 2 ); // returns 2 @@ -198,7 +198,7 @@ CBLAS_INT stdlib_strided_dnancount( const CBLAS_INT N, const double *X, const CB Computes the number of non-`NaN` elements in a double-precision floating-point strided array using alternative indexing semantics. ```c -const double x[] = { 2.0, 1.0, NaN, -2.0, 3.0, 4.0, NaN, NaN }; +const double x[] = { 2.0, 1.0, 0.0/0.0, -2.0, 3.0, 4.0, 0.0/0.0, 0.0/0.0 }; int v = stdlib_strided_dnancount_ndarray( 4, x, 2, 1 ); // returns 3 diff --git a/lib/node_modules/@stdlib/blas/ext/base/znancount/README.md b/lib/node_modules/@stdlib/blas/ext/base/znancount/README.md index 452e0048358b..c821e75ada46 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/znancount/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/znancount/README.md @@ -190,9 +190,9 @@ Computes the number of non-`NaN` elements in a double-precision complex floating const stdlib_complex128_t x[] = { stdlib_complex128( 2.0, 1.0 ), - stdlib_complex128( NaN, -2.0 ), + stdlib_complex128( 0.0/0.0, -2.0 ), stdlib_complex128( 3.0, 4.0 ), - stdlib_complex128( NaN, NaN ) + stdlib_complex128( 0.0/0.0, 0.0/0.0 ) }; int v = stdlib_strided_znancount( 4, x, 1 ); @@ -218,9 +218,9 @@ Computes the number of non-`NaN` elements in a double-precision complex floating const stdlib_complex128_t x[] = { stdlib_complex128( 2.0, 1.0 ), - stdlib_complex128( NaN, -2.0 ), + stdlib_complex128( 0.0/0.0, -2.0 ), stdlib_complex128( 3.0, 4.0 ), - stdlib_complex128( NaN, NaN ) + stdlib_complex128( 0.0/0.0, 0.0/0.0 ) }; int v = stdlib_strided_znancount_ndarray( 4, x, 1, 0 ); diff --git a/lib/node_modules/@stdlib/math/base/assert/is-composite/README.md b/lib/node_modules/@stdlib/math/base/assert/is-composite/README.md index f61fb578bb85..3811f951e429 100644 --- a/lib/node_modules/@stdlib/math/base/assert/is-composite/README.md +++ b/lib/node_modules/@stdlib/math/base/assert/is-composite/README.md @@ -103,7 +103,7 @@ bool = isComposite( NaN ); ### Usage ```c -#include "stdlib/math/base/special/is_composite.h" +#include "stdlib/math/base/assert/is_composite.h" ``` #### stdlib_base_is_composite( x ) diff --git a/lib/node_modules/@stdlib/math/base/special/atan2/src/main.c b/lib/node_modules/@stdlib/math/base/special/atan2/src/main.c index b03e391009be..228c30752179 100755 --- a/lib/node_modules/@stdlib/math/base/special/atan2/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/atan2/src/main.c @@ -71,11 +71,11 @@ * // returns 0.0 * * @example -* double v = stdlib_base_atan2( 3.0, NaN ); +* double v = stdlib_base_atan2( 3.0, 0.0/0.0 ); * // returns NaN * * @example -* double v = stdlib_base_atan2( NaN, 2.0 ); +* double v = stdlib_base_atan2( 0.0/0.0, 2.0 ); * // returns NaN */ double stdlib_base_atan2( const double y, const double x ) { diff --git a/lib/node_modules/@stdlib/math/base/special/atan2d/src/main.c b/lib/node_modules/@stdlib/math/base/special/atan2d/src/main.c index 90af7a71a4e4..c112d24ebdf7 100755 --- a/lib/node_modules/@stdlib/math/base/special/atan2d/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/atan2d/src/main.c @@ -51,11 +51,11 @@ * // returns 0.0 * * @example -* double v = stdlib_base_atan2d( 3.0, NaN ); +* double v = stdlib_base_atan2d( 3.0, 0.0/0.0 ); * // returns NaN * * @example -* double v = stdlib_base_atan2d( NaN, 2.0 ); +* double v = stdlib_base_atan2d( 0.0/0.0, 2.0 ); * // returns NaN */ double stdlib_base_atan2d( const double y, const double x ) { diff --git a/lib/node_modules/@stdlib/math/base/special/cround/src/main.c b/lib/node_modules/@stdlib/math/base/special/cround/src/main.c index 55974e527707..b3e99a019b4e 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/cround/src/main.c @@ -35,7 +35,12 @@ * stdlib_complex128_t z = stdlib_complex128( -4.2, 5.5 ); * * stdlib_complex128_t out = stdlib_base_cround( z ); -* // returns [ -5.0, 6.0 ] +* +* double re = stdlib_complex128_real( out ); +* // returns -4.0 +* +* double im = stdlib_complex128_imag( out ); +* // returns 6.0 */ stdlib_complex128_t stdlib_base_cround( const stdlib_complex128_t z ) { double re; diff --git a/lib/node_modules/@stdlib/math/base/special/fast/max/src/main.c b/lib/node_modules/@stdlib/math/base/special/fast/max/src/main.c index 576f78d79c18..455a1e05190c 100644 --- a/lib/node_modules/@stdlib/math/base/special/fast/max/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/fast/max/src/main.c @@ -30,11 +30,11 @@ * // returns 4.2 * * @example -* double v = stdlib_base_fast_max( 3.14, NaN ); +* double v = stdlib_base_fast_max( 3.14, 0.0/0.0 ); * // returns NaN * * @example -* double v = stdlib_base_fast_max( NaN, 3.14 ); +* double v = stdlib_base_fast_max( 0.0/0.0, 3.14 ); * // returns 3.14 * * @example diff --git a/lib/node_modules/@stdlib/math/base/special/gcd/src/main.c b/lib/node_modules/@stdlib/math/base/special/gcd/src/main.c index e826ab46be92..9167bb5de935 100644 --- a/lib/node_modules/@stdlib/math/base/special/gcd/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/gcd/src/main.c @@ -35,7 +35,7 @@ static const int64_t STDLIB_CONSTANT_INT64_MAX = 9223372036854775807; * @return greatest common divisor * * @example -* double out = largeIntegers( 1.2676506002282294.0e+30, 9007199254740992.0 ); +* double out = largeIntegers( 1.2676506002282294e+30, 9007199254740992.0 ); * // returns 9007199254740992.0 */ static double largeIntegers( const double a, const double b ) { diff --git a/lib/node_modules/@stdlib/math/base/special/pow/src/main.c b/lib/node_modules/@stdlib/math/base/special/pow/src/main.c index 04ded463b87b..ed38e0727570 100644 --- a/lib/node_modules/@stdlib/math/base/special/pow/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/pow/src/main.c @@ -377,9 +377,11 @@ static double pow2( uint32_t j, const double hp, const double lp ) { * @param o2 destination for output2 * * @example +* double o1; +* double o2; * logx( 9.0, &o1, &o2 ); */ -void logx( const double ax, double *o1, double *o2 ) { +static void logx( const double ax, double *o1, double *o2 ) { double t2; double t1; double t; @@ -408,9 +410,11 @@ void logx( const double ax, double *o1, double *o2 ) { * @param o2 destination for output2 * * @example +* double o1; +* double o2; * log2ax( 9.0, 1075970048, &o1, &o2 ); */ -void log2ax( const double ax, const int32_t ahx, double *o1, double *o2 ) { +static void log2ax( const double ax, const int32_t ahx, double *o1, double *o2 ) { uint32_t ahxcc; uint32_t tmp; int32_t ahxc; diff --git a/lib/node_modules/@stdlib/math/base/special/powf/src/main.c b/lib/node_modules/@stdlib/math/base/special/powf/src/main.c index 856084ee3ca2..19033d983de7 100644 --- a/lib/node_modules/@stdlib/math/base/special/powf/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/powf/src/main.c @@ -200,7 +200,7 @@ static float polyval_p( const float x ) { * * @example * float out = y_is_infinitef( -1.0f, 1.0f/0.0f ); -* // returns NaN +* // returns 1.0f */ static float y_is_infinitef( const float x, const float y ) { if ( x == -1.0f ) { @@ -328,9 +328,11 @@ static float pow2f( uint32_t j, const float hp, const float lp ) { * @param o2 destination for output2 * * @example +* float o1; +* float o2; * logxf( 9.0f, &o1, &o2 ); */ -void logxf( const float ax, float *o1, float *o2 ) { +static void logxf( const float ax, float *o1, float *o2 ) { uint32_t tmp; float t2; float t1; @@ -361,9 +363,11 @@ void logxf( const float ax, float *o1, float *o2 ) { * @param o2 destination for output2 * * @example +* float o1; +* float o2; * log2axf( 9.0f, 1075970048, &o1, &o2 ); */ -void log2axf( const float ax, const int32_t ahx, float *o1, float *o2 ) { +static void log2axf( const float ax, const int32_t ahx, float *o1, float *o2 ) { uint32_t ahxcc; uint32_t tmp; int32_t ahxc; diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/algorithms/README.md b/lib/node_modules/@stdlib/ml/base/kmeans/algorithms/README.md index 6b50984c6421..3743a2994265 100644 --- a/lib/node_modules/@stdlib/ml/base/kmeans/algorithms/README.md +++ b/lib/node_modules/@stdlib/ml/base/kmeans/algorithms/README.md @@ -130,7 +130,7 @@ An enumeration of k-means clustering algorithms with the following fields: ```c #include "stdlib/ml/base/kmeans/algorithms.h" -const enum STDLIB_ML_KMEANS_ALGORITHM v = STDLIB_ML_KMEANS_LLOYD; +const enum STDLIB_ML_KMEANS_ALGORITHMS v = STDLIB_ML_KMEANS_LLOYD; ``` diff --git a/lib/node_modules/@stdlib/ndarray/base/every/README.md b/lib/node_modules/@stdlib/ndarray/base/every/README.md index e4f87e0f5b92..bbf745b27fea 100644 --- a/lib/node_modules/@stdlib/ndarray/base/every/README.md +++ b/lib/node_modules/@stdlib/ndarray/base/every/README.md @@ -204,6 +204,8 @@ void stdlib_ndarray_every_by_f_x_as_d_x(...) {...} is a function which accepts one single-precision floating-point input ndarray and one boolean output ndarray. However, the callback accepts double-precision floating-point numbers. Accordingly, the input values need to be cast using the following conversion sequence + + ```c #include diff --git a/lib/node_modules/@stdlib/ndarray/base/nullary/README.md b/lib/node_modules/@stdlib/ndarray/base/nullary/README.md index 70d2cedc6680..ff5b58354113 100644 --- a/lib/node_modules/@stdlib/ndarray/base/nullary/README.md +++ b/lib/node_modules/@stdlib/ndarray/base/nullary/README.md @@ -193,6 +193,8 @@ void stdlib_ndarray_f_as_d(...) {...} is a function which accepts one single-precision floating-point output ndarray. However, the callback returns double-precision floating-point numbers. Accordingly, the output values need to be cast using the following conversion sequence + + ```c // Evaluate the callback: double out = f(); diff --git a/lib/node_modules/@stdlib/ndarray/base/unary-accumulate/README.md b/lib/node_modules/@stdlib/ndarray/base/unary-accumulate/README.md index ecc0c5398dd2..62d95f89dfb4 100644 --- a/lib/node_modules/@stdlib/ndarray/base/unary-accumulate/README.md +++ b/lib/node_modules/@stdlib/ndarray/base/unary-accumulate/README.md @@ -204,6 +204,8 @@ void stdlib_ndarray_accumulate_ff_f_as_dd_d(...) {...} is a function which performs accumulation in single-precision and accepts one single-precision floating-point input ndarray and one single-precision floating-point output ndarray. However, the callback accepts and returns double-precision floating-point numbers. Accordingly, the input and output values need to be cast using the following conversion sequence + + ```c // Convert the current accumulated value to double-precision: double curr = (double)acc; diff --git a/lib/node_modules/@stdlib/ndarray/base/unary/README.md b/lib/node_modules/@stdlib/ndarray/base/unary/README.md index 29ffa6b44d36..fe257f6319d5 100644 --- a/lib/node_modules/@stdlib/ndarray/base/unary/README.md +++ b/lib/node_modules/@stdlib/ndarray/base/unary/README.md @@ -217,6 +217,8 @@ void stdlib_ndarray_f_f_as_d_d(...) {...} is a function which accepts one single-precision floating-point input ndarray and one single-precision floating-point output ndarray. However, the callback accepts and returns double-precision floating-point numbers. Accordingly, the input and output values need to be cast using the following conversion sequence + + ```c // Convert each input array element to double-precision: double in1 = (double)x[ i ]; diff --git a/lib/node_modules/@stdlib/strided/base/mskunary/README.md b/lib/node_modules/@stdlib/strided/base/mskunary/README.md index 0d1f4acab79c..32a546ed2dba 100644 --- a/lib/node_modules/@stdlib/strided/base/mskunary/README.md +++ b/lib/node_modules/@stdlib/strided/base/mskunary/README.md @@ -224,6 +224,8 @@ stdlib_strided_mask__[_as_ + ```c void stdlib_strided_mask_d_d(...) {...} ``` @@ -232,12 +234,16 @@ is a function which accepts one double-precision floating-point strided input ar To support callbacks whose input arguments and/or return values are of a different data type than the strided input and/or output array data types, the naming convention supports appending an `as` suffix. For example, + + ```c void stdlib_strided_mask_f_f_as_d_d(...) {...} ``` is a function which accepts one single-precision floating-point strided input array and one single-precision floating-point strided output array. However, the callback accepts and returns double-precision floating-point numbers. Accordingly, the input and output values need to be cast using the following conversion sequence + + ```c // Convert each input array element to double-precision: double in1 = (double)x[ i ]; diff --git a/lib/node_modules/@stdlib/strided/base/unary/README.md b/lib/node_modules/@stdlib/strided/base/unary/README.md index 68e93ebaa97a..4584011cffb8 100644 --- a/lib/node_modules/@stdlib/strided/base/unary/README.md +++ b/lib/node_modules/@stdlib/strided/base/unary/README.md @@ -231,6 +231,8 @@ void stdlib_strided_f_f_as_d_d(...) {...} is a function which accepts one single-precision floating-point strided input array and one single-precision floating-point strided output array. However, the callback accepts and returns double-precision floating-point numbers. Accordingly, the input and output values need to be cast using the following conversion sequence + + ```c // Convert each input array element to double-precision: double in1 = (double)x[ i ]; From 8f4f0611c18dedf463f5e47de6065b0e1bdeda90 Mon Sep 17 00:00:00 2001 From: officiallyanee Date: Tue, 23 Jun 2026 14:25:51 +0530 Subject: [PATCH 2/4] docs: fix C examples --- 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_pkg_readmes status: na - task: lint_markdown_docs status: na - task: lint_markdown status: na - 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: passed - 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/ndarray/base/flatten-shape-from/src/main.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/ndarray/base/flatten-shape-from/src/main.c b/lib/node_modules/@stdlib/ndarray/base/flatten-shape-from/src/main.c index a3b3127fe8ab..187751135956 100644 --- a/lib/node_modules/@stdlib/ndarray/base/flatten-shape-from/src/main.c +++ b/lib/node_modules/@stdlib/ndarray/base/flatten-shape-from/src/main.c @@ -35,7 +35,7 @@ * const int64_t shape[] = { 2, 3, 10 }; * int64_t out[ 2 ]; * -* stdlib_ndarray_flatten_shape( ndims, shape, 1, out ); +* stdlib_ndarray_flatten_shape_from( ndims, shape, 1, out ); */ int8_t stdlib_ndarray_flatten_shape_from( const int64_t ndims, const int64_t *shape, const int64_t dim, int64_t *out ) { int64_t d; From 2406adb10cc933558647c8386026819fd9eba34f Mon Sep 17 00:00:00 2001 From: officiallyanee Date: Wed, 24 Jun 2026 11:19:30 +0530 Subject: [PATCH 3/4] fix: header in ml/base/kmeans/algorithm --- 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_pkg_readmes status: passed - task: lint_markdown_docs status: na - task: lint_markdown status: na - 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- lib/node_modules/@stdlib/ml/base/kmeans/algorithms/README.md | 2 +- .../algorithms/include/stdlib/ml/base/kmeans/algorithms.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/algorithms/README.md b/lib/node_modules/@stdlib/ml/base/kmeans/algorithms/README.md index 3743a2994265..6b50984c6421 100644 --- a/lib/node_modules/@stdlib/ml/base/kmeans/algorithms/README.md +++ b/lib/node_modules/@stdlib/ml/base/kmeans/algorithms/README.md @@ -130,7 +130,7 @@ An enumeration of k-means clustering algorithms with the following fields: ```c #include "stdlib/ml/base/kmeans/algorithms.h" -const enum STDLIB_ML_KMEANS_ALGORITHMS v = STDLIB_ML_KMEANS_LLOYD; +const enum STDLIB_ML_KMEANS_ALGORITHM v = STDLIB_ML_KMEANS_LLOYD; ``` diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/algorithms/include/stdlib/ml/base/kmeans/algorithms.h b/lib/node_modules/@stdlib/ml/base/kmeans/algorithms/include/stdlib/ml/base/kmeans/algorithms.h index ff5e6b8d7559..86a1fb66be6b 100644 --- a/lib/node_modules/@stdlib/ml/base/kmeans/algorithms/include/stdlib/ml/base/kmeans/algorithms.h +++ b/lib/node_modules/@stdlib/ml/base/kmeans/algorithms/include/stdlib/ml/base/kmeans/algorithms.h @@ -22,7 +22,7 @@ /** * Enumeration of k-means clustering algorithms. */ -enum STDLIB_ML_KMEANS_ALGORITHMS { +enum STDLIB_ML_KMEANS_ALGORITHM { // Classic EM-style algorithm: STDLIB_ML_KMEANS_LLOYD = 0, From a5c0c58913e42ef81cd2b431bc07e7e8d9ae472d Mon Sep 17 00:00:00 2001 From: officiallyanee Date: Wed, 24 Jun 2026 18:38:09 +0530 Subject: [PATCH 4/4] docs: add run-disable to C struct redefinitions --- 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_pkg_readmes status: passed - task: lint_markdown_docs status: na - task: lint_markdown status: na - 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../ndarray/base/function-object/README.md | 2 ++ .../@stdlib/ndarray/ctor/README.md | 2 ++ .../one-sample/results/float32/README.md | 2 ++ .../one-sample/results/float64/README.md | 2 ++ .../two-sample/results/float32/README.md | 2 ++ .../two-sample/results/float64/README.md | 2 ++ .../strided/base/function-object/README.md | 2 ++ .../@stdlib/strided/base/nullary/README.md | 26 +++++++++++++++++++ 8 files changed, 40 insertions(+) diff --git a/lib/node_modules/@stdlib/ndarray/base/function-object/README.md b/lib/node_modules/@stdlib/ndarray/base/function-object/README.md index 4ca9f09301ee..dc0491bf6976 100644 --- a/lib/node_modules/@stdlib/ndarray/base/function-object/README.md +++ b/lib/node_modules/@stdlib/ndarray/base/function-object/README.md @@ -107,6 +107,8 @@ console.log( headerDir ); Structure for grouping ndarray function information. + + ```c struct ndarrayFunctionObject { // ndarray function name: diff --git a/lib/node_modules/@stdlib/ndarray/ctor/README.md b/lib/node_modules/@stdlib/ndarray/ctor/README.md index 2687d7148d1a..43c1ba8b83b2 100644 --- a/lib/node_modules/@stdlib/ndarray/ctor/README.md +++ b/lib/node_modules/@stdlib/ndarray/ctor/README.md @@ -721,6 +721,8 @@ str = JSON.stringify( arr.toJSON() ); Structure holding ndarray data. + + ```c #include "stdlib/ndarray/dtypes.h" #include "stdlib/ndarray/index_modes.h" diff --git a/lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/float32/README.md b/lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/float32/README.md index 202fafb6fbb3..0c1eac9d3aff 100644 --- a/lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/float32/README.md +++ b/lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/float32/README.md @@ -320,6 +320,8 @@ console.log( str ); Structure for holding single-precision floating-point test results. + + ```c #include #include diff --git a/lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/float64/README.md b/lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/float64/README.md index b54f56da38f6..b4ca297dfec3 100644 --- a/lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/float64/README.md +++ b/lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/float64/README.md @@ -320,6 +320,8 @@ console.log( str ); Structure for holding double-precision floating-point test results. + + ```c #include #include diff --git a/lib/node_modules/@stdlib/stats/base/ztest/two-sample/results/float32/README.md b/lib/node_modules/@stdlib/stats/base/ztest/two-sample/results/float32/README.md index 24d36e1fc600..7fc908da33af 100644 --- a/lib/node_modules/@stdlib/stats/base/ztest/two-sample/results/float32/README.md +++ b/lib/node_modules/@stdlib/stats/base/ztest/two-sample/results/float32/README.md @@ -338,6 +338,8 @@ console.log( str ); Structure for holding single-precision floating-point test results. + + ```c #include #include diff --git a/lib/node_modules/@stdlib/stats/base/ztest/two-sample/results/float64/README.md b/lib/node_modules/@stdlib/stats/base/ztest/two-sample/results/float64/README.md index eff667632c85..a3256976f0e7 100644 --- a/lib/node_modules/@stdlib/stats/base/ztest/two-sample/results/float64/README.md +++ b/lib/node_modules/@stdlib/stats/base/ztest/two-sample/results/float64/README.md @@ -338,6 +338,8 @@ console.log( str ); Structure for holding double-precision floating-point test results. + + ```c #include #include diff --git a/lib/node_modules/@stdlib/strided/base/function-object/README.md b/lib/node_modules/@stdlib/strided/base/function-object/README.md index f38100d948ce..d370167ab5af 100644 --- a/lib/node_modules/@stdlib/strided/base/function-object/README.md +++ b/lib/node_modules/@stdlib/strided/base/function-object/README.md @@ -107,6 +107,8 @@ console.log( headerDir ); Structure for grouping strided array function information. + + ```c struct StridedFunctionObject { // Strided array function name: diff --git a/lib/node_modules/@stdlib/strided/base/nullary/README.md b/lib/node_modules/@stdlib/strided/base/nullary/README.md index 943ce91c7ffa..9c4efe1a3fb3 100644 --- a/lib/node_modules/@stdlib/strided/base/nullary/README.md +++ b/lib/node_modules/@stdlib/strided/base/nullary/README.md @@ -224,6 +224,8 @@ void stdlib_strided_f_as_d(...) {...} is a function which accepts one single-precision floating-point strided output array. However, the callback returns double-precision floating-point numbers. Accordingly, the output value needs to be cast using the following conversion sequence + + ```c // Evaluate the callback: double out = f(); @@ -2098,6 +2100,8 @@ void stdlib_strided_z_as_u( uint8_t *arrays[], const int64_t *shape, const int64 Macro containing the preamble for a loop which updates a strided output array. + + ```c STDLIB_STRIDED_NULLARY_LOOP_PREMABLE { // Loop body... @@ -2117,6 +2121,8 @@ The macro defines the following variables: - **n**: `int64_t` number of indexed elements. - **i**: `int64_t` loop counter. + + ```c #define STDLIB_STRIDED_NULLARY_LOOP_PREAMBLE \ uint8_t *op1 = arrays[ 0 ]; \ @@ -2136,6 +2142,8 @@ The macro defines the following variables: Macro containing the preamble for a loop which updates two strided output arrays. + + ```c STDLIB_STRIDED_NULLARY_LOOP_TWO_OUT_PREMABLE { // Loop body... @@ -2157,6 +2165,8 @@ The macro defines the following variables: - **n**: `int64_t` number of indexed elements. - **i**: `int64_t` loop counter. + + ```c #define STDLIB_STRIDED_NULLARY_LOOP_TWO_OUT_PREAMBLE \ uint8_t *op1 = arrays[ 0 ]; \ @@ -2181,6 +2191,8 @@ The macro defines the following variables: Macro for a nullary loop which inlines an expression. + + ```c STDLIB_STRIDED_NULLARY_LOOP_INLINE( double, *out = (double)1.0 ) ``` @@ -2196,6 +2208,8 @@ In addition to the variables defined by the `STDLIB_STRIDED_NULLARY_LOOP_PREAMBL The macro expects a provided expression to store the result via `*out`. + + ```c #define STDLIB_STRIDED_NULLARY_LOOP_INLINE( tout, expr ) \ STDLIB_STRIDED_NULLARY_LOOP_PREAMBLE { \ @@ -2208,6 +2222,8 @@ The macro expects a provided expression to store the result via `*out`. Macro for a nullary loop which invokes a callback. + + ```c STDLIB_STRIDED_NULLARY_LOOP_CLBK( double ) ``` @@ -2220,6 +2236,8 @@ In addition to the variables expected by `STDLIB_STRIDED_NULLARY_LOOP_PREAMBLE`, - **f**: nullary callback. + + ```c #define STDLIB_STRIDED_NULLARY_LOOP_CLBK( tout ) \ STDLIB_STRIDED_NULLARY_LOOP_PREAMBLE { \ @@ -2231,6 +2249,8 @@ In addition to the variables expected by `STDLIB_STRIDED_NULLARY_LOOP_PREAMBLE`, Macro for a nullary loop which invokes a callback and does not cast the return callback's return value (e.g., a `struct`). + + ```c #include "stdlib/complex/float64/ctor.h" @@ -2245,6 +2265,8 @@ In addition to the variables expected by `STDLIB_STRIDED_NULLARY_LOOP_PREAMBLE`, - **f**: nullary callback. + + ```c #define STDLIB_STRIDED_NULLARY_LOOP_CLBK_RET_NOCAST( tout ) \ STDLIB_STRIDED_NULLARY_LOOP_PREAMBLE { \ @@ -2256,6 +2278,8 @@ In addition to the variables expected by `STDLIB_STRIDED_NULLARY_LOOP_PREAMBLE`, Macro for a nullary loop which invokes a callback whose return values should be cast to a different type via casting functions. + + ```c #include "stdlib/complex/float32/ctor.h" #include "stdlib/complex/float64/ctor.h" @@ -2272,6 +2296,8 @@ In addition to the variables expected by `STDLIB_STRIDED_NULLARY_LOOP_PREAMBLE`, - **f**: nullary callback. + + ```c #define STDLIB_STRIDED_NULLARY_LOOP_CLBK_RET_CAST_FCN( tout, cout ) \ STDLIB_STRIDED_NULLARY_LOOP_PREAMBLE { \