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 | 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 1x 1x 1x 1x 1x 27x 27x 27x 27x 27x 27x 27x 12x 12x 15x 27x 2x 2x 27x 4x 27x 11x 11x 15x 27x 27x 27x 1x 1x 1x 1x 1x | /**
* @license Apache-2.0
*
* Copyright (c) 2023 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 isNumber = require( '@stdlib/assert/is-number' ).isPrimitive;
var isAccessorArray = require( '@stdlib/array/base/assert/is-accessor-array' );
var isComplexDataType = require( '@stdlib/ndarray/base/assert/is-complex-floating-point-data-type' );
var accessorSetter = require( '@stdlib/array/base/accessor-setter' );
var setter = require( '@stdlib/array/base/setter' );
var zeros = require( '@stdlib/array/base/zeros' );
var buffer = require( '@stdlib/ndarray/base/buffer' );
var ndarray = require( '@stdlib/ndarray/base/ctor' );
var resolveStr = require( '@stdlib/ndarray/base/dtype-resolve-str' );
var format = require( '@stdlib/string/format' );
// MAIN //
/**
* Broadcasts a scalar value to an ndarray having a specified shape.
*
* @param {*} value - scalar value
* @param {*} dtype - output array data type
* @param {NonNegativeIntegerArray} shape - output array shape
* @param {string} order - memory layout (either row-major or column-major)
* @throws {TypeError} second argument must be a recognized data type
* @returns {ndarray} ndarray
*
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
* var getDType = require( '@stdlib/ndarray/dtype' );
*
* var x = broadcastScalar( 1.0, 'float64', [ 2, 2 ], 'row-major' );
* // returns <ndarray>
*
* var sh = getShape( x );
* // returns [ 2, 2 ]
*
* var dt = String( getDType( x ) );
* // returns 'float64'
*
* var v = x.get( 0, 1 );
* // returns 1.0
*/
function broadcastScalar( value, dtype, shape, order ) {
var buf;
var set;
var N;
buf = buffer( dtype, 1 );
if ( buf === null ) {
throw new TypeError( format( 'invalid argument. Second argument must be a recognized data type. Value: `%s`.', dtype ) );
}
dtype = resolveStr( dtype );
if ( isComplexDataType( dtype ) && isNumber( value ) ) {
value = [ value, 0.0 ]; // note: we're assuming that the ComplexXXArray setter accepts an array of interleaved real and imaginary components
}
if ( isAccessorArray( buf ) ) {
set = accessorSetter( dtype );
} else {
set = setter( dtype );
}
set( buf, 0, value );
N = shape.length || 1;
return new ndarray( dtype, buf, shape, zeros( N ), 0, order );
}
// EXPORTS //
module.exports = broadcastScalar;
|