From 6896f760406ef0e9889ce5eec53c4c9444527c9f Mon Sep 17 00:00:00 2001 From: Divit Jain Date: Wed, 24 Dec 2025 14:24:52 +0530 Subject: [PATCH 1/2] docs: improve doctests for ndarray instances in ndarray/any --- 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: 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 --- --- .../@stdlib/ndarray/any/README.md | 27 ++++--------------- 1 file changed, 5 insertions(+), 22 deletions(-) diff --git a/lib/node_modules/@stdlib/ndarray/any/README.md b/lib/node_modules/@stdlib/ndarray/any/README.md index 26170d3f2d30..a6a7a967ac4e 100644 --- a/lib/node_modules/@stdlib/ndarray/any/README.md +++ b/lib/node_modules/@stdlib/ndarray/any/README.md @@ -49,10 +49,7 @@ var x = array( [ [ [ -1.0, 0.0 ] ], [ [ -3.0, -4.0 ] ], [ [ 5.0, -6.0 ] ] ] ); // Perform reduction: var out = any( x ); -// returns - -var v = out.get(); -// returns true +// returns [ true ] ``` The function accepts the following arguments: @@ -69,7 +66,6 @@ By default, the function performs a reduction over all elements in a provided [` ```javascript var array = require( '@stdlib/ndarray/array' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); // Create an input ndarray: var x = array( [ [ [ -1.0, 0.0 ] ], [ [ -3.0, 0.0 ] ], [ [ 5.0, 0.0 ] ] ] ); @@ -79,17 +75,13 @@ var x = array( [ [ [ -1.0, 0.0 ] ], [ [ -3.0, 0.0 ] ], [ [ 5.0, 0.0 ] ] ] ); var out = any( x, { 'dims': [ 1, 2 ] }); -// returns - -var v = ndarray2array( out ); -// returns [ true, true, true ] +// returns [ true, true, true ] ``` By default, the function returns an [`ndarray`][@stdlib/ndarray/ctor] having a shape matching only the non-reduced dimensions of the input [`ndarray`][@stdlib/ndarray/ctor] (i.e., the reduced dimensions are dropped). To include the reduced dimensions as singleton dimensions in the output [`ndarray`][@stdlib/ndarray/ctor], set the `keepdims` option to `true`. ```javascript var array = require( '@stdlib/ndarray/array' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); // Create an input ndarray: var x = array( [ [ [ -1.0, 0.0 ] ], [ [ -3.0, 0.0 ] ], [ [ 5.0, 0.0 ] ] ] ); @@ -100,10 +92,7 @@ var out = any( x, { 'dims': [ 1, 2 ], 'keepdims': true }); -// returns - -var v = ndarray2array( out ); -// returns [ [ [ true ] ], [ [ true ] ], [ [ true ] ] ] +// returns [ [ [ true ] ], [ [ true ] ], [ [ true ] ] ] ``` #### any.assign( x, out\[, options] ) @@ -125,13 +114,10 @@ var y = empty( [], { // Perform reduction: var out = any.assign( x, y ); -// returns +// returns [ true ] var bool = ( out === y ); // returns true - -var v = y.get(); -// returns true ``` The function accepts the following arguments: @@ -149,7 +135,6 @@ By default, the function performs a reduction over all elements in a provided [` ```javascript var array = require( '@stdlib/ndarray/array' ); var empty = require( '@stdlib/ndarray/empty' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); // Create an input ndarray: var x = array( [ [ [ -1.0, 0.0 ] ], [ [ -3.0, 0.0 ] ], [ [ 5.0, 0.0 ] ] ] ); @@ -164,12 +149,10 @@ var y = empty( [ 3 ], { var out = any.assign( x, y, { 'dims': [ 1, 2 ] }); +// returns [ true, true, true ] var bool = ( out === y ); // returns true - -var v = ndarray2array( y ); -// returns [ true, true, true ] ``` From 7a41d786bdc66121c1396e2109a85d62498606c1 Mon Sep 17 00:00:00 2001 From: Divit Jain Date: Wed, 24 Dec 2025 16:16:29 +0530 Subject: [PATCH 2/2] docs: improve doctests for ndarray instances in ndarray/any --- 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: na - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - 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: passed - task: lint_license_headers status: passed --- --- .../@stdlib/ndarray/any/docs/repl.txt | 10 ++-------- .../@stdlib/ndarray/any/docs/types/index.d.ts | 20 ++++--------------- .../@stdlib/ndarray/any/lib/assign.js | 5 +---- .../@stdlib/ndarray/any/lib/index.js | 10 ++-------- .../@stdlib/ndarray/any/lib/main.js | 5 +---- 5 files changed, 10 insertions(+), 40 deletions(-) diff --git a/lib/node_modules/@stdlib/ndarray/any/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/any/docs/repl.txt index 9623b5a6bc92..b5463ee6f0eb 100644 --- a/lib/node_modules/@stdlib/ndarray/any/docs/repl.txt +++ b/lib/node_modules/@stdlib/ndarray/any/docs/repl.txt @@ -34,11 +34,7 @@ > y.get() true > y = {{alias}}( x, { 'keepdims': true } ) - - > {{alias:@stdlib/ndarray/to-array}}( y ) - [ [ true ] ] - > y.get( 0, 0 ) - true + [ [ true ] ] {{alias}}.assign( x, y[, options] ) @@ -72,11 +68,9 @@ > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1.0, 0.0 ], [ 0.0, 1.0 ] ] ); > var y = {{alias:@stdlib/ndarray/from-scalar}}( false ); > var out = {{alias}}.assign( x, y ) - + [ true ] > var bool = ( out === y ) true - > y.get() - true See Also -------- diff --git a/lib/node_modules/@stdlib/ndarray/any/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/any/docs/types/index.d.ts index 029716680464..f02c42a9b1ba 100644 --- a/lib/node_modules/@stdlib/ndarray/any/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/ndarray/any/docs/types/index.d.ts @@ -77,10 +77,7 @@ interface Any { * * // Perform reduction: * var out = any( x ); - * // returns - * - * var v = out.get(); - * // returns true + * // returns [ true ] */ ( x: ndarray, options?: Options ): boolndarray; @@ -120,10 +117,7 @@ interface Any { * * // Perform reduction: * var out = any.assign( x, y ); - * // returns - * - * var v = out.get(); - * // returns true + * // returns [ true ] */ assign( x: ndarray, y: T, options?: BaseOptions ): T; } @@ -158,10 +152,7 @@ interface Any { * * // Perform reduction: * var out = any( x ); -* // returns -* -* var v = out.get(); -* // returns true +* // returns [ true ] * * @example * var Float64Array = require( '@stdlib/array/float64' ); @@ -190,10 +181,7 @@ interface Any { * * // Perform reduction: * var out = any.assign( x, y ); -* // returns -* -* var v = out.get(); -* // returns true +* // returns [ true ] */ declare var any: Any; diff --git a/lib/node_modules/@stdlib/ndarray/any/lib/assign.js b/lib/node_modules/@stdlib/ndarray/any/lib/assign.js index 6eca91f8f471..56ba881891b5 100644 --- a/lib/node_modules/@stdlib/ndarray/any/lib/assign.js +++ b/lib/node_modules/@stdlib/ndarray/any/lib/assign.js @@ -73,10 +73,7 @@ var validate = require( './validate.js' ); * * // Perform reduction: * var out = assign( x, y ); -* // returns -* -* var v = out.get(); -* // returns true +* // returns [ true ] */ function assign( x, y, options ) { var opts; diff --git a/lib/node_modules/@stdlib/ndarray/any/lib/index.js b/lib/node_modules/@stdlib/ndarray/any/lib/index.js index 564ba13fe0e1..14039cc86c73 100644 --- a/lib/node_modules/@stdlib/ndarray/any/lib/index.js +++ b/lib/node_modules/@stdlib/ndarray/any/lib/index.js @@ -45,10 +45,7 @@ * * // Perform reduction: * var out = any( x ); -* // returns -* -* var v = out.get(); -* // returns true +* // returns [ true ] * * @example * var Float64Array = require( '@stdlib/array/float64' ); @@ -78,10 +75,7 @@ * * // Perform reduction: * var out = any.assign( x, y ); -* // returns -* -* var v = out.get(); -* // returns true +* // returns [ true ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/ndarray/any/lib/main.js b/lib/node_modules/@stdlib/ndarray/any/lib/main.js index 8fbe5a681dc4..6c01cb5145e3 100644 --- a/lib/node_modules/@stdlib/ndarray/any/lib/main.js +++ b/lib/node_modules/@stdlib/ndarray/any/lib/main.js @@ -78,10 +78,7 @@ var validate = require( './validate.js' ); * * // Perform reduction: * var out = any( x ); -* // returns -* -* var v = out.get(); -* // returns true +* // returns [ true ] */ function any( x, options ) { var opts;