Auto-generated commit

base/lib/index.js

@@ -490,6 +490,15 @@ setReadOnly( ns, 'shape2strides', require( './../../base/shape2strides' ) );
 */
 setReadOnly( ns, 'singletonDimensions', require( './../../base/singleton-dimensions' ) );
 
+/**
+* @name slice
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/slice}
+*/
+setReadOnly( ns, 'slice', require( './../../base/slice' ) );
+
 /**
 * @name strides2offset
 * @memberof ns

base/slice/README.md

@@ -0,0 +1,205 @@
+<!--
+
+@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.
+
+-->
+
+# slice
+
+> Return a read-only view of an input ndarray.
+
+<!-- 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 slice = require( '@stdlib/ndarray/base/slice' );
+```
+
+#### slice( x, slice, strict )
+
+Returns a **read-only** view of an input ndarray.
+
+```javascript
+var Slice = require( '@stdlib/slice/ctor' );
+var MultiSlice = require( '@stdlib/slice/multi' );
+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 s0 = new Slice( null, null, -2 );
+var s1 = new Slice( null, null, -1 );
+var s = new MultiSlice( s0, s1 );
+// returns <MultiSlice>
+
+var y = slice( x, s, false );
+// returns <ndarray>
+
+sh = y.shape;
+// returns [ 2, 2 ]
+
+arr = ndarray2array( y );
+// returns [ [ 6.0, 5.0 ], [ 2.0, 1.0 ] ]
+```
+
+The function accepts the following arguments:
+
+-   **x**: input ndarray.
+-   **slice**: a [`MultiSlice`][@stdlib/slice/multi] instance.
+-   **strict**: boolean indicating whether to enforce strict bounds checking.
+
+</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 E = require( '@stdlib/slice/multi' );
+var array = require( '@stdlib/ndarray/array' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var zeroTo = require( '@stdlib/array/base/zero-to' );
+var slice = require( '@stdlib/ndarray/base/slice' );
+
+// 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 s1 = E( 0, _, _ );
+var y1 = slice( x, s1, false );
+// returns <ndarray>
+
+var a1 = ndarray2array( y1 );
+// returns [ [ 0, 1, 2 ], [ 3, 4, 5 ], [ 6, 7, 8 ] ]
+
+var s2 = E( 1, _, _ );
+var y2 = slice( x, s2, false );
+// returns <ndarray>
+
+var a2 = ndarray2array( y2 );
+// returns [ [ 9, 10, 11 ], [ 12, 13, 14 ], [ 15, 16, 17 ] ]
+
+var s3 = E( 2, _, _ );
+var y3 = slice( x, s3, false );
+// returns <ndarray>
+
+var a3 = ndarray2array( y3 );
+// returns [ [ 18, 19, 20 ], [ 21, 22, 23 ], [ 24, 25, 26 ] ]
+
+// Reverse all elements:
+var s = S( _, _, -1 );
+var s4 = E( s, s, s );
+var y4 = slice( x, s4, false );
+// returns <ndarray>
+
+var a4 = ndarray2array( y4 );
+// returns [...]
+
+// Get the second rows from each matrix:
+var s5 = E( _, 1, _ );
+var y5 = slice( x, s5, false );
+// returns <ndarray>
+
+var a5 = ndarray2array( y5 );
+// returns [ [ 3, 4, 5 ], [ 12, 13, 14 ], [ 21, 22, 23 ] ]
+
+// Get the second columns from each matrix:
+var s6 = E( _, _, 1 );
+var y6 = slice( x, s6, false );
+// 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/slice/multi]: https://github.com/stdlib-js/stdlib
+
+</section>
+
+<!-- /.links -->