All files main.js

100% Statements 137/137
100% Branches 20/20
100% Functions 1/1
100% Lines 137/137

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 1381x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 4x 4x 28x 8x 8x 8x 6x 8x 2x 2x 8x 8x 16x 16x 16x 28x 8x 8x 16x 16x 16x 8x 8x 8x 6x 8x 2x 2x 8x 8x 8x 24x 8x 8x 6x 8x 2x 2x 24x 8x 8x 8x 8x 8x 8x 24x 8x 24x 24x 24x 28x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2022 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.
*/
 
'use strict';
 
// MODULES //
 
var isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major-string' );
var normalizeIndex = require( '@stdlib/ndarray/base/normalize-index' );
var getDType = require( '@stdlib/ndarray/base/dtype' );
var getShape = require( '@stdlib/ndarray/base/shape' );
var getStrides = require( '@stdlib/ndarray/base/strides' );
var getOffset = require( '@stdlib/ndarray/base/offset' );
var getOrder = require( '@stdlib/ndarray/base/order' );
var getData = require( '@stdlib/ndarray/base/data-buffer' );
var format = require( '@stdlib/string/format' );
 
 
// MAIN //
 
/**
* Expands the shape of an array by inserting a new dimension of size one at a specified axis.
*
* ## Notes
*
* -   A provided axis must reside on the interval `[-N-1, N]`, where `N` is the rank (i.e., number of dimensions) of the provided input array. If provided a negative `axis`, the axis position at which to insert a singleton dimension is computed as `N + axis + 1`. Hence, if provided `-1`, the resolved axis position is `N` (i.e., a singleton dimension is appended to the input array).
*
* @param {ndarray} x - input array
* @param {integer} axis - axis at which to insert a singleton dimension
* @param {boolean} writable - boolean indicating whether the returned ndarray should be writable
* @throws {RangeError} must provide a valid axis
* @returns {ndarray} output array
*
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
*
* var y = expandDimensions( x, 1, false );
* // returns <ndarray>[ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ]
*/
function expandDimensions( x, axis, writable ) {
	var strides;
	var shape;
	var isrm;
	var ord;
	var sh;
	var st;
	var d;
	var N;
	var i;
 
	sh = getShape( x, false );
	st = getStrides( x, false );
	ord = getOrder( x );
 
	isrm = isRowMajor( ord );
	N = sh.length;
 
	strides = [];
	shape = [];
 
	d = normalizeIndex( axis, N );
	if ( d === -1 ) {
		throw new RangeError( format( 'invalid argument. Specified axis is out-of-bounds. Must be on the interval: [-%u, %u]. Value: `%d`.', N+1, N, axis ) );
	}
	if ( d === 0 ) {
		// Prepend singleton dimension...
		shape.push( 1 );
		if ( isrm ) {
			strides.push( sh[ 0 ] * st[ 0 ] );
		} else {
			strides.push( st[ 0 ] );
		}
		// Copy remaining dimensions...
		for ( i = 0; i < N; i++ ) {
			shape.push( sh[ i ] );
			strides.push( st[ i ] );
		}
	} else if ( d === N ) {
		// Copy dimensions...
		for ( i = 0; i < N; i++ ) {
			shape.push( sh[ i ] );
			strides.push( st[ i ] );
		}
		// Append singleton dimension...
		shape.push( 1 );
		if ( isrm ) {
			strides.push( st[ N-1 ] );
		} else {
			strides.push( sh[ N-1 ] * st[ N-1 ] );
		}
	} else {
		// Insert a singleton dimension...
		for ( i = 0; i < N+1; i++ ) {
			if ( i === d ) {
				shape.push( 1 );
				if ( isrm ) {
					strides.push( st[ i-1 ] );
				} else { // ord === 'column-major'
					strides.push( st[ i ] );
				}
			} else if ( i < d ) {
				shape.push( sh[ i ] );
				strides.push( st[ i ] );
			} else { // i > d
				shape.push( sh[ i-1 ] );
				strides.push( st[ i-1 ] );
			}
		}
	}
	return new x.constructor( getDType( x ), getData( x ), shape, strides, getOffset( x ), ord, { // eslint-disable-line max-len
		'readonly': !writable
	});
}
 
 
// EXPORTS //
 
module.exports = expandDimensions;