From 9a751548db0a65ba90debe8e2d8f0bf4c80d77cd Mon Sep 17 00:00:00 2001 From: Uday Kakade Date: Thu, 16 Apr 2026 23:04:46 +0530 Subject: [PATCH] docs: improve doctests for ndarray instances in blas/ext/findIndex --- .../@stdlib/blas/ext/find-index/README.md | 34 ++++--------------- .../@stdlib/blas/ext/find-index/docs/repl.txt | 9 ++--- .../blas/ext/find-index/docs/types/index.d.ts | 30 ++++------------ .../@stdlib/blas/ext/find-index/lib/assign.js | 6 +--- .../@stdlib/blas/ext/find-index/lib/base.js | 5 +-- .../@stdlib/blas/ext/find-index/lib/index.js | 6 +--- .../@stdlib/blas/ext/find-index/lib/main.js | 6 +--- 7 files changed, 20 insertions(+), 76 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/find-index/README.md b/lib/node_modules/@stdlib/blas/ext/find-index/README.md index 6611c05dade8..70ea5efca68a 100644 --- a/lib/node_modules/@stdlib/blas/ext/find-index/README.md +++ b/lib/node_modules/@stdlib/blas/ext/find-index/README.md @@ -47,10 +47,7 @@ var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); // Perform operation: var out = findIndex( x, isEven ); -// returns - -var idx = out.get(); -// returns 1 +// returns [ 1 ] ``` The function has the following parameters: @@ -84,10 +81,7 @@ var ctx = { 'count': 0 }; var out = findIndex( x, isEven, ctx ); -// returns - -var idx = out.get(); -// returns 1 +// returns [ 1 ] var count = ctx.count; // returns 2 @@ -114,16 +108,12 @@ var x = array( [ 1.0, 3.0, 5.0, 7.0 ] ); // Perform operation: var out = findIndex( x, isEven ); -// returns - -var idx = out.get(); -// returns -1 +// returns [ -1 ] ``` By default, the function performs the operation over elements in the last dimension. To perform the operation over a different dimension, provide a `dim` option. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var array = require( '@stdlib/ndarray/array' ); function isEven( v ) { @@ -137,17 +127,13 @@ var opts = { }; var out = findIndex( x, opts, isEven ); -// returns - -var idx = ndarray2array( out ); -// returns [ -1, 0 ] +// returns [ -1, 0 ] ``` By default, the function excludes reduced dimensions from the output [ndarray][@stdlib/ndarray/ctor]. To include the reduced dimensions as singleton dimensions, set the `keepdims` option to `true`. ```javascript var array = require( '@stdlib/ndarray/array' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); function isEven( v ) { return v % 2.0 === 0.0; @@ -161,10 +147,7 @@ var opts = { }; var out = findIndex( x, opts, isEven ); -// returns - -var idx = ndarray2array( out ); -// returns [ [ -1, 0 ] ] +// returns [ [ -1, 0 ] ] ``` By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] determined by the function's output data type [policy][@stdlib/ndarray/output-dtype-policies]. To override the default behavior, set the `dtype` option. @@ -184,7 +167,7 @@ var opts = { }; var idx = findIndex( x, opts, isEven ); -// returns +// returns [ 1 ] var dt = dtype( idx ); // returns 'generic' @@ -208,10 +191,7 @@ var y = zeros( [], { }); var out = findIndex.assign( x, y, isEven ); -// returns - -var idx = out.get(); -// returns 1 +// returns [ 1 ] var bool = ( out === y ); // returns true diff --git a/lib/node_modules/@stdlib/blas/ext/find-index/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/find-index/docs/repl.txt index 2868eaadb233..56c183c4dd5a 100644 --- a/lib/node_modules/@stdlib/blas/ext/find-index/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/find-index/docs/repl.txt @@ -51,9 +51,8 @@ -------- > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] ); > function clbk( v ) { return v % 2.0 === 0.0; }; - > var y = {{alias}}( x, clbk ); - > var v = y.get() - 1 + > var y = {{alias}}( x, clbk ) + [ 1 ] {{alias}}.assign( x, out[, options], clbk[, thisArg] ) @@ -107,11 +106,9 @@ > var out = {{alias:@stdlib/ndarray/zeros}}( [] ); > function clbk( v ) { return v % 2.0 === 0.0; }; > var y = {{alias}}.assign( x, out, clbk ) - + [ 1 ] > var bool = ( out === y ) true - > var v = out.get() - 1 See Also -------- diff --git a/lib/node_modules/@stdlib/blas/ext/find-index/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/find-index/docs/types/index.d.ts index f2253a6ed413..193aa35cad2a 100644 --- a/lib/node_modules/@stdlib/blas/ext/find-index/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/find-index/docs/types/index.d.ts @@ -131,10 +131,7 @@ interface FindIndex { * var x = array( [ -1.0, 2.0, -3.0 ] ); * * var y = findIndex( x, clbk ); - * // returns - * - * var v = y.get(); - * // returns 1 + * // returns [ 1 ] */ = InputArray, ThisArg = unknown>( x: U, clbk: Predicate, thisArg?: ThisParameterType> ): OutputArray; @@ -161,10 +158,7 @@ interface FindIndex { * var x = array( [ -1.0, 2.0, -3.0 ] ); * * var y = findIndex( x, {}, clbk ); - * // returns - * - * var v = y.get(); - * // returns 1 + * // returns [ 1 ] */ = InputArray, ThisArg = unknown>( x: U, options: Options, clbk: Predicate, thisArg?: ThisParameterType> ): OutputArray; @@ -193,10 +187,7 @@ interface FindIndex { * var y = zeros( [] ); * * var out = findIndex.assign( x, y, clbk ); - * // returns - * - * var v = out.get(); - * // returns 1 + * // returns [ 1 ] * * var bool = ( out === y ); * // returns true @@ -229,10 +220,7 @@ interface FindIndex { * var y = zeros( [] ); * * var out = findIndex.assign( x, y, {}, clbk ); - * // returns - * - * var v = out.get(); - * // returns 1 + * // returns [ 1 ] * * var bool = ( out === y ); * // returns true @@ -263,10 +251,7 @@ interface FindIndex { * var x = array( [ -1.0, 2.0, -3.0 ] ); * * var y = findIndex( x, clbk ); -* // returns -* -* var v = y.get(); -* // returns 1 +* // returns [ 1 ] * * @example * var array = require( '@stdlib/ndarray/array' ); @@ -280,10 +265,7 @@ interface FindIndex { * var y = zeros( [] ); * * var out = findIndex.assign( x, y, clbk ); -* // returns -* -* var v = out.get(); -* // returns 1 +* // returns [ 1 ] * * var bool = ( out === y ); * // returns true diff --git a/lib/node_modules/@stdlib/blas/ext/find-index/lib/assign.js b/lib/node_modules/@stdlib/blas/ext/find-index/lib/assign.js index 94efbfb2571b..ebe52c62c871 100644 --- a/lib/node_modules/@stdlib/blas/ext/find-index/lib/assign.js +++ b/lib/node_modules/@stdlib/blas/ext/find-index/lib/assign.js @@ -52,7 +52,6 @@ var base = require( './base.js' ).assign; * * @example * var zeros = require( '@stdlib/ndarray/zeros' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * * function isEven( v ) { @@ -81,13 +80,10 @@ var base = require( './base.js' ).assign; * * // Perform operation: * var out = assign( x, y, isEven ); -* // returns +* // returns [ 1, 0 ] * * var bool = ( out === y ); * // returns true -* -* var arr = ndarray2array( out ); -* // returns [ 1, 0 ] */ function assign( x, out ) { var hasOptions; diff --git a/lib/node_modules/@stdlib/blas/ext/find-index/lib/base.js b/lib/node_modules/@stdlib/blas/ext/find-index/lib/base.js index 076a81f35a6f..7be8c1bf06a8 100644 --- a/lib/node_modules/@stdlib/blas/ext/find-index/lib/base.js +++ b/lib/node_modules/@stdlib/blas/ext/find-index/lib/base.js @@ -83,10 +83,7 @@ var table = { * * // Perform operation: * var out = findIndex( x, isEven ); -* // returns -* -* var idx = out.get(); -* // returns 1 +* // returns [ 1 ] */ var findIndex = factory( table, [ idtypes ], odtypes, policies ); diff --git a/lib/node_modules/@stdlib/blas/ext/find-index/lib/index.js b/lib/node_modules/@stdlib/blas/ext/find-index/lib/index.js index 9719d0188e1c..acc53b0175af 100644 --- a/lib/node_modules/@stdlib/blas/ext/find-index/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/find-index/lib/index.js @@ -24,7 +24,6 @@ * @module @stdlib/blas/ext/find-index * * @example -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var findIndex = require( '@stdlib/blas/ext/find-index' ); * @@ -49,10 +48,7 @@ * * // Perform operation: * var out = findIndex( x, isEven ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ 1, 0 ] +* // returns [ 1, 0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/blas/ext/find-index/lib/main.js b/lib/node_modules/@stdlib/blas/ext/find-index/lib/main.js index 7518455114ce..fc6005e60031 100644 --- a/lib/node_modules/@stdlib/blas/ext/find-index/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/find-index/lib/main.js @@ -50,7 +50,6 @@ var base = require( './base.js' ); * @returns {ndarray} output ndarray * * @example -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * * function isEven( v ) { @@ -74,10 +73,7 @@ var base = require( './base.js' ); * * // Perform operation: * var out = findIndex( x, isEven ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ 1, 0 ] +* // returns [ 1, 0 ] */ function findIndex( x ) { var hasOptions;