Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 3 additions & 15 deletions lib/node_modules/@stdlib/ndarray/flatten-from/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,12 @@ Returns a copy of an input [ndarray][@stdlib/ndarray/ctor] where all dimensions

```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 ] ], [ [ 5.0, 6.0 ] ] ] );
// returns <ndarray>

var y = flattenFrom( x, 1 );
// 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 ] ]
```

The function accepts the following arguments:
Expand All @@ -77,40 +73,32 @@ By default, the input [ndarray][@stdlib/ndarray/ctor] is flattened in lexicograp

```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 ] ], [ [ 5.0, 6.0 ] ] ] );
// returns <ndarray>

var y = flattenFrom( x, 0, {
'order': 'column-major'
});
// returns <ndarray>

var arr = ndarray2array( y );
// returns [ 1.0, 3.0, 5.0, 2.0, 4.0, 6.0 ]
// returns <ndarray>[ 1.0, 3.0, 5.0, 2.0, 4.0, 6.0 ]
```

By default, the output ndarray [data type][@stdlib/ndarray/dtypes] is inferred from the input [ndarray][@stdlib/ndarray/ctor]. To return an ndarray with a different [data type][@stdlib/ndarray/dtypes], specify the `dtype` option.

```javascript
var array = require( '@stdlib/ndarray/array' );
var dtype = require( '@stdlib/ndarray/dtype' );
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 = flattenFrom( x, 0, {
'dtype': 'float32'
});
// returns <ndarray>
// returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]

var dt = String( dtype( y ) );
// returns 'float32'

var arr = ndarray2array( y );
// returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
```

</section>
Expand Down
5 changes: 2 additions & 3 deletions lib/node_modules/@stdlib/ndarray/flatten-from/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,8 @@
Examples
--------
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
> var y = {{alias}}( x, 0 );
> var arr = {{alias:@stdlib/ndarray/to-array}}( y )
[ 1.0, 2.0, 3.0, 4.0 ]
> var y = {{alias}}( x, 0 )
<ndarray>[ 1.0, 2.0, 3.0, 4.0 ]

See Also
--------
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@ type Options<U> = BaseOptions & {
* @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 @@ -80,13 +79,10 @@ type Options<U> = BaseOptions & {
* // returns [ 3, 1, 2 ]
*
* var y = 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 ] ]
*/
declare function flattenFrom<T extends ndarray>( x: T, dim: number, options?: BaseOptions ): T;

