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 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 | 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 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 239x 239x 239x 239x 239x 239x 239x 239x 239x 239x 239x 239x 239x 239x 239x 239x 239x 239x 239x 239x 239x 239x 60x 60x 179x 179x 179x 179x 179x 179x 179x 179x 179x 179x 179x 179x 179x 179x 179x 239x 50x 50x 10x 10x 40x 40x 50x 10x 10x 30x 30x 30x 30x 129x 129x 47x 47x 20x 20x 27x 27x 27x 47x 13x 13x 13x 14x 14x 14x 14x 14x 47x 82x 82x 49x 49x 6x 6x 6x 43x 43x 43x 43x 43x 49x 239x 87x 27x 27x 60x 87x 36x 18x 18x 18x 18x 87x 94x 94x 239x 3x 3x 91x 239x 4x 4x 87x 87x 87x 87x 87x 239x 24x 24x 24x 24x 10x 10x 24x 11x 24x 3x 3x 3x 3x 14x 14x 14x 63x 63x 63x 63x 20x 20x 43x 43x 48x 239x 239x 239x 239x 239x 239x 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 isPlainObject = require( '@stdlib/assert/is-plain-object' );
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var isScalarMostlySafeCompatible = require( '@stdlib/ndarray/base/assert/is-scalar-mostly-safe-compatible' ); // eslint-disable-line id-length
var isMostlySafeCast = require( '@stdlib/ndarray/base/assert/is-mostly-safe-data-type-cast' );
var isEqualDataType = require( '@stdlib/ndarray/base/assert/is-equal-data-type' );
var broadcastScalar = require( '@stdlib/ndarray/base/broadcast-scalar' );
var maybeBroadcastArray = require( '@stdlib/ndarray/base/maybe-broadcast-array' );
var baseEmpty = require( '@stdlib/ndarray/base/empty' );
var assign = require( '@stdlib/ndarray/base/assign' );
var nonCoreShape = require( '@stdlib/ndarray/base/complement-shape' );
var normalizeIndex = require( '@stdlib/ndarray/base/normalize-index' );
var getDType = require( '@stdlib/ndarray/dtype' );
var getShape = require( '@stdlib/ndarray/shape' );
var getOrder = require( '@stdlib/ndarray/order' );
var format = require( '@stdlib/string/format' );
var broadcastIndex = require( './broadcast_index.js' );
var base = require( './base.js' );
// MAIN //
/**
* Fills an input ndarray with a specified value along an ndarray dimension.
*
* ## Notes
*
* - The input ndarray is filled **in-place** (i.e., the input ndarray is **mutated**).
* - When a `start` and/or `end` index is negative, the respective index is determined relative to the last indexed element, with out-of-bounds indices clamped to index bounds.
*
* @param {ndarrayLike} x - input ndarray
* @param {(ndarrayLike|*)} value - fill value
* @param {(ndarrayLike|integer)} [start] - starting index (inclusive)
* @param {(ndarrayLike|integer)} [end] - ending index (exclusive)
* @param {Options} [options] - function options
* @param {integer} [options.dim=-1] - dimension over which to perform operation
* @throws {TypeError} first argument must be an ndarray-like object
* @throws {TypeError} second argument cannot be safely cast to the input ndarray data type
* @throws {TypeError} index arguments must be either ndarray-like objects or integers
* @throws {TypeError} options argument must be an object
* @throws {RangeError} dimension index must not exceed input ndarray bounds
* @throws {RangeError} first argument must have at least one dimension
* @throws {TypeError} must provide valid options
* @returns {ndarray} input ndarray
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* // Create a data buffer:
* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
*
* // Define the shape of the input array:
* var sh = [ 6 ];
*
* // Define the array strides:
* var sx = [ 1 ];
*
* // Define the index offset:
* var ox = 0;
*
* // Create an input ndarray:
* var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' );
*
* // Perform operation:
* var out = fillBetween( x, 10.0, 1, 4 );
* // returns <ndarray>[ 1.0, 10.0, 10.0, 10.0, 5.0, 6.0 ]
*
* var bool = ( out === x );
* // returns true
*/
function fillBetween( x, value ) {
var hasOptions;
var hasStart;
var options;
var hasEnd;
var nargs;
var start;
var opts;
var end;
var lsh;
var len;
var ord;
var vdt;
var sh;
var dt;
var d;
var e;
var s;
var v;
nargs = arguments.length;
if ( !isndarrayLike( x ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );
}
// Resolve input ndarray meta data:
dt = getDType( x );
ord = getOrder( x );
// Initialize an options object:
opts = {
'dims': [ -1 ] // default behavior is to perform the operation over the last dimension
};
// Initialize flags indicating whether `start`, `end`, and `options` arguments were provided:
hasOptions = false;
hasStart = false;
hasEnd = false;
// Case: fillBetween( x, value, start, end, options )
if ( nargs > 4 ) {
start = arguments[ 2 ];
if ( !isInteger( start ) && !isndarrayLike( start ) ) {
throw new TypeError( format( 'invalid argument. Third argument must be either an ndarray or an integer. Value: `%s`.', start ) );
}
hasStart = true;
end = arguments[ 3 ];
if ( !isInteger( end ) && !isndarrayLike( end ) ) {
throw new TypeError( format( 'invalid argument. Fourth argument must be either an ndarray or an integer. Value: `%s`.', end ) );
}
hasEnd = true;
options = arguments[ 4 ];
hasOptions = true;
}
// Case: fillBetween( x, value, start, ??? )
else if ( nargs === 4 ) {
start = arguments[ 2 ];
if ( !isInteger( start ) && !isndarrayLike( start ) ) {
throw new TypeError( format( 'invalid argument. Third argument must be either an ndarray or an integer. Value: `%s`.', start ) );
}
hasStart = true;
// Case: fillBetween( x, value, start, end )
if ( isInteger( arguments[ 3 ] ) || isndarrayLike( arguments[ 3 ] ) ) {
end = arguments[ 3 ];
hasEnd = true;
}
// Case: fillBetween( x, value, start, options )
else {
options = arguments[ 3 ];
hasOptions = true;
}
}
// Case: fillBetween( x, value, ??? )
else if ( nargs === 3 ) {
// Case: fillBetween( x, value, start )
if ( isInteger( arguments[ 2 ] ) || isndarrayLike( arguments[ 2 ] ) ) {
start = arguments[ 2 ];
hasStart = true;
}
// Case: fillBetween( x, value, options )
else {
options = arguments[ 2 ];
hasOptions = true;
}
}
if ( hasOptions ) {
if ( !isPlainObject( options ) ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
}
// Resolve provided options...
if ( hasOwnProp( options, 'dim' ) ) {
if ( !isInteger( options.dim ) ) {
throw new TypeError( format( 'invalid option. `%s` option must be an integer. Option: `%s`.', 'dim', options.dim ) );
}
opts.dims[ 0 ] = options.dim;
}
}
// Resolve the shape of the non-core dimensions and the number of indexed elements...
sh = getShape( x );
if ( sh.length < 1 ) {
throw new RangeError( 'invalid argument. First argument must have at least one dimension.' );
}
d = normalizeIndex( opts.dims[ 0 ], sh.length-1 );
if ( d === -1 ) {
throw new RangeError( format( 'invalid option. Dimension index exceeds the number of dimensions. Number of dimensions: %d. Value: `%d`.', sh.length, opts.dims[ 0 ] ) );
}
opts.dims[ 0 ] = d;
lsh = nonCoreShape( sh, opts.dims );
len = sh[ d ];
// Case: fillBetween( x, value_ndarray, ... )
if ( isndarrayLike( value ) ) {
vdt = getDType( value );
// Safe casts are always allowed and allow same kind casts (i.e., downcasts) only when the input array data type is floating-point...
if ( !isMostlySafeCast( vdt, dt ) ) {
throw new TypeError( format( 'invalid argument. Second argument cannot be safely cast to the input ndarray data type. Data types: [%s, %s].', vdt, dt ) );
}
if ( isEqualDataType( vdt, dt ) ) {
v = value;
} else {
// If we have unequal data types, we need to perform a copy...
v = baseEmpty( dt, getShape( value ), getOrder( value ) );
assign( [ value, v ] );
}
// The fill value must have a shape which is broadcast compatible with the shape of the non-core dimensions...
v = maybeBroadcastArray( v, lsh );
}
// Case: fillBetween( x, value_scalar, ... )
else {
// Safe casts are always allowed and allow same kind casts (i.e., downcasts) only when the input data type is floating-point...
if ( !isScalarMostlySafeCompatible( value, dt ) ) {
throw new TypeError( format( 'invalid argument. Second argument cannot be safely cast to the input ndarray data type. Data type: %s. Value: `%s`.', dt, value ) );
}
v = broadcastScalar( value, dt, lsh, ord );
}
// Broadcast the indices to match the shape of the non-core dimensions...
s = broadcastIndex( ( hasStart ) ? start : 0, lsh, ord );
e = broadcastIndex( ( hasEnd ) ? end : len, lsh, ord );
// Perform operation:
return base( x, v, s, e, opts );
}
// EXPORTS //
module.exports = fillBetween;
|