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 constructor.
npm install @stdlib/slice-ctor
var Slice = require( '@stdlib/slice-ctor' );
Returns a Slice
instance.
var s = new Slice();
// returns <Slice>
s = new Slice();
// returns <Slice>
The constructor accepts the following arguments:
-
stop: ending index (exclusive). Default:
null
.
Returns a Slice
instance.
var s = new Slice( 0, 10 );
// returns <Slice>
s = new Slice( 0, 10, 1 );
// returns <Slice>
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
.
String value of the Slice
constructor name.
var str = Slice.name;
// returns 'Slice'
Read-only property returning the slice starting index.
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
Read-only property returning the slice ending index.
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
Read-only property returning the slice index increment.
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
Serializes a Slice
as a string.
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)'
Serializes a Slice
as a JSON object.
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.
- Slice arguments may be either integers,
null
, orundefined
, 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 anndarray
). - Slice instances have no explicit functionality; however, they are used by
ndarray
and other packages for creating views into multi-dimensional data structures.
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]}'
-
@stdlib/ndarray-ctor
: multidimensional array constructor. -
@stdlib/slice-multi
: multi-slice constructor.
This package is part of 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, see the main project repository.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.