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 138 139 140 141 142 143 144 145 146 | 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 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 hasOwnProp = require( '@stdlib/assert/has-own-property' );
var isComplexDataType = require( '@stdlib/ndarray/base/assert/is-complex-floating-point-data-type' );
var isEmptyCollection = require( '@stdlib/assert/is-empty-collection' );
var isNonNegativeIntegerArray = require( '@stdlib/assert/is-nonnegative-integer-array' ).primitives;
var isAccessorArray = require( '@stdlib/array/base/assert/is-accessor-array' );
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var isPlainObject = require( '@stdlib/assert/is-plain-object' );
var isNumber = require( '@stdlib/assert/is-number' ).isPrimitive;
var accessorSetter = require( '@stdlib/array/base/accessor-setter' );
var zeros = require( '@stdlib/array/zeros' );
var setter = require( '@stdlib/array/base/setter' );
var buffer = require( '@stdlib/ndarray/base/buffer' );
var getDType = require( '@stdlib/ndarray/dtype' );
var getShape = require( '@stdlib/ndarray/shape' );
var getOrder = require( '@stdlib/ndarray/order' );
var ndarray = require( '@stdlib/ndarray/ctor' );
var format = require( '@stdlib/string/format' );
// MAIN //
/**
* Broadcasts a scalar value to an ndarray having the same shape and data type as a provided input ndarray.
*
* ## Notes
*
* - If `value` is a number and the resolved data type is a complex data type, the function returns an ndarray containing a complex number whose real component equals the provided scalar `value` and whose imaginary component is zero.
* - The function does not guard against precision loss when `value` is a number and the resolved data type is an integer data type.
*
* @param {ndarray} x - input ndarray
* @param {*} value - scalar value
* @param {Options} [options] - function options
* @param {*} [options.dtype] - output array data type
* @param {NonNegativeIntegerArray} [options.shape] - output array shape
* @param {string} [options.order] - memory layout (either row-major or column-major)
* @param {boolean} [options.readonly=false] - boolean indicating whether an array should be read-only
* @throws {TypeError} first argument must be an ndarray
* @throws {TypeError} options argument must be an object
* @throws {TypeError} `shape` option must be an array of nonnegative integers
* @throws {TypeError} `dtype` option must be a recognized data type
* @returns {ndarray} ndarray
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 2, 2 ], {
* 'dtype': 'float32'
* });
* // returns <ndarray>
*
* var y = broadcastScalarLike( x, 1.0 );
* // returns <ndarray>[ [ 1.0, 1.0 ], [ 1.0, 1.0 ] ]
*
* var dt = String( getDType( y ) );
* // returns 'float32'
*/
function broadcastScalarLike( x, value, options ) {
var opts;
var buf;
var set;
var sh;
var dt;
var v;
var N;
if ( !isndarrayLike( x ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an ndarray-like object. Value: `%s`.', x ) );
}
opts = {
'dtype': getDType( x ),
'shape': getShape( x ),
'order': getOrder( x ),
'readonly': false
};
if ( arguments.length > 2 ) {
if ( !isPlainObject( options ) ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
}
if ( hasOwnProp( options, 'dtype' ) ) {
opts.dtype = options.dtype;
}
if ( hasOwnProp( options, 'shape' ) ) {
if (
!isNonNegativeIntegerArray( options.shape ) &&
!isEmptyCollection( options.shape )
) {
throw new TypeError( format( 'invalid option. `%s` option must be an array of nonnegative integers. Option: `%s`.', 'shape', options.shape ) );
}
opts.shape = options.shape;
}
if ( hasOwnProp( options, 'order' ) ) {
opts.order = options.order;
}
if ( hasOwnProp( options, 'readonly' ) ) {
opts.readonly = options.readonly;
}
}
sh = opts.shape;
dt = opts.dtype;
buf = buffer( dt, 1 );
if ( buf === null ) {
throw new TypeError( format( 'invalid option. `%s` option must be a recognized data type. Option: `%s`.', 'dtype', dt ) );
}
if ( isComplexDataType( dt ) && isNumber( value ) ) {
v = [ value, 0.0 ]; // note: we're assuming that the ComplexXXArray setter accepts an array of interleaved real and imaginary components
} else {
v = value;
}
if ( isAccessorArray( buf ) ) {
set = accessorSetter( dt );
} else {
set = setter( dt );
}
set( buf, 0, v );
N = sh.length || 1;
return new ndarray( dt, buf, sh, zeros( N ), 0, opts.order, opts );
}
// EXPORTS //
module.exports = broadcastScalarLike;
|