All files / base/take3d/lib main.js

68.13% Statements 62/91
100% Branches 1/1
0% Functions 0/1
68.13% Lines 62/91

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 921x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 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) 2023 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 normalizeIndex = require( '@stdlib/ndarray/base/normalize-index' );
var indexFunction = require( '@stdlib/ndarray/base/ind' ).factory;
var take2d = require( '@stdlib/array/base/take2d' );
var format = require( '@stdlib/string/format' );
 
 
// VARIABLES //
 
var NDIMS = 3;
 
 
// MAIN //
 
/**
* Takes elements from a three-dimensional nested array.
*
* ## Notes
*
* -   The function does **not** deep copy nested array elements.
*
* @param {ArrayLikeObject<Collection>} x - input array
* @param {NonNegativeIntegerArray} indices - list of indices
* @param {integer} dimension - dimension along which to take elements
* @param {string} mode - index mode specifying how to handle an index which is out-of-bounds
* @throws {RangeError} third argument exceeds the number of dimensions
* @throws {TypeError} fourth argument must be a recognized index mode
* @returns {(Array<Array>|Array<Collection>)} output array
*
* @example
* var x = [ [ [ 1, 2 ], [ 3, 4 ] ] ];
* var indices = [ 1, 1, 0, 0, -1, -1 ];
*
* var y = take3d( x, indices, 2, 'normalize' );
* // returns [ [ [ 2, 2, 1, 1, 2, 2 ], [ 4, 4, 3, 3, 4, 4 ] ] ]
*/
function take3d( x, indices, dimension, mode ) {
	var lastIndex;
	var out;
	var dim;
	var ind;
	var idx;
	var i;

	dim = normalizeIndex( dimension, NDIMS-1 );
	if ( dim === -1 ) {
		throw new RangeError( format( 'invalid argument. Third argument exceeds the number of dimensions. Number of dimensions: %d. Value: `%d`.', NDIMS, dimension ) );
	}
	out = [];
	if ( dim === 0 ) {
		ind = indexFunction( mode );
		lastIndex = x.length - 1;
		for ( i = 0; i < indices.length; i++ ) {
			idx = ind( indices[ i ], lastIndex );
			out.push( x[ idx ] );
		}
		return out;
	}
	// Case: dim > 0
	dim = dimension - 1;
	for ( i = 0; i < x.length; i++ ) {
		out.push( take2d( x[ i ], indices, dim, mode ) );
	}
	return out;
}
 
 
// EXPORTS //
 
module.exports = take3d;