All files / ndarraylike2scalar/lib main.js

89.28% Statements 50/56
100% Branches 1/1
0% Functions 0/1
89.28% Lines 50/56

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 571x 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  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 base = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
var format = require( '@stdlib/string/format' );
 
 
// MAIN //
 
/**
* Converts an ndarray-like object to a scalar value.
*
* @param {ndarrayLike} x - input ndarray
* @throws {TypeError} must provide an ndarray
* @returns {*} scalar value
*
* @example
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = scalar2ndarray( 1.0 );
* // returns <ndarray>[ 1.0 ]
*
* var out = ndarraylike2scalar( x );
* // returns 1.0
*/
function ndarraylike2scalar( x ) {
	if ( !isndarrayLike( x ) ) {
		throw new TypeError( format( 'invalid argument. Must provide an ndarray. Value: `%s`.', x ) );
	}
	return base( x );
}
 
 
// EXPORTS //
 
module.exports = ndarraylike2scalar;