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 | 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 isScalarMostlySafeCompatible = require( '@stdlib/ndarray/base/assert/is-scalar-mostly-safe-compatible' ); // eslint-disable-line id-length
var empty = require( '@stdlib/ndarray/base/empty' );
var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
var assign = require( '@stdlib/ndarray/base/assign-scalar' );
var format = require( '@stdlib/string/format' );
// MAIN //
/**
* Returns an ndarray filled with a specified value and having a specified shape and data type.
*
* @param {*} value - fill value
* @param {*} dtype - data type
* @param {NonNegativeIntegerArray} shape - array shape
* @param {string} order - array order
* @throws {TypeError} second argument must be a recognized data type
* @throws {TypeError} first argument cannot be safely cast to the output array data type
* @returns {ndarray} ndarray
*
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
* var getDType = require( '@stdlib/ndarray/dtype' );
*
* var arr = full( 10.0, 'float32', [ 2, 2 ], 'row-major' );
* // returns <ndarray>[ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ]
*
* var sh = getShape( arr );
* // returns [ 2, 2 ]
*
* var dt = String( getDType( arr ) );
* // returns 'float32'
*/
function full( value, dtype, shape, order ) {
var out;
var v;
// Safe casts are always allowed and allow same kind casts (i.e., downcasts) only when the output data type is floating-point...
if ( !isScalarMostlySafeCompatible( value, dtype ) ) {
throw new TypeError( format( 'invalid argument. The first argument cannot be safely cast to the output array data type. Data type: %s. Value: `%s`.', dtype, value ) );
}
// Allocate an output array:
out = empty( dtype, shape, order );
// Convert the fill value to an ndarray having the same data type as the output ndarray:
v = scalar2ndarray( value, dtype, order );
// Assign the fill value to each element of the output ndarray:
assign( [ v, out ] );
return out;
}
// EXPORTS //
module.exports = full;
|