All files main.js

99.63% Statements 272/273
98.14% Branches 53/54
100% Functions 7/7
99.63% Lines 272/273

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 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 2745x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 111x 111x 111x 111x 111x 111x 111x 111x 111x 111x 111x 111x 27x 27x 84x 84x 84x 84x 111x 77x 62x 62x 35x 35x 9x 9x 26x 26x 62x 28x 28x 22x 22x 28x 62x 28x 28x 24x 24x 28x 77x 15x 15x 8x 8x 7x 7x 77x 21x 21x 21x 21x 111x 10x 9x 9x 10x 1x 1x 1x 111x 10x 10x 11x 1x 1x 1x 21x 21x 21x 21x 19x 19x 21x 21x 111x   111x 21x 21x 21x 21x 21x 21x 21x 21x 21x 21x 21x 33x 33x 33x 4x 4x 4x 4x 29x 29x 29x 29x 33x 21x 21x 21x 21x 21x 21x 21x 21x 8x 8x 1x 1x 8x 8x 1x 1x 1x 1x 7x 7x 7x 7x 8x 21x 21x 21x 21x 21x 21x 21x 21x 47x 47x 47x 4x 4x 4x 4x 43x 43x 43x 43x 47x 21x 21x 21x 21x 21x 21x 21x 21x 8x 8x 1x 1x 8x 8x 1x 1x 1x 1x 7x 7x 7x 7x 8x 21x 21x 21x 21x 21x 21x 21x 21x 21x 4x 4x 2x 2x 2x 2x 2x 2x 2x 2x 4x 21x 21x 21x 21x 21x 21x 21x 21x 2x 1x 1x 1x 2x 111x 5x 5x 5x 5x 5x  
/**
* @license Apache-2.0
*
* Copyright (c) 2018 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 hasOwnProp = require( '@stdlib/assert/has-own-property' );
var isFunction = require( '@stdlib/assert/is-function' );
var isCollection = require( '@stdlib/assert/is-collection' );
var isObject = require( '@stdlib/assert/is-plain-object' );
var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive;
var isAccessorArray = require( '@stdlib/array/base/assert/is-accessor-array' );
var iteratorSymbol = require( '@stdlib/symbol/iterator' );
var accessorGetter = require( '@stdlib/array/base/accessor-getter' );
var getter = require( '@stdlib/array/base/getter' );
var dtype = require( '@stdlib/array/dtype' );
var format = require( '@stdlib/string/format' );
 
 
// MAIN //
 
/**
* Returns an iterator which repeatedly iterates over each element in an array-like object.
*
* @param {Collection} src - input value
* @param {Options} [options] - function options
* @param {NonNegativeInteger} [options.iter] - number of iterations
* @param {integer} [options.dir=1] - iteration direction
* @param {Function} [mapFcn] - function to invoke for each iterated value
* @param {*} [thisArg] - execution context
* @throws {TypeError} first argument must be an array-like object
* @throws {TypeError} options argument must be an object
* @throws {TypeError} must provide valid options
* @throws {TypeError} callback argument must be a function
* @returns {Iterator} iterator
*
* @example
* var iter = circarray2iterator( [ 1, 2, 3, 4 ] );
*
* var v = iter.next().value;
* // returns 1
*
* v = iter.next().value;
* // returns 2
*
* v = iter.next().value;
* // returns 3
*
* // ...
*/
function circarray2iterator( src ) {
	var thisArg;
	var options;
	var count;
	var opts;
	var iter;
	var FLG;
	var fcn;
	var get;
	var dt;
	var i;
	if ( !isCollection( src ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', src ) );
	}
	opts = {
		'iter': 1e308, // ~infinity
		'dir': 1       // left to right iteration
	};
	if ( arguments.length > 1 ) {
		if ( isObject( arguments[ 1 ] ) ) {
			options = arguments[ 1 ];
			if ( arguments.length > 2 ) {
				fcn = arguments[ 2 ];
				if ( !isFunction( fcn ) ) {
					throw new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', fcn ) );
				}
				thisArg = arguments[ 3 ];
			}
			if ( hasOwnProp( options, 'iter' ) ) {
				opts.iter = options.iter;
				if ( !isNonNegativeInteger( options.iter ) ) {
					throw new TypeError( format( 'invalid option. `%s` option must be a nonnegative integer. Option: `%s`.', 'iter', options.iter ) );
				}
			}
			if ( hasOwnProp( options, 'dir' ) ) {
				opts.dir = options.dir;
				if ( options.dir !== 1 && options.dir !== -1 ) {
					throw new TypeError( format( 'invalid option. `%s` option must be either `1` or `-1`. Option: `%s`.', 'dir', options.dir ) );
				}
			}
		} else {
			fcn = arguments[ 1 ];
			if ( !isFunction( fcn ) ) {
				throw new TypeError( format( 'invalid argument. Second argument must be either a function or an options object. Value: `%s`.', fcn ) );
			}
			thisArg = arguments[ 2 ];
		}
	}
	count = 0;
 
	// Create an iterator protocol-compliant object:
	iter = {};
	if ( fcn ) {
		if ( opts.dir === 1 ) {
			i = -1;
			setReadOnly( iter, 'next', next1a );
		} else {
			i = src.length;
			setReadOnly( iter, 'next', next1b );
		}
	} else if ( opts.dir === 1 ) {
		i = -1;
		setReadOnly( iter, 'next', next2a );
	} else {
		i = src.length;
		setReadOnly( iter, 'next', next2b );
	}
	setReadOnly( iter, 'return', end );
 
	// If an environment supports `Symbol.iterator`, make the iterator iterable:
	if ( iteratorSymbol ) {
		setReadOnly( iter, iteratorSymbol, factory );
	}
	// Resolve an accessor for retrieving array elements (e.g., to accommodate `Complex64Array`, etc):
	dt = dtype( src );
	if ( isAccessorArray( src ) ) {
		get = accessorGetter( dt );
	} else {
		get = getter( dt );
	}
	return iter;
 
	/**
	* Returns an iterator protocol-compliant object containing the next iterated value.
	*
	* @private
	* @returns {Object} iterator protocol-compliant object
	*/
	function next1a() {
		i = (i+1) % src.length;
		count += 1;
		if ( FLG || count > opts.iter || src.length === 0 ) {
			return {
				'done': true
			};
		}
		return {
			'value': fcn.call( thisArg, get( src, i ), i, count, src ),
			'done': false
		};
	}
 
	/**
	* Returns an iterator protocol-compliant object containing the next iterated value.
	*
	* @private
	* @returns {Object} iterator protocol-compliant object
	*/
	function next1b() {
		i -= 1;
		if ( i < 0 ) {
			i += src.length;
		}
		count += 1;
		if ( FLG || count > opts.iter || src.length === 0 ) {
			return {
				'done': true
			};
		}
		return {
			'value': fcn.call( thisArg, get( src, i ), i, count, src ),
			'done': false
		};
	}
 
	/**
	* Returns an iterator protocol-compliant object containing the next iterated value.
	*
	* @private
	* @returns {Object} iterator protocol-compliant object
	*/
	function next2a() {
		i = (i+1) % src.length;
		count += 1;
		if ( FLG || count > opts.iter || src.length === 0 ) {
			return {
				'done': true
			};
		}
		return {
			'value': get( src, i ),
			'done': false
		};
	}
 
	/**
	* Returns an iterator protocol-compliant object containing the next iterated value.
	*
	* @private
	* @returns {Object} iterator protocol-compliant object
	*/
	function next2b() {
		i -= 1;
		if ( i < 0 ) {
			i += src.length;
		}
		count += 1;
		if ( FLG || count > opts.iter || src.length === 0 ) {
			return {
				'done': true
			};
		}
		return {
			'value': get( src, i ),
			'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() {
		if ( fcn ) {
			return circarray2iterator( src, opts, fcn, thisArg );
		}
		return circarray2iterator( src, opts );
	}
}
 
 
// EXPORTS //
 
module.exports = circarray2iterator;