Skip to content

docs: improve doctests for ndarray instances in #9414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GlyphicGuy wants to merge 1 commit into
base: develop
Choose a base branch
from
+11 −43
Open

docs: improve doctests for ndarray instances in #9414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 2 additions & 10 deletions lib/node_modules/@stdlib/ndarray/concat/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,16 +46,12 @@ Concatenates a list of [ndarrays][@stdlib/ndarray/ctor] along a specified [ndarr

```javascript
var array = require( '@stdlib/ndarray/array' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );

var x = array( [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] );
var y = array( [ [ -5.0, 6.0, -7.0 ], [ 8.0, -9.0, 10.0 ] ] );

var out = concat( [ x, y ], -1 );
// returns <ndarray>

var arr = ndarray2array( out );
// returns [ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
// returns <ndarray>[ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
```

The function accepts the following arguments:
Expand All @@ -70,21 +66,17 @@ Concatenates a list of ndarrays along a specified ndarray dimension and assigns
```javascript
var array = require( '@stdlib/ndarray/array' );
var zeros = require( '@stdlib/ndarray/zeros' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );

var x = array( [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] );
var y = array( [ [ -5.0, 6.0, -7.0 ], [ 8.0, -9.0, 10.0 ] ] );

var z = zeros( [ 2, 5 ] );

var out = concat.assign( [ x, y ], z, -1 );
// returns <ndarray>
// returns <ndarray>[ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]

var bool = ( out === z );
// returns true

var arr = ndarray2array( z );
// returns [ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
```

The function accepts the following arguments:
Expand Down
8 changes: 2 additions & 6 deletions lib/node_modules/@stdlib/ndarray/concat/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
> var y = {{alias:@stdlib/ndarray/array}}( [ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ] );
> var out = {{alias}}( [ x, y ], -1 )
<ndarray>
> var arr = {{alias:@stdlib/ndarray/to-array}}( out )
[ [ 1.0, 2.0, 5.0, 6.0 ], [ 3.0, 4.0, 7.0, 8.0 ] ]
<ndarray>[ [ 1.0, 2.0, 5.0, 6.0 ], [ 3.0, 4.0, 7.0, 8.0 ] ]


{{alias}}.assign( arrays, out[, dim] )
Expand Down Expand Up @@ -64,11 +62,9 @@
> var y = {{alias:@stdlib/ndarray/array}}( [ [ 3.0 ], [ 4.0 ] ] );
> var z = {{alias:@stdlib/ndarray/array}}( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] );
> var out = {{alias}}.assign( [ x, y ], z, -1 )
<ndarray>
<ndarray>[ [ 1.0, 3.0 ], [ 2.0, 4.0 ] ]
> var bool = ( out === z )
true
> var arr = {{alias:@stdlib/ndarray/to-array}}( out )
[ [ 1.0, 3.0 ], [ 2.0, 4.0 ] ]

See Also
--------
Expand Down
16 changes: 4 additions & 12 deletions lib/node_modules/@stdlib/ndarray/concat/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,7 @@ interface Concat {
* var y = new ndarray( 'float64', ybuf, [ 2, 3 ], [ 3, 1 ], 0, 'row-major' );
*
* var out = concat( [ x, y ], -1 );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
* // returns <ndarray>[ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
*/
<T = unknown>( arrays: ArrayLike<typedndarray<T>>, dim?: number ): typedndarray<T>;

Expand All @@ -75,12 +72,11 @@ interface Concat {
* var z = new ndarray( 'float64', new Float64Array( 10 ), [ 2, 5 ], [ 5, 1 ], 0, 'row-major' );
*
* var out = concat.assign( [ x, y ], z, -1 );
* // returns <ndarray>[ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
*
* var bool = ( out === z );
* // returns true
*
* var arr = ndarray2array( z );
* // returns [ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
*/
assign<T = unknown, U = unknown, V extends typedndarray<U> = typedndarray<U>>( arrays: ArrayLike<typedndarray<T>>, out: V, dim?: number ): V;
}
Expand All @@ -104,10 +100,7 @@ interface Concat {
* var y = new ndarray( 'float64', ybuf, [ 2, 3 ], [ 3, 1 ], 0, 'row-major' );
*
* var out = concat( [ x, y ], -1 );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
* // returns <ndarray>[ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
Expand All @@ -123,12 +116,11 @@ interface Concat {
* var z = new ndarray( 'float64', new Float64Array( 10 ), [ 2, 5 ], [ 5, 1 ], 0, 'row-major' );
*
* var out = concat.assign( [ x, y ], z, -1 );
* // returns <ndarray>[ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
*
* var bool = ( out === z );
* // returns true
*
* var arr = ndarray2array( z );
* // returns [ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
*/
declare var concat: Concat;

Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/ndarray/concat/lib/assign.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ var base = require( './base.js' );
* @returns {ndarrayLike} output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
Expand All @@ -69,13 +68,10 @@ var base = require( './base.js' );
* var z = new ndarray( 'float64', new Float64Array( 10 ), [ 2, 5 ], [ 5, 1 ], 0, 'row-major' );
*
* var out = assign( [ x, y ], z, -1 );
* // returns <ndarray>
* // returns <ndarray>[ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
*
* var bool = ( out === z );
* // returns true
*
* var arr = ndarray2array( z );
* // returns [ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
*/
function assign( arrays, out, dim ) {
var arrs;
Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/ndarray/concat/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var concat = require( '@stdlib/ndarray/concat' );
*
Expand All @@ -36,10 +35,7 @@
* var y = new ndarray( 'float64', ybuf, [ 2, 3 ], [ 3, 1 ], 0, 'row-major' );
*
* var out = concat( [ x, y ], -1 );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
* // returns <ndarray>[ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
*/

// MODULES //
Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/ndarray/concat/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ var base = require( './base.js' );
* @returns {ndarray} output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
Expand All @@ -61,10 +60,7 @@ var base = require( './base.js' );
* var y = new ndarray( 'float64', ybuf, [ 2, 3 ], [ 3, 1 ], 0, 'row-major' );
*
* var out = concat( [ x, y ], -1 );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
* // returns <ndarray>[ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
*/
function concat( arrays, dim ) {
var arrs;
Expand Down