All files / set-descriptor-offsets/lib main.js

89.85% Statements 62/69
100% Branches 1/1
0% Functions 0/1
89.85% Lines 62/69

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 701x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 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';
 
// MAIN //
 
/**
* Sets ndarray descriptor index offsets.
*
* ## Notes
*
* -   This function mutates the provided descriptors.
*
* @param {ArrayLikeObject<Object>} descriptors - list of ndarray descriptors
* @param {Collection<number>} offsets - list of index offsets
* @returns {ArrayLikeObject<Object>} input array
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var getOffset = require( '@stdlib/ndarray/base/offset' );
* var ndarraylike2descriptor = require( '@stdlib/ndarray/base/ndarraylike2descriptor' );
*
* var obj = ndarraylike2descriptor({
*     'dtype': 'float64',
*     'data': new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ),
*     'shape': [ 1 ],
*     'strides': [ 1 ],
*     'offset': 0,
*     'order': 'row-major'
* });
*
* var arr = [ obj ];
* var out = setDescriptorOffsets( arr, [ 2 ] );
* // returns [...]
*
* var bool = ( out === arr );
* // returns true
*
* var offset = getOffset( arr[ 0 ] );
* // returns 2
*/
function setDescriptorOffsets( descriptors, offsets ) {
	var i;
	for ( i = 0; i < offsets.length; i++ ) {
		descriptors[ i ].offset = offsets[ i ];
	}
	return descriptors;
}
 
 
// EXPORTS //
 
module.exports = setDescriptorOffsets;