JavaTypedScript
diff --git a/‎lib/node_modules/@stdlib/slice/ctor/README.md‎
Lines changed: 286 additions & 0 deletions b/‎lib/node_modules/@stdlib/slice/ctor/README.md‎
Lines changed: 286 additions & 0 deletions
@@ -0,0 +1,286 @@
+<!--
+
+@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
+
+> Slice constructor.
+
+<!-- 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/slice/ctor' );
+```
+
+<a name="main"></a>
+
+#### Slice( \[start, ]stop\[, step] )
+
+Returns a `Slice` instance.
+
+```javascript
+var s = new Slice( 0, 10, 1 );
+// returns <Slice>
+```
+
+The constructor has the following parameters:
+
+-   **start**: starting index (inclusive). Default: `null`.
+-   **stop**: ending index (exclusive).
+-   **step**: index increment. Default: `null`.
+
+Slice arguments may be either integers or `null`, where the latter indicates a slice parameter which should be determined based on the slice context (e.g., when used to index into an [`ndarray`][@stdlib/ndarray/ctor]).
+
+* * *
+
+### Properties
+
+<a name="static-prop-name"></a>
+
+#### Slice.name
+
+String value of the `Slice` constructor name.
+
+```javascript
+var str = Slice.name;
+// returns 'Slice'
+```
+
+<a name="prop-start"></a>
+
+#### Slice.prototype.start
+
+**Read-only** property returning the slice starting index.
+
+```javascript
+var s = new Slice( 10 );
+// returns <Slice>
+
+var start = s.start;
+// returns null
+
+s = new Slice( 2, 10 );
+// returns <Slice>
+
+start = s.start;
+// returns 2
+```
+
+<a name="prop-stop"></a>
+
+#### Slice.prototype.stop
+
+**Read-only** property returning the slice ending index.
+
+<!-- eslint-disable no-global-assign, stdlib/no-redeclare -->
+
+```javascript
+var s = new Slice( null );
+// returns <Slice>
+
+var stop = s.stop;
+// returns null
+
+s = new Slice( 10 );
+// returns <Slice>
+
+stop = s.stop;
+// returns 10
+
+s = new Slice( 2, 10 );
+// returns <Slice>
+
+stop = s.stop;
+// returns 10
+```
+
+<a name="prop-step"></a>
+
+#### Slice.prototype.step
+
+**Read-only** property returning the slice index increment.
+
+```javascript
+var s = new Slice( 10 );
+// returns <Slice>
+
+var step = s.step;
+// returns null
+
+s = new Slice( 2, 10 );
+// returns <Slice>
+
+step = s.step;
+// returns null
+
+s = new Slice( 2, 10, 1 );
+// returns <Slice>
+
+step = s.step;
+// returns 1
+```
+
+* * *
+
+### Methods
+
+<a name="method-to-string"></a>
+
+#### Slice.prototype.toString()
+
+Serializes a `Slice` as a string.
+
+```javascript
+var s = new Slice( 10 );
+// returns <Slice>
+
+var str = s.toString();
+// returns 'Slice(null,10,null)'
+
+s = new Slice( 2, 10, 1 );
+// returns <Slice>
+
+str = s.toString();
+// returns 'Slice(2,10,1)'
+```
+
+<a name="method-to-json"></a>
+
+#### ndarray.prototype.toJSON()
+
+Serializes a `Slice` as a [JSON][json] object.
+
+```javascript
+var s = new Slice( 10 );
+// returns <Slice>
+
+var o = s.toJSON();
+// returns { 'type': 'Slice', 'data': [ null, 10, null ] }
+
+s = new Slice( 2, 10, 1 );
+// returns <Slice>
+
+o = s.toJSON();
+// returns { 'type': 'Slice', 'data': [ 2, 10, 1 ] }
+```
+
+`JSON.stringify()` implicitly calls this method when stringifying a `Slice` instance.
+
+</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">
+
+## Notes
+
+-   Slice instances have no explicit functionality; however, they are used by [`ndarray`][@stdlib/ndarray] and other packages for creating views into multi-dimensional data structures.
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+* * *
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+<!-- eslint-disable no-global-assign, stdlib/no-redeclare -->
+
+```javascript
+var Slice = require( '@stdlib/slice/ctor' );
+
+var s = new Slice( 9, -10, -1 );
+// returns <Slice>
+
+var start = s.start;
+console.log( 'Start: %d', start );
+// => 'Start: 9'
+
+var stop = s.stop;
+console.log( 'Stop: %d', stop );
+// => 'Stop: -10'
+
+var step = s.step;
+console.log( 'Step: %d', step );
+// => 'Step: -1'
+
+var str = s.toString();
+console.log( str );
+// => 'Slice(9,-10,-1)'
+
+var o = s.toJSON();
+console.log( JSON.stringify( o ) );
+// => '{"type":"Slice","data":[9,-10,-1]}'
+```
+
+</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">
+
+[json]: http://www.json.org/
+
+[@stdlib/ndarray]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray
+
+[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
+
+</section>
+
+<!-- /.links -->