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
12 changes: 2 additions & 10 deletions lib/node_modules/@stdlib/ndarray/concat1d/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,16 +46,12 @@ Returns a one-dimensional [ndarray][@stdlib/ndarray/ctor] formed by concatenatin

```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 = concat1d( x, y );
// returns <ndarray>

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

The function accepts the following arguments:
Expand All @@ -71,20 +67,16 @@ Concatenates provided input arguments and assigns the result to a provided one-d
```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 ] );
var z = zeros( [ 8 ] );

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

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

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

The function accepts the following arguments:
Expand Down
30 changes: 6 additions & 24 deletions lib/node_modules/@stdlib/ndarray/concat1d/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,7 @@ interface Concat1d {
* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
*
* var out = concat1d( x, y );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
*/
<T = unknown>( arrays: Array<Input<T>> ): typedndarray<T>; // FIXME: this is a tricky one to type correctly, as the actual output dtype depends on type promotion rules

Expand All @@ -68,10 +65,7 @@ interface Concat1d {
* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
*
* var out = concat1d( x, y );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
*/
<T = unknown>( arg: Input<T>, ...arrays: Array<Input<T>> ): typedndarray<T>; // FIXME: this is a tricky one to type correctly, as the actual output dtype depends on type promotion rules

Expand All @@ -92,13 +86,10 @@ interface Concat1d {
* var z = empty( [ 10 ] );
*
* var out = concat1d.assign( [ x, y ], z );
* // returns <ndarray>
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
*
* var bool = ( out === z );
* // returns true
*
* var arr = ndarray2array( z );
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
*/
assign<T = unknown, U = unknown, V extends typedndarray<U> = typedndarray<U>>( args: ArrayLike<Input<T>>, out: V ): V;

Expand All @@ -121,13 +112,10 @@ interface Concat1d {
* var z = empty( [ 10 ] );
*
* var out = concat1d.assign( x, y, z );
* // returns <ndarray>
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
*
* var bool = ( out === z );
* // returns true
*
* var arr = ndarray2array( z );
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
*/
assign<T = unknown, U = unknown, V extends typedndarray<U> = typedndarray<U>>( arg1: Input<T>, arg2: Input<T> | V, ...args: Array<Input<T> | V> ): V; // FIXME: in order to more robustly return a correct output type here, we'd likely need to use overloads with varying arity. The issue here is that `V` needs to be the last argument, which is not captured here.
}
Expand All @@ -146,10 +134,7 @@ interface Concat1d {
* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
*
* var out = concat1d( x, y );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
*
* @example
* var array = require( '@stdlib/ndarray/array' );
Expand All @@ -161,13 +146,10 @@ interface Concat1d {
* var z = empty( [ 10 ] );
*
* var out = concat1d.assign( [ x, y ], z );
* // returns <ndarray>
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
*
* var bool = ( out === z );
* // returns true
*
* var arr = ndarray2array( z );
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
*/
declare var concat1d: Concat1d;

Expand Down
5 changes: 1 addition & 4 deletions lib/node_modules/@stdlib/ndarray/concat1d/lib/assign.js
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,10 @@ var DEFAULT_DTYPE = defaults.get( 'dtypes.default' );
* var z = empty( [ 10 ] );
*
* var out = assign( x, y, z );
* // returns <ndarray>
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
*
* var bool = ( out === z );
* // returns true
*
* var arr = ndarray2array( z );
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
*/
function assign() {
var nargs;
Expand Down
5 changes: 1 addition & 4 deletions lib/node_modules/@stdlib/ndarray/concat1d/lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,7 @@
* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
*
* var out = concat1d( x, y );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
*/

// MODULES //
Expand Down
5 changes: 1 addition & 4 deletions lib/node_modules/@stdlib/ndarray/concat1d/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,7 @@ var DEFAULT_DTYPE = defaults.get( 'dtypes.default' );
* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
*
* var out = concat1d( x, y );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
*/
function concat1d() {
var nargs;
Expand Down