From ef605533c5c5373a697c5312391593a52e19c623 Mon Sep 17 00:00:00 2001 From: Uday Kakade Date: Fri, 17 Apr 2026 23:51:38 +0530 Subject: [PATCH] docs: improve doctest for ndarray instances in ndarray/base/to-reversed --- .../@stdlib/ndarray/base/to-reversed/README.md | 11 ++--------- .../@stdlib/ndarray/base/to-reversed/docs/repl.txt | 11 ++--------- .../ndarray/base/to-reversed/docs/types/index.d.ts | 11 ++--------- .../@stdlib/ndarray/base/to-reversed/lib/index.js | 11 ++--------- .../@stdlib/ndarray/base/to-reversed/lib/main.js | 11 ++--------- 5 files changed, 10 insertions(+), 45 deletions(-) diff --git a/lib/node_modules/@stdlib/ndarray/base/to-reversed/README.md b/lib/node_modules/@stdlib/ndarray/base/to-reversed/README.md index bac1913676b6..84a196473e27 100644 --- a/lib/node_modules/@stdlib/ndarray/base/to-reversed/README.md +++ b/lib/node_modules/@stdlib/ndarray/base/to-reversed/README.md @@ -46,7 +46,6 @@ Returns a new ndarray where the order of elements of an input ndarray is reverse ```javascript var ndarray = require( '@stdlib/ndarray/ctor' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]; var shape = [ 3, 2 ]; @@ -54,22 +53,16 @@ var strides = [ 2, 1 ]; var offset = 0; var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' ); -// returns +// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] var sh = x.shape; // returns [ 3, 2 ] -var arr = ndarray2array( x ); -// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] - var y = toReversed( x ); -// returns +// returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ] sh = y.shape; // returns [ 3, 2 ] - -arr = ndarray2array( y ); -// returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ] ``` The function accepts the following arguments: diff --git a/lib/node_modules/@stdlib/ndarray/base/to-reversed/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/base/to-reversed/docs/repl.txt index c45dc1017181..65feaee981f2 100644 --- a/lib/node_modules/@stdlib/ndarray/base/to-reversed/docs/repl.txt +++ b/lib/node_modules/@stdlib/ndarray/base/to-reversed/docs/repl.txt @@ -15,16 +15,9 @@ Examples -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > x.shape - [ 2, 2 ] + > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ); > var y = {{alias}}( x ) - - > y.shape - [ 2, 2 ] - > {{alias:@stdlib/ndarray/to-array}}( y ) - [ [ 4, 3 ], [ 2, 1 ] ] + [ [ 4, 3 ], [ 2, 1 ] ] See Also -------- diff --git a/lib/node_modules/@stdlib/ndarray/base/to-reversed/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/base/to-reversed/docs/types/index.d.ts index 8630acfc231d..b7e6ed682900 100644 --- a/lib/node_modules/@stdlib/ndarray/base/to-reversed/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/ndarray/base/to-reversed/docs/types/index.d.ts @@ -31,7 +31,6 @@ import { ndarray } from '@stdlib/types/ndarray'; * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], 'float64' ); * var shape = [ 3, 2 ]; @@ -39,22 +38,16 @@ import { ndarray } from '@stdlib/types/ndarray'; * var offset = 0; * * var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' ); -* // returns +* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] * * var sh = x.shape; * // returns [ 3, 2 ] * -* var arr = ndarray2array( x ); -* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] -* * var y = toReversed( x ); -* // returns +* // returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ] * * sh = y.shape; * // returns [ 3, 2 ] -* -* arr = ndarray2array( y ); -* // returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ] */ declare function toReversed( x: T ): T; diff --git a/lib/node_modules/@stdlib/ndarray/base/to-reversed/lib/index.js b/lib/node_modules/@stdlib/ndarray/base/to-reversed/lib/index.js index e8bc2ac40d52..603e1fc32028 100644 --- a/lib/node_modules/@stdlib/ndarray/base/to-reversed/lib/index.js +++ b/lib/node_modules/@stdlib/ndarray/base/to-reversed/lib/index.js @@ -25,7 +25,6 @@ * * @example * var ndarray = require( '@stdlib/ndarray/ctor' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var toReversed = require( '@stdlib/ndarray/base/to-reversed' ); * * var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]; @@ -34,22 +33,16 @@ * var offset = 0; * * var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' ); -* // returns +* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] * * var sh = x.shape; * // returns [ 3, 2 ] * -* var arr = ndarray2array( x ); -* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] -* * var y = toReversed( x ); -* // returns +* // returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ] * * sh = y.shape; * // returns [ 3, 2 ] -* -* arr = ndarray2array( y ); -* // returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/ndarray/base/to-reversed/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/to-reversed/lib/main.js index 99be2504d934..5d316e7205f9 100644 --- a/lib/node_modules/@stdlib/ndarray/base/to-reversed/lib/main.js +++ b/lib/node_modules/@stdlib/ndarray/base/to-reversed/lib/main.js @@ -35,7 +35,6 @@ var assign = require( '@stdlib/ndarray/base/assign' ); * * @example * var ndarray = require( '@stdlib/ndarray/ctor' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]; * var shape = [ 3, 2 ]; @@ -43,22 +42,16 @@ var assign = require( '@stdlib/ndarray/base/assign' ); * var offset = 0; * * var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' ); -* // returns +* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] * * var sh = x.shape; * // returns [ 3, 2 ] * -* var arr = ndarray2array( x ); -* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] -* * var y = toReversed( x ); -* // returns +* // returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ] * * sh = y.shape; * // returns [ 3, 2 ] -* -* arr = ndarray2array( y ); -* // returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ] */ function toReversed( x ) { var out;