All files main.js

97% Statements 194/200
83.78% Branches 31/37
100% Functions 1/1
97% Lines 194/200

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 2011x 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 203x 203x 203x 203x 203x 203x 203x 203x 203x 203x 203x 203x 203x 203x 203x 203x 203x 203x 203x 203x 203x 203x 203x 203x 30x 30x 203x 3x 3x 170x 170x 203x 114x 114x 56x 56x 56x 55x 55x 114x 57x 57x 203x 2x 2x 2x 2x 1x 1x 1x 1x 1x 1x 56x 54x 54x 116x 116x 203x 57x 42x 21x 21x 21x 21x 57x 95x 95x 203x 30x 30x     203x 65x 15x 15x     65x 50x 50x 50x   50x   50x 13x 50x 37x 37x 50x 120x 120x 50x 65x 65x 65x 27x 27x 43x 43x 43x 27x 27x 43x 27x 65x 68x 68x 203x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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 isFunction = require( '@stdlib/assert/is-function' );
var isReadOnly = require( '@stdlib/ndarray/base/assert/is-read-only' );
var isArrayLikeObject = require( '@stdlib/assert/is-array-like-object' );
var isPlainObject = require( '@stdlib/assert/is-plain-object' );
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var isMultiSlice = require( '@stdlib/assert/is-multi-slice' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var MultiSlice = require( '@stdlib/slice/multi' );
var args2multislice = require( '@stdlib/slice/base/args2multislice' );
var slice = require( '@stdlib/ndarray/base/slice' );
var base = require( '@stdlib/ndarray/base/fill-by' );
var format = require( '@stdlib/string/format' );
 
 
// MAIN //
 
/**
* Fills an input ndarray view according to a callback function.
*
* @param {ndarray} x - input ndarray
* @param {...*} s - slice arguments
* @param {Options} [options] - options
* @param {boolean} [options.strict] - boolean indicating whether to enforce strict bounds checking
* @param {Function} clbk - callback function
* @param {*} thisArg - callback execution context
* @throws {TypeError} first argument must be an ndarray-like object
* @throws {TypeError} options argument must be an object
* @throws {TypeError} must provide valid options
* @throws {TypeError} callback argument must be a function
* @throws {Error} too many arguments
* @throws {Error} cannot write to a read-only ndarray
* @returns {ndarray} input ndarray
*
* @example
* var zeros = require( '@stdlib/ndarray/zeros' );
* var MultiSlice = require( '@stdlib/slice/multi' );
* var Slice = require( '@stdlib/slice/ctor' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
*
* function clbk() {
*     return 5.0;
* }
*
* var x = zeros( [ 3, 4 ], {
*     'dtype': 'float64'
* });
*
* // Define the fill region:
* var s0 = new Slice( 1, 3 );
* var s1 = new Slice( 2, 4 );
* var s = new MultiSlice( s0, s1 );
*
* var y = fillSliceBy( x, s, clbk );
* // returns <ndarray>
*
* var bool = ( y === x );
* // returns true
*
* var arr = ndarray2array( x );
* // returns [ [ 0, 0, 0, 0 ], [ 0, 0, 5.0, 5.0 ], [ 0, 0, 5.0, 5.0 ] ]
*/
function fillSliceBy() {
	var options;
	var flgOpts;
	var flgCtx;
	var nargs;
	var sArgs;
	var opts;
	var ctx;
	var cb;
	var ns;
	var S;
	var s;
	var i;
	var x;
 
	opts = {
		'strict': true
	};
	flgOpts = false;
	flgCtx = false;
	nargs = arguments.length;
	x = arguments[ 0 ];
 
	if ( !isndarrayLike( x ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );
	}
	if ( isReadOnly( x ) ) {
		throw new Error( 'invalid argument. Cannot write to a read-only array.' );
	}
 
	// Resolve function arguments:
	if ( isFunction( arguments[ nargs - 1 ] ) ) { // Case: fillSliceBy( x, ???, ???, clbk )
		cb = arguments[ nargs - 1 ];
		if ( isPlainObject( arguments[ nargs - 2 ] ) ) { // Case: fillSliceBy( x, ???, options, clbk )
			flgOpts = true;
			options = arguments[ nargs - 2 ];
			if ( nargs > 3 ) {
				s = arguments[ nargs - 3 ];
			}
		} else if ( nargs > 2 ) { // Case: fillSliceBy( x, s, clbk )
			s = arguments[ nargs - 2 ];
		}
	} else if ( isFunction( arguments[ nargs - 2 ] ) ) { // Case: fillSliceBy( x, ???, ???, clbk, thisArg )
		cb = arguments[ nargs -2 ];
		ctx = arguments[ nargs - 1 ];
		flgCtx = true;
		if ( isPlainObject( arguments[ nargs - 3 ] ) ) { // Case: fillSliceBy( x, ???, options, clbk, thisArg )
			flgOpts = true;
			options = arguments[ nargs - 3 ];
			s = arguments[ nargs - 4 ];
		} else { // Case: fillSliceBy( x, s, clbk, thisArg )
			s = arguments[ nargs - 3 ];
		}
	} else {
		throw new TypeError( 'invalid argument. Callback argument must be a function' );
	}
 
	// Resolve function options:
	if ( flgOpts ) {
		if ( hasOwnProp( options, 'strict' ) ) {
			if ( !isBoolean( options.strict ) ) {
				throw new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'strict', options.strict ) );
			}
			opts.strict = options.strict;
		}
	}
 
	// Resolve slice:
	if ( isMultiSlice( s ) ) {
		S = s;
		if ( nargs > 5 ) {
			throw new Error( 'invalid invocation. Too many arguments.' );
		}
	} else {
		if ( isArrayLikeObject( s ) ) {
			sArgs = s;
			if ( nargs > 5 ) {
				throw new Error( 'invalid invocation. Too many arguments.' );
			}
		} else {
			sArgs = [];
			ns = 0;
			if ( flgCtx && flgOpts ) {
				ns = nargs - 3;
			} else if ( flgCtx && !flgOpts ) {
				ns = nargs - 2;
			} else if ( !flgCtx && flgOpts ) {
				ns = nargs - 2;
			} else {
				ns = nargs - 1;
			}
			for ( i = 1; i < ns; i++ ) {
				sArgs.push( arguments[ i ] );
			}
		}
		try {
			S = args2multislice( sArgs );
		} catch ( err ) { // eslint-disable-line no-unused-vars
			// Search for the first offending value...
			for ( i = 0; i < sArgs.length; i++ ) {
				try {
					new MultiSlice( sArgs[ i ] ); // eslint-disable-line no-new
				} catch ( err ) { // eslint-disable-line no-unused-vars
					throw new TypeError( format( 'invalid argument. Slice arguments must be either a Slice, integer, null, or undefined. Value: `%s`.', String( sArgs[ i ] ) ) );
				}
			}
		}
	}
	base( slice( x, S, opts.strict, true ), cb, ctx );
	return x;
}
 
 
// EXPORTS //
 
module.exports = fillSliceBy;