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 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 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) 2024 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 isMethodIn = require( '@stdlib/assert/is-method-in' );
var getShape = require( '@stdlib/ndarray/base/shape' ); // note: we intentionally use the "base" version, as every ndarray-like object should have a shape property
var getStrides = require( '@stdlib/ndarray/strides' );
var getOrder = require( '@stdlib/ndarray/order' );
var numel = require( '@stdlib/ndarray/base/numel' );
var ind2sub = require( '@stdlib/ndarray/base/ind2sub' );
var resolveIndex = require( './resolve_index.js' );
// FUNCTIONS //
/**
* Sets an ndarray element according to a linear index.
*
* ## Notes
*
* - This function assumes the presence of an `#.iset` method, which all stdlib ndarrays are expected to have.
*
* @private
* @param {ndarrayLike} x - input ndarray
* @param {string} idx - linear index string
* @param {*} value - new value
* @param {boolean} strict - boolean indicating whether to enforce strict bounds checking
* @throws {RangeError} index exceeds ndarray bounds
* @returns {boolean} boolean indicating whether assignment succeeded
*/
function iset( x, idx, value, strict ) {
idx = resolveIndex( idx, numel( getShape( x, false ) ), strict );
if ( idx === -1 ) {
return false;
}
x.iset( idx, value );
return true;
}
/**
* Sets an ndarray element according to a linear index.
*
* ## Notes
*
* - For ndarray-like objects not having an `#.iset` method, this function falls back to resolving a linear index to an array of corresponding subscripts and calling a `#.set` method, which all ndarray-like objects are expected to have.
*
* @private
* @param {ndarrayLike} x - input ndarray
* @param {string} idx - linear index string
* @param {*} value - new value
* @param {boolean} strict - boolean indicating whether to enforce strict bounds checking
* @throws {RangeError} index exceeds ndarray bounds
* @returns {boolean} boolean indicating whether assignment succeeded
*/
function set( x, idx, value, strict ) {
var sub;
var sh;
sh = getShape( x, false );
idx = resolveIndex( idx, numel( sh ), strict );
// In non-strict mode, avoid triggering an exception and always fail assignment if unable to resolve a linear index...
if ( idx === -1 ) {
return false;
}
// Convert a linear index to an array of subscripts according to the current ndarray view:
sub = ind2sub( sh, getStrides( x ), 0, getOrder( x ), idx, 'throw' );
// Append the new value to the subscripts array:
sub.push( value );
// Use the `#.set` method, which every ndarray-like object is expected to have, in order to update an ndarray element:
x.set.apply( x, sub );
return true;
}
// MAIN //
/**
* Returns an accessor for setting an ndarray element according to a linear index.
*
* @private
* @param {ndarrayLike} x - input ndarray
* @returns {Function} accessor function
*/
function setter( x ) {
if ( isMethodIn( x, 'iset' ) ) {
return iset;
}
return set;
}
// EXPORTS //
module.exports = setter;
|