All files main.js

97.53% Statements 79/81
88.88% Branches 8/9
100% Functions 1/1
97.53% Lines 79/81

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 822x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 19x 19x 19x 19x 19x 19x 19x 15x 15x 4x 19x     4x 4x 19x 8x 8x 8x 8x 4x 4x 19x 2x 2x 2x 2x 2x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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 isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var ndims = require( '@stdlib/ndarray/base/ndims' );
var getDType = require( '@stdlib/ndarray/dtype' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var concat1d = require( '@stdlib/ndarray/concat1d' );
var format = require( '@stdlib/string/format' );
 
 
// MAIN //
 
/**
* Returns a one-dimensional ndarray formed by prepending the provided scalar values to the input ndarray.
*
* @param {ndarray} x - input ndarray
* @param {...*} values - scalar values
* @throws {TypeError} first argument must a be one-dimensional ndarray
* @throws {Error} must be provided at least two arguments
* @returns {ndarray} output ndarray
*
* @example
* var array = require( '@stdlib/ndarray/array' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
*
* var x = array( [ 1.0, 2.0, 3.0, 4.0 ] );
*
* var out = unshift( x, -2.0, -1.0, 0.0 );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ -2.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
*/
function unshift( x ) {
	var nargs;
	var dtype;
	var args;
	var i;
 
	if ( !isndarrayLike( x ) || ndims( x ) !== 1 ) {
		throw new TypeError( format( 'invalid argument. First argument must be a one-dimensional ndarray. Value: `%s`.', x ) );
	}
	nargs = arguments.length;
	if ( nargs < 2 ) {
		throw new Error( format( 'invalid argument. The function must be provided at least two arguments. Value: `%s`.', nargs ) );
	}
	args = [];
	dtype = getDType( x );
	for ( i = 1; i < nargs; i++ ) {
		args.push( scalar2ndarray( arguments[ i ], {
			'dtype': dtype
		}));
	}
	args.push( x );
	return concat1d( args );
}
 
 
// EXPORTS //
 
module.exports = unshift;