Skip to content

docs: update examples #9688

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

Merged
kgryte merged 1 commit into from
Jan 11, 2026
Merged

docs: update examples #9688

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
24 changes: 4 additions & 20 deletions lib/node_modules/@stdlib/ndarray/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1214,7 +1214,6 @@ interface Namespace {
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
*
* function scale( z ) {
* if ( z > 5.0 ) {
Expand All @@ -1234,10 +1233,7 @@ interface Namespace {
* 'dtype': 'generic'
* };
* var y = ns.filterMap( x, opts, scale );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ 80.0, 90.0, 100.0 ]
* // returns <ndarray>[ 80.0, 90.0, 100.0 ]
*/
filterMap: typeof filterMap;

Expand Down Expand Up @@ -1360,16 +1356,12 @@ interface Namespace {
*
* @example
* var array = require( '@stdlib/ndarray/array' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
*
* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
* // returns <ndarray>
*
* var y = ns.flatten( x );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
*/
flatten: typeof flatten;

Expand All @@ -1388,7 +1380,6 @@ interface Namespace {
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
*
* function scale( value ) {
* return value * 2.0;
Expand All @@ -1407,10 +1398,7 @@ interface Namespace {
* };
*
* var y = ns.flattenBy( x, opts, scale );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
* // returns <ndarray>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
*/
flattenBy: typeof flattenBy;

Expand All @@ -1431,7 +1419,6 @@ interface Namespace {
* @example
* var array = require( '@stdlib/ndarray/array' );
* var shape = require( '@stdlib/ndarray/shape' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
*
* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
* // returns <ndarray>
Expand All @@ -1440,13 +1427,10 @@ interface Namespace {
* // returns [ 3, 1, 2 ]
*
* var y = ns.flattenFrom( x, 1 );
* // returns <ndarray>
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
*
* var shy = shape( y );
* // returns [ 3, 2 ]
*
* var arr = ndarray2array( y );
* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
*/
flattenFrom: typeof flattenFrom;

Expand Down
Loading