https://github.com/stdlib-js/slice-ctor
Slice constructor.
https://github.com/stdlib-js/slice-ctor
constructor constructors ctor ctors data javascript node node-js nodejs python slice stdlib structure types
Last synced: 8 months ago
JSON representation
Slice constructor.
- Host: GitHub
- URL: https://github.com/stdlib-js/slice-ctor
- Owner: stdlib-js
- License: apache-2.0
- Created: 2023-09-21T12:38:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-23T01:16:21.000Z (8 months ago)
- Last Synced: 2025-06-23T02:22:46.953Z (8 months ago)
- Topics: constructor, constructors, ctor, ctors, data, javascript, node, node-js, nodejs, python, slice, stdlib, structure, types
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 357 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# Slice
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Slice constructor.
## Installation
```bash
npm install @stdlib/slice-ctor
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var Slice = require( '@stdlib/slice-ctor' );
```
#### Slice( \[stop] )
Returns a `Slice` instance.
```javascript
var s = new Slice();
// returns
s = new Slice();
// returns
```
The constructor accepts the following arguments:
- **stop**: ending index (exclusive). Default: `null`.
#### Slice( start, stop\[, step] )
Returns a `Slice` instance.
```javascript
var s = new Slice( 0, 10 );
// returns
s = new Slice( 0, 10, 1 );
// returns
```
The constructor accepts the following arguments:
- **start**: starting index (inclusive).
- **stop**: ending index (exclusive).
- **step**: index increment. A numeric index increment argument must be a non-zero integer value. Default: `null`.
* * *
### Properties
#### Slice.name
String value of the `Slice` constructor name.
```javascript
var str = Slice.name;
// returns 'Slice'
```
#### Slice.prototype.start
**Read-only** property returning the slice starting index.
```javascript
var s = new Slice( 10 );
// returns
var start = s.start;
// returns null
s = new Slice( 2, 10 );
// returns
start = s.start;
// returns 2
```
#### Slice.prototype.stop
**Read-only** property returning the slice ending index.
```javascript
var s = new Slice( null );
// returns
var stop = s.stop;
// returns null
s = new Slice( 10 );
// returns
stop = s.stop;
// returns 10
s = new Slice( 2, 10 );
// returns
stop = s.stop;
// returns 10
```
#### Slice.prototype.step
**Read-only** property returning the slice index increment.
```javascript
var s = new Slice( 10 );
// returns
var step = s.step;
// returns null
s = new Slice( 2, 10 );
// returns
step = s.step;
// returns null
s = new Slice( 2, 10, 1 );
// returns
step = s.step;
// returns 1
```
* * *
### Methods
#### Slice.prototype.toString()
Serializes a `Slice` as a string.
```javascript
var s = new Slice( 10 );
// returns
var str = s.toString();
// returns 'Slice(null,10,null)'
s = new Slice( 2, 10, 1 );
// returns
str = s.toString();
// returns 'Slice(2,10,1)'
```
#### Slice.prototype.toJSON()
Serializes a `Slice` as a [JSON][json] object.
```javascript
var s = new Slice( 10 );
// returns
var o = s.toJSON();
// returns { 'type': 'Slice', 'data': [ null, 10, null ] }
s = new Slice( 2, 10, 1 );
// returns
o = s.toJSON();
// returns { 'type': 'Slice', 'data': [ 2, 10, 1 ] }
```
`JSON.stringify()` implicitly calls this method when stringifying a `Slice` instance.
* * *
## Notes
- Slice arguments may be either integers, `null`, or `undefined`, where a non-integer value 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]).
- 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.
* * *
## Examples
```javascript
var Slice = require( '@stdlib/slice-ctor' );
var s = new Slice( 9, -10, -1 );
// returns
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]}'
```
* * *
## See Also
- [`@stdlib/ndarray-ctor`][@stdlib/ndarray/ctor]: multidimensional array constructor.
- [`@stdlib/slice-multi`][@stdlib/slice/multi]: multi-slice constructor.
* * *
## Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/slice-ctor.svg
[npm-url]: https://npmjs.org/package/@stdlib/slice-ctor
[test-image]: https://github.com/stdlib-js/slice-ctor/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/slice-ctor/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/slice-ctor/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/slice-ctor?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/slice-ctor/tree/deno
[deno-readme]: https://github.com/stdlib-js/slice-ctor/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/slice-ctor/tree/umd
[umd-readme]: https://github.com/stdlib-js/slice-ctor/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/slice-ctor/tree/esm
[esm-readme]: https://github.com/stdlib-js/slice-ctor/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/slice-ctor/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/slice-ctor/main/LICENSE
[json]: http://www.json.org/
[@stdlib/ndarray]: https://github.com/stdlib-js/ndarray
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor
[@stdlib/slice/multi]: https://github.com/stdlib-js/slice-multi