Expand the shape of an array to a specified dimensionality by spreading its dimensions to specified dimension indices and inserting dimensions of size one for the remaining dimensions.
npm install @stdlib/ndarray-base-spread-dimensionsWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Expand the shape of an array to a specified dimensionality by spreading its dimensions to specified dimension indices and inserting dimensions of size one for the remaining dimensions.
``bash`
npm install @stdlib/ndarray-base-spread-dimensions
`javascript`
var spreadDimensions = require( '@stdlib/ndarray-base-spread-dimensions' );
#### spreadDimensions( ndims, x, dims, writable )
Expands the shape of an array to a specified dimensionality by spreading its dimensions to specified dimension indices and inserting dimensions of size one for the remaining dimensions.
`javascript
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var array = require( '@stdlib/ndarray-array' );
// Create a 2x2 ndarray:
var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
// returns
// Prepend a singleton dimension:
var y = spreadDimensions( 3, x, [ 1, 2 ], false );
// returns
var sh = y.shape;
// returns [ 1, 2, 2 ]
var a = ndarray2array( y );
// returns [ [ [ 1, 2 ], [ 3, 4 ] ] ]
// Append a singleton dimension:
y = spreadDimensions( 3, x, [ 0, 1 ], false );
// returns
sh = y.shape;
// returns [ 2, 2, 1 ]
a = ndarray2array( y );
// returns [ [ [ 1 ], [ 2 ] ], [ [ 3 ], [ 4 ] ] ]
// Insert a singleton dimension:
y = spreadDimensions( 3, x, [ 0, 2 ], false );
// returns
sh = y.shape;
// returns [ 2, 1, 2 ]
a = ndarray2array( y );
// returns [ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ]
`
The function accepts the following arguments:
- ndims: number of dimensions in the output ndarray. Must be greater than or equal to the number of dimensions in the input ndarray.
- x: input ndarray.
- dims: dimension indices specifying where to place the dimensions of the input ndarray. Must resolve to normalized indices arranged in ascending order.
- writable: boolean indicating whether a returned ndarray should be writable.
- Each provided dimension index must reside on the interval [-ndims, ndims-1]. If provided a negative dimension index, the position at which to place a respective dimension is computed as ndims + index.writable
- Provided dimension indices must resolve to normalized dimension indices arranged in ascending order.
- The parameter only applies to ndarray constructors supporting read-only instances.
`javascript
var array = require( '@stdlib/ndarray-array' );
var numel = require( '@stdlib/ndarray-base-numel' );
var ind2sub = require( '@stdlib/ndarray-ind2sub' );
var spreadDimensions = require( '@stdlib/ndarray-base-spread-dimensions' );
// Create a 2-dimensional array:
var x = array( [ [ 1, 2 ], [ 3, 4 ] ], {
'order': 'column-major'
});
// returns
// Spread dimensions:
var y = spreadDimensions( 5, x, [ 1, 3 ], false );
// returns
// Retrieve the shape:
var sh = y.shape;
// returns [ 1, 2, 1, 2, 1 ]
// Retrieve the number of elements:
var N = numel( sh );
// Loop through the array elements...
var i;
for ( i = 0; i < N; i++ ) {
console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) );
}
`
*
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]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-base-spread-dimensions.svg
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-spread-dimensions
[test-image]: https://github.com/stdlib-js/ndarray-base-spread-dimensions/actions/workflows/test.yml/badge.svg?branch=v0.1.1
[test-url]: https://github.com/stdlib-js/ndarray-base-spread-dimensions/actions/workflows/test.yml?query=branch:v0.1.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-spread-dimensions/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-spread-dimensions?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[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/ndarray-base-spread-dimensions/tree/deno
[deno-readme]: https://github.com/stdlib-js/ndarray-base-spread-dimensions/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/ndarray-base-spread-dimensions/tree/umd
[umd-readme]: https://github.com/stdlib-js/ndarray-base-spread-dimensions/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/ndarray-base-spread-dimensions/tree/esm
[esm-readme]: https://github.com/stdlib-js/ndarray-base-spread-dimensions/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/ndarray-base-spread-dimensions/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-spread-dimensions/main/LICENSE