Expand All @@ -107,7 +103,6 @@ declare function flattenFrom<T extends ndarray>( x: T, dim: number, options?: Ba
* @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 @@ -116,13 +111,10 @@ declare function flattenFrom<T extends ndarray>( x: T, dim: number, options?: Ba
* // returns [ 3, 1, 2 ]
*
* var y = 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 ] ]
*/
declare function flattenFrom<T = unknown, U extends keyof DataTypeMap<T> = 'generic'>( x: typedndarray<T>, dim: number, options: Options<U> ): DataTypeMap<T>[U];

Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/ndarray/flatten-from/lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
*
* @example
* var array = require( '@stdlib/ndarray/array' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var flattenFrom = require( '@stdlib/ndarray/flatten-from' );
*
* // Create an input ndarray:
Expand All @@ -34,10 +33,7 @@
*
* // Flatten the input ndarray:
* var y = flattenFrom( x, 1 );
* // 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 ] ]
*/

// MODULES //
Expand Down
78 changes: 13 additions & 65 deletions lib/node_modules/@stdlib/ndarray/flatten-from/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -64,20 +64,15 @@ var COL_MAJOR = 'column-major';
*
* @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 = flattenFrom( x, 1 );
* // 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 ] ]
*
* @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 ], {
* 'shape': [ 2, 3 ],
Expand All @@ -86,14 +81,10 @@ var COL_MAJOR = 'column-major';
* // returns <ndarray>
*
* var y = flattenFrom( x, 0 );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ 1.0, 3.0, 5.0, 2.0, 4.0, 6.0 ]
* // returns <ndarray>[ 1.0, 3.0, 5.0, 2.0, 4.0, 6.0 ]
*
* @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 ], {
* 'shape': [ 2, 3 ],
Expand All @@ -104,14 +95,10 @@ var COL_MAJOR = 'column-major';
* var y = flattenFrom( x, 0, {
* 'order': 'column-major'
* });
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ]
* // returns <ndarray>[ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ]
*
* @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 ], {
* 'shape': [ 2, 3 ],
Expand All @@ -122,14 +109,10 @@ var COL_MAJOR = 'column-major';
* var y = flattenFrom( x, 0, {
* 'order': 'row-major'
* });
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ 1.0, 3.0, 5.0, 2.0, 4.0, 6.0 ]
* // returns <ndarray>[ 1.0, 3.0, 5.0, 2.0, 4.0, 6.0 ]
*
* @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 ], {
* 'shape': [ 2, 3 ],
Expand All @@ -140,14 +123,10 @@ var COL_MAJOR = 'column-major';
* var y = flattenFrom( x, 0, {
* 'order': 'same'
* });
* // 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 ]
*
* @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 ], {
* 'shape': [ 2, 3 ],
Expand All @@ -158,29 +137,21 @@ var COL_MAJOR = 'column-major';
* var y = flattenFrom( x, 0, {
* 'order': 'same'
* });
* // 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 ]
*
* @example
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
*
* var xbuf = [ 1.0, null, 2.0, null, 3.0, null, 4.0, null, 5.0, null, 6.0, null ];
*
* var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -6, -2 ], 10, 'row-major' );
* // returns <ndarray>
*
* var y = flattenFrom( x, 0 );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ]
* // returns <ndarray>[ 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ]
*
* @example
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
*
* var xbuf = [ 1.0, null, 2.0, null, 3.0, null, 4.0, null, 5.0, null, 6.0, null ];
*
Expand All @@ -189,14 +160,10 @@ var COL_MAJOR = 'column-major';
* // returns <ndarray>
*
* var y = flattenFrom( x, 0 );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ]
* // returns <ndarray>[ 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ]
*
* @example
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
*
* var xbuf = [ 1.0, null, 2.0, null, 3.0, null, 4.0, null, 5.0, null, 6.0, null ];
*
Expand All @@ -207,14 +174,10 @@ var COL_MAJOR = 'column-major';
* var y = flattenFrom( x, 0, {
* 'order': 'same'
* });
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ 6.0, 3.0, 5.0, 2.0, 4.0, 1.0 ]
* // returns <ndarray>[ 6.0, 3.0, 5.0, 2.0, 4.0, 1.0 ]
*
* @example
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
*
* var xbuf = [ 1.0, null, 2.0, null, 3.0, null, 4.0, null, 5.0, null, 6.0, null ];
*
Expand All @@ -225,14 +188,10 @@ var COL_MAJOR = 'column-major';
* var y = flattenFrom( x, 0, {
* 'order': 'any'
* });
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ]
* // returns <ndarray>[ 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ]
*
* @example
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
*
* var xbuf = [ 1.0, null, 2.0, null, 3.0, null, 4.0, null, 5.0, null, 6.0, null ];
*
Expand All @@ -241,14 +200,10 @@ var COL_MAJOR = 'column-major';
* // returns <ndarray>
*
* var y = flattenFrom( x, 0 );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ 6.0, 4.0, 2.0, 5.0, 3.0, 1.0 ]
* // returns <ndarray>[ 6.0, 4.0, 2.0, 5.0, 3.0, 1.0 ]
*
* @example
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
*
* var xbuf = [ 1.0, null, 2.0, null, 3.0, null, 4.0, null, 5.0, null, 6.0, null ];
*
Expand All @@ -259,14 +214,10 @@ var COL_MAJOR = 'column-major';
* var y = flattenFrom( x, 0, {
* 'order': 'same'
* });
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ 6.0, 4.0, 2.0, 5.0, 3.0, 1.0 ]
* // returns <ndarray>[ 6.0, 4.0, 2.0, 5.0, 3.0, 1.0 ]
*
* @example
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
*
* var xbuf = [ 1.0, null, 2.0, null, 3.0, null, 4.0, null, 5.0, null, 6.0, null ];
*
Expand All @@ -277,10 +228,7 @@ var COL_MAJOR = 'column-major';
* var y = flattenFrom( x, 0, {
* 'order': 'any'
* });
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ]
* // returns <ndarray>[ 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ]
*/
function flattenFrom( x, dim, options ) {
var view;
Expand Down