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 | 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 55x 55x 55x 55x 55x 55x 55x 55x 55x 55x 55x 55x 55x 20x 20x 35x 35x 35x 55x 21x 21x 9x 9x 12x 12x 10x 10x 2x 2x 21x 16x 16x 16x 16x 16x 16x 55x 2x 2x 16x 55x 11x 55x 5x 5x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 15x 15x 16x 16x 16x 16x 16x 16x 16x 16x 16x 131x 131x 15x 15x 15x 15x 131x 105x 105x 116x 116x 116x 116x 116x 131x 16x 16x 16x 16x 16x 16x 16x 16x 16x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 2x 16x 16x 16x 16x 16x 16x 16x 16x 1x 1x 55x 3x 3x 3x 3x 3x | /**
* @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 setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
var isPlainObject = require( '@stdlib/assert/is-plain-object' );
var isOrder = require( '@stdlib/ndarray/base/assert/is-order' );
var isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major-string' );
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var iteratorSymbol = require( '@stdlib/symbol/iterator' );
var zeros = require( '@stdlib/array/base/zeros' );
var getShape = require( '@stdlib/ndarray/shape' );
var numel = require( '@stdlib/ndarray/base/numel' );
var nextCartesianIndex = require( '@stdlib/ndarray/base/next-cartesian-index' ).assign;
var format = require( '@stdlib/string/format' );
// MAIN //
/**
* Returns an iterator which returns individual elements from a provided ndarray.
*
* @param {ndarray} x - input array
* @param {Options} [options] - function options
* @param {boolean} [options.order='row-major'] - index iteration order
* @throws {TypeError} first argument must be an ndarray
* @throws {TypeError} options argument must be an object
* @throws {TypeError} must provide valid options
* @returns {Iterator} iterator
*
* @example
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
* // returns <ndarray>
*
* var iter = nditerValues( x );
*
* var v = iter.next().value;
* // returns 1
*
* v = iter.next().value;
* // returns 2
*
* v = iter.next().value;
* // returns 3
*
* // ...
*/
function nditerValues( x ) {
var options;
var shape;
var ndims;
var opts;
var iter;
var FLG;
var idx;
var dim;
var N;
var i;
if ( !isndarrayLike( x ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );
}
opts = {
'order': x.order
};
if ( arguments.length > 1 ) {
options = arguments[ 1 ];
if ( !isPlainObject( options ) ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
}
if ( hasOwnProp( options, 'order' ) ) {
if ( !isOrder( options.order ) ) {
throw new TypeError( format( 'invalid option. `%s` option must be a recognized order. Option: `%s`.', 'order', options.order ) );
}
opts.order = options.order;
}
}
// Retrieve input array meta data:
shape = getShape( x );
ndims = shape.length;
// Check whether the input array is empty...
N = numel( shape );
if ( N === 0 ) {
FLG = true;
}
// Resolve the dimension in which indices iterate fastest:
if ( isRowMajor( opts.order ) ) {
dim = ndims - 1;
} else {
dim = 0;
}
// Initialize a counter:
i = -1;
// Initialize an index array:
idx = zeros( ndims );
// Create an iterator protocol-compliant object:
iter = {};
setReadOnly( iter, 'next', next );
setReadOnly( iter, 'return', end );
// If an environment supports `Symbol.iterator`, make the iterator iterable:
if ( iteratorSymbol ) {
setReadOnly( iter, iteratorSymbol, factory );
}
return iter;
/**
* Returns an iterator protocol-compliant object containing the next iterated value.
*
* @private
* @returns {Object} iterator protocol-compliant object
*/
function next() {
i += 1;
if ( FLG || i >= N ) {
return {
'done': true
};
}
if ( i > 0 ) {
idx = nextCartesianIndex( shape, opts.order, idx, dim, idx );
}
// Return the next set of indices:
return {
'value': x.get.apply( x, idx ),
'done': false
};
}
/**
* Finishes an iterator.
*
* @private
* @param {*} [value] - value to return
* @returns {Object} iterator protocol-compliant object
*/
function end( value ) {
FLG = true;
if ( arguments.length ) {
return {
'value': value,
'done': true
};
}
return {
'done': true
};
}
/**
* Returns a new iterator.
*
* @private
* @returns {Iterator} iterator
*/
function factory() {
return nditerValues( x, opts );
}
}
// EXPORTS //
module.exports = nditerValues;
|