Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Oct 13, 2023
1 parent efdd375 commit 2760136
Show file tree
Hide file tree
Showing 22 changed files with 3,706 additions and 21 deletions.
3 changes: 2 additions & 1 deletion array/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@
"multidimensional",
"dimensions",
"dims",
"numpy.array"
"numpy.array",
"numpy.asarray"
],
"__stdlib__": {}
}
2 changes: 1 addition & 1 deletion base/slice-dimension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ limitations under the License.
-->

# slice
# sliceDimension

> Return a view of an input ndarray when sliced along a specified dimension.
Expand Down
4 changes: 2 additions & 2 deletions base/slice-dimension/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ declare function sliceDimension( x: uint8cndarray, dim: number, s: Slice | numbe
* // returns [ 3, 2 ]
*
* var s = new Slice( null, null, -1 );
* // returns <MultiSlice>
* // returns <Slice>
*
* var y = sliceDimension( x, 0, s, false, false );
* // returns <ndarray>
Expand Down Expand Up @@ -485,7 +485,7 @@ declare function sliceDimension( x: complex128ndarray, dim: number, s: Slice | n
* // returns [ 3, 2 ]
*
* var s = new Slice( null, null, -1 );
* // returns <MultiSlice>
* // returns <Slice>
*
* var y = sliceDimension( x, 0, s, false, false );
* // returns <ndarray>
Expand Down
14 changes: 7 additions & 7 deletions base/slice-dimension/docs/types/test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -129,13 +129,13 @@ import sliceDimension = require( './index' );
const x = empty( 'float64', [ 2, 2 ], 'row-major' );
const s = new Slice( null );

sliceDimension( x, s, '5', false ); // $ExpectError
sliceDimension( x, s, 5, false ); // $ExpectError
sliceDimension( x, s, null, false ); // $ExpectError
sliceDimension( x, s, undefined, false ); // $ExpectError
sliceDimension( x, s, [ '5' ], false ); // $ExpectError
sliceDimension( x, s, {}, false ); // $ExpectError
sliceDimension( x, s, ( x: number ): number => x, false ); // $ExpectError
sliceDimension( x, 1, s, '5', false ); // $ExpectError
sliceDimension( x, 1, s, 5, false ); // $ExpectError
sliceDimension( x, 1, s, null, false ); // $ExpectError
sliceDimension( x, 1, s, undefined, false ); // $ExpectError
sliceDimension( x, 1, s, [ '5' ], false ); // $ExpectError
sliceDimension( x, 1, s, {}, false ); // $ExpectError
sliceDimension( x, 1, s, ( x: number ): number => x, false ); // $ExpectError
}

// The compiler throws an error if the function is provided a fifth argument which is not a boolean...
Expand Down
4 changes: 3 additions & 1 deletion broadcast-array/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,9 @@
"utilities",
"utility",
"utils",
"util"
"util",
"broadcast_to",
"numpy.broadcast_to"
],
"__stdlib__": {}
}
2 changes: 1 addition & 1 deletion dist/index.js

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions dist/index.js.map

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion empty-like/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
"vector",
"ndarray",
"matrix",
"empty"
"empty",
"numpy.empty_like"
]
}
3 changes: 2 additions & 1 deletion empty/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
"vector",
"ndarray",
"matrix",
"empty"
"empty",
"numpy.empty"
]
}
9 changes: 9 additions & 0 deletions lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,15 @@ setReadOnly( ns, 'ndslice', require( './../slice' ) );
*/
setReadOnly( ns, 'ndsliceAssign', require( './../slice-assign' ) );

/**
* @name ndsliceDimension
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/ndarray/slice-dimension}
*/
setReadOnly( ns, 'ndsliceDimension', require( './../slice-dimension' ) );

/**
* @name ndarrayStrides
* @memberof ns
Expand Down
238 changes: 238 additions & 0 deletions slice-dimension/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,238 @@
<!--
@license Apache-2.0
Copyright (c) 2023 The Stdlib Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

# sliceDimension

> Return a read-only view of an input [`ndarray`][@stdlib/ndarray/ctor] when sliced along a specified dimension.
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- Package usage documentation. -->

<section class="usage">

## Usage

```javascript
var sliceDimension = require( '@stdlib/ndarray/slice-dimension' );
```

#### sliceDimension( x, dim, slice\[, options] )

Returns a **read-only** view of an input [`ndarray`][@stdlib/ndarray/ctor] when sliced along a specified dimension.

```javascript
var Slice = require( '@stdlib/slice/ctor' );
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>

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 s = new Slice( null, null, -1 );
// returns <Slice>

var y = sliceDimension( x, 0, s );
// returns <ndarray>

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

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

The function accepts the following arguments:

- **x**: input [`ndarray`][@stdlib/ndarray/ctor].
- **dim**: index of dimension along which to slice. If provided an integer less than zero, the dimension index is resolved relative to the last dimension, with the last dimension corresponding to the value `-1`.
- **slice**: a [`Slice`][@stdlib/slice/ctor] instance, `null`, `undefined`, or an integer. If provided `null` or `undefined`, the argument is equivalent to `new Slice()` (i.e., the returned view should include all elements along a specified dimension). If provided an integer less than zero, the corresponding element along the specified dimension is resolved relative to the last element along that dimension. For negative integers, the last element corresponds to the value `-1`.
- **options**: function options.

The function supports the following `options`:

- **strict**: boolean indicating whether to enforce strict bounds checking.

By default, the function throws an error when provided a slice which exceeds array bounds. To return an empty array when a slice exceeds array bounds, set the `strict` option to `false`.

```javascript
var Slice = require( '@stdlib/slice/ctor' );
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>

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 s = new Slice( 10, 20, 2 );
// returns <Slice>

var y = sliceDimension( x, 1, s, {
'strict': false
});
// returns <ndarray>

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

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

</section>

<!-- /.usage -->

<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- Package usage examples. -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

<!-- eslint-disable new-cap -->

```javascript
var S = require( '@stdlib/slice/ctor' );
var array = require( '@stdlib/ndarray/array' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var zeroTo = require( '@stdlib/array/base/zero-to' );
var sliceDimension = require( '@stdlib/ndarray/slice-dimension' );

// Alias `null` to allow for more compact indexing expressions:
var _ = null;

// Create a linear ndarray buffer:
var buf = zeroTo( 27 );

// Create an ndarray:
var x = array( buf, {
'shape': [ 3, 3, 3 ]
});

// Get each matrix...
var y1 = sliceDimension( x, 0, 0 );
// returns <ndarray>

var a1 = ndarray2array( y1 );
// returns [ [ 0, 1, 2 ], [ 3, 4, 5 ], [ 6, 7, 8 ] ]

var y2 = sliceDimension( x, 0, 1 );
// returns <ndarray>

var a2 = ndarray2array( y2 );
// returns [ [ 9, 10, 11 ], [ 12, 13, 14 ], [ 15, 16, 17 ] ]

var y3 = sliceDimension( x, 0, 2 );
// returns <ndarray>

var a3 = ndarray2array( y3 );
// returns [ [ 18, 19, 20 ], [ 21, 22, 23 ], [ 24, 25, 26 ] ]

// Reverse the matrix order:
var s = S( _, _, -1 );
var y4 = sliceDimension( x, 0, s );
// returns <ndarray>

var a4 = ndarray2array( y4 );
// returns [...]

// Get the second rows from each matrix:
var y5 = sliceDimension( x, 1, 1 );
// returns <ndarray>

var a5 = ndarray2array( y5 );
// returns [ [ 3, 4, 5 ], [ 12, 13, 14 ], [ 21, 22, 23 ] ]

// Get the second columns from each matrix:
var y6 = sliceDimension( x, 2, 1 );
// returns <ndarray>

var a6 = ndarray2array( y6 );
// returns [ [ 1, 4, 7 ], [ 10, 13, 16 ], [ 19, 22, 25 ] ]
```

</section>

<!-- /.examples -->

<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="references">

</section>

<!-- /.references -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor

[@stdlib/slice/ctor]: https://github.com/stdlib-js/stdlib

</section>

<!-- /.links -->
Loading

0 comments on commit 2760136

Please sign in to comment.