Skip to content
Open
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
52 changes: 9 additions & 43 deletions lib/node_modules/@stdlib/ndarray/slice-from/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,30 +46,23 @@ Returns a **read-only** shifted view of an input [ndarray][@stdlib/ndarray/ctor]

```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 ];
var strides = [ 2, 1 ];
var offset = 0;

var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
// returns <ndarray>
// returns <ndarray>[ [ 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 = sliceFrom( x, 1, null );
// returns <ndarray>
// returns <ndarray>[ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]

sh = y.shape;
// returns [ 2, 2 ]

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

The function accepts the following arguments:
Expand All @@ -87,41 +80,31 @@ The following example demonstrates each invocation style returning equivalent re

```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 ];
var strides = [ 2, 1 ];
var offset = 0;

var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
// returns <ndarray>
// returns <ndarray>[ [ 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 ] ]

// 1. Using an array of index arguments:
var y = sliceFrom( x, [ 1, null ] );
// returns <ndarray>
// returns <ndarray>[ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]

sh = y.shape;
// returns [ 2, 2 ]

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

// 2. Providing separate arguments:
y = sliceFrom( x, 1, null );
// returns <ndarray>
// returns <ndarray>[ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]

sh = y.shape;
// returns [ 2, 2 ]

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

The function supports the following `options`:
Expand All @@ -132,32 +115,25 @@ By default, the function throws an error when provided an index argument which e

```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 ];
var strides = [ 2, 1 ];
var offset = 0;

var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
// returns <ndarray>
// returns <ndarray>[ [ 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 = sliceFrom( x, null, 20, {
'strict': false
});
// returns <ndarray>

sh = y.shape;
// returns [ 3, 0 ]

arr = ndarray2array( y );
// returns []
```

</section>
Expand Down Expand Up @@ -187,7 +163,6 @@ arr = ndarray2array( y );

```javascript
var array = require( '@stdlib/ndarray/array' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var zeroTo = require( '@stdlib/array/base/zero-to' );
var sliceFrom = require( '@stdlib/ndarray/slice-from' );

Expand All @@ -201,24 +176,15 @@ var x = array( buf, {

// Get the last two rows of each matrix:
var y1 = sliceFrom( x, null, 1, null );
// returns <ndarray>

var a1 = ndarray2array( y1 );
// returns [ [ [ 3, 4, 5 ], [ 6, 7, 8 ] ], [ [ 12, 13, 14 ], [ 15, 16, 17 ] ], [ [ 21, 22, 23 ], [ 24, 25, 26 ] ] ]
// returns <ndarray>[ [ [ 3, 4, 5 ], [ 6, 7, 8 ] ], [ [ 12, 13, 14 ], [ 15, 16, 17 ] ], [ [ 21, 22, 23 ], [ 24, 25, 26 ] ] ]

// Get the last two rows and columns of each matrix:
var y2 = sliceFrom( x, null, 1, 1 );
// returns <ndarray>

var a2 = ndarray2array( y2 );
// returns [ [ [ 4, 5 ], [ 7, 8 ] ], [ [ 13, 14 ], [ 16, 17 ] ], [ [ 22, 23 ], [ 25, 26 ] ] ]
// returns <ndarray>[ [ [ 4, 5 ], [ 7, 8 ] ], [ [ 13, 14 ], [ 16, 17 ] ], [ [ 22, 23 ], [ 25, 26 ] ] ]

// Get the last two 2x2 matrices:
var y3 = sliceFrom( x, 1, 1, 1 );
// returns <ndarray>

var a3 = ndarray2array( y3 );
// returns [ [ [ 13, 14 ], [ 16, 17 ] ], [ [ 22, 23 ], [ 25, 26 ] ] ]
// returns <ndarray>[ [ [ 13, 14 ], [ 16, 17 ] ], [ [ 22, 23 ], [ 25, 26 ] ] ]
```

</section>
Expand Down
4 changes: 1 addition & 3 deletions lib/node_modules/@stdlib/ndarray/slice-from/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,9 @@
> x.shape
[ 2, 2 ]
> var y = {{alias}}( x, 0, 1 )
<ndarray>
<ndarray>[ [ 2 ], [ 4 ] ]
> y.shape
[ 2, 1 ]
> {{alias:@stdlib/ndarray/to-array}}( y )
[ [ 2 ], [ 4 ] ]

See Also
--------
Expand Down
Loading
Loading