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!
Multi-slice constructor.
npm install @stdlib/slice-multiAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch. - If you are using Deno, visit the
denobranch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
var MultiSlice = require( '@stdlib/slice-multi' );Returns a MultiSlice instance.
var Slice = require( '@stdlib/slice-ctor' );
var s = new Slice( 0, 10 );
// returns <Slice>
var ms = new MultiSlice( 2, s, null );
// returns <MultiSlice>The constructor accepts the following arguments:
- slice: a single-dimensional slice. May be either a
Slice,null,undefined, or an integer.
String value of the MultiSlice constructor name.
var str = MultiSlice.name;
// returns 'MultiSlice'Read-only property returning the number of slice dimensions.
var Slice = require( '@stdlib/slice-ctor' );
var s = new Slice( 0, 10 );
// returns <Slice>
var ms = new MultiSlice( 2, s, null );
// returns <MultiSlice>
var ndims = ms.ndims;
// returns 3Read-only property returning the slice data.
var Slice = require( '@stdlib/slice-ctor' );
var s = new Slice( 0, 10 );
// returns <Slice>
var ms = new MultiSlice( 2, s, null );
// returns <MultiSlice>
var data = ms.data;
// returns [ 2, <Slice>, null ]Serializes a MultiSlice as a string.
var Slice = require( '@stdlib/slice-ctor' );
var s = new Slice( 10 );
// returns <Slice>
var ms = new MultiSlice( 2, s, null );
// returns <MultiSlice>
var str = ms.toString();
// returns 'MultiSlice(2,Slice(null,10,null),null)'Serializes a MultiSlice as a JSON object.
var Slice = require( '@stdlib/slice-ctor' );
var s = new Slice( 10 );
// returns <Slice>
var ms = new MultiSlice( 2, s, null );
// returns <MultiSlice>
var o = ms.toJSON();
// returns { 'type': 'MultiSlice', 'data': [ 2, { 'type': 'Slice', 'data': [ null, 10, null ] }, null ] }JSON.stringify() implicitly calls this method when stringifying a MultiSlice 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). - Multi-slice instances have no explicit functionality; however, they are used by
ndarrayand other packages for creating views into multi-dimensional data structures.
var S = require( '@stdlib/slice-ctor' );
var MultiSlice = require( '@stdlib/slice-multi' );
// Alias `undefined` for more concise expressions:
var _ = void 0;
// Create a 6-dimensional slice:
var s = new MultiSlice( S( 9, -10, -1 ), S( 2, _, 2 ), 2, S( 5, _, 2 ), 3, _ );
// returns <MultiSlice>
// Serialize the slice to a string:
var str = s.toString();
console.log( str );
// => 'MultiSlice(Slice(9,-10,-1),Slice(2,null,2),2,Slice(5,null,2),3,null)'
// Serialize the slice to JSON:
var o = s.toJSON();
console.log( JSON.stringify( o ) );
// => '{"type":"MultiSlice","data":[{"type":"Slice","data":[9,-10,-1]},{"type":"Slice","data":[2,null,2]},2,{"type":"Slice","data":[5,null,2]},3,null]}'@stdlib/ndarray-ctor: multidimensional array constructor.@stdlib/slice-ctor: 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-2023. The Stdlib Authors.
