All files main.js

100% Statements 207/207
100% Branches 38/38
100% Functions 4/4
100% Lines 207/207

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 2085x 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 62x 62x 62x 62x 62x 62x 62x 62x 62x 62x 2x 2x 60x 60x 62x 146x 146x 100x 146x 14x 46x 32x 32x 146x 28x 28x 28x 28x 28x 28x 28x 27x 62x 2x 2x 2x 62x 27x 25x 25x 27x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 654x 654x 654x 654x 2x 2x 2x 2x 654x 343x 343x 11x 11x 11x 343x 330x 343x 2x 2x 654x 309x 309x 654x 657x 346x 346x 7x 7x 7x 346x 338x 346x 1x 1x 657x 311x 311x 657x 634x 634x 634x 634x 654x 28x 28x 28x 28x 28x 28x 28x 28x 28x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 2x 28x 28x 28x 28x 28x 28x 28x 28x 2x 2x 2x 2x 2x 4x 2x 2x 2x 2x 4x 2x 2x 62x 5x 5x 5x 5x 5x  
/**
* @license Apache-2.0
*
* Copyright (c) 2019 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 isFunction = require( '@stdlib/assert/is-function' );
var isNumber = require( '@stdlib/assert/is-number' ).isPrimitive;
var isIteratorLike = require( '@stdlib/assert/is-iterator-like' );
var iteratorSymbol = require( '@stdlib/symbol/iterator' );
var format = require( '@stdlib/string/format' );
 
 
// MAIN //
 
/**
* Returns an iterator which performs element-wise subtraction of two or more iterators.
*
* ## Notes
*
* -   If provided a numeric value as an iterator argument, the value is broadcast as an **infinite** iterator which **always** returns the provided value.
* -   If an iterated value is non-numeric (including `NaN`), the returned iterator returns `NaN`. If non-numeric iterated values are possible, you are advised to provide an iterator which type checks and handles non-numeric values accordingly.
* -   The length of the returned iterator is equal to the length of the shortest provided iterator. In other words, the returned iterator ends once **one** of the provided iterators ends.
* -   If an environment supports `Symbol.iterator` and all provided iterators are iterable, the returned iterator is iterable.
*
* @param {Iterator} iter0 - first input iterator
* @param {...(Iterator|number)} iterator - subsequent iterators
* @throws {Error} must provide two or more iterators
* @throws {TypeError} must provide iterator protocol-compliant objects
* @returns {Iterator} iterator
*
* @example
* var array2iterator = require( '@stdlib/array/to-iterator' );
*
* var it1 = array2iterator( [ 1.0, 5.0 ] );
* var it2 = array2iterator( [ 3.0, 4.0 ] );
*
* var iter = iterSubtract( it1, it2 );
*
* var v = iter.next().value;
* // returns -2.0
*
* v = iter.next().value;
* // returns 1.0
*
* var bool = iter.next().done;
* // returns true
*/
function iterSubtract() {
	var iterators;
	var types;
	var niter;
	var iter;
	var FLG;
	var i;
 
	niter = arguments.length;
	if ( niter < 2 ) {
		throw new Error( 'insufficient arguments. Must provide two or more iterators.' );
	}
	iterators = [];
	types = [];
	for ( i = 0; i < niter; i++ ) {
		iterators.push( arguments[ i ] );
		if ( isIteratorLike( arguments[ i ] ) ) {
			types.push( 1 );
		} else if ( isNumber( arguments[ i ] ) ) {
			types.push( 0 );
		} else {
			throw new TypeError( format( 'invalid argument. Must provide an iterator protocol-compliant object or a number. Argument: `%u`. Value: `%s`.', i, arguments[ i ] ) );
		}
	}
	// Create an iterator protocol-compliant object:
	iter = {};
	setReadOnly( iter, 'next', next );
	setReadOnly( iter, 'return', end );
 
	// If an environment supports `Symbol.iterator` and all provided iterators are iterable, make the iterator iterable:
	if ( iteratorSymbol ) {
		for ( i = 0; i < niter; i++ ) {
			if ( types[ i ] && !isFunction( iterators[ i ][ iteratorSymbol ] ) ) { // eslint-disable-line max-len
				FLG = true;
				break;
			}
		}
		if ( !FLG ) {
			setReadOnly( iter, iteratorSymbol, factory );
		}
	}
	FLG = false;
	i = 0;
	return iter;
 
	/**
	* Returns an iterator protocol-compliant object containing the next iterated value.
	*
	* @private
	* @returns {Object} iterator protocol-compliant object
	*/
	function next() {
		var s;
		var v;
		var i;
		if ( FLG ) {
			return {
				'done': true
			};
		}
		if ( types[ 0 ] ) {
			v = iterators[ 0 ].next();
			if ( v.done ) {
				FLG = true;
				return v;
			}
			if ( typeof v.value === 'number' ) {
				s = v.value;
			} else {
				s = NaN;
			}
		} else {
			s = iterators[ 0 ];
		}
		for ( i = 1; i < niter; i++ ) {
			if ( types[ i ] ) {
				v = iterators[ i ].next();
				if ( v.done ) {
					FLG = true;
					return v;
				}
				if ( typeof v.value === 'number' ) {
					s -= v.value;
				} else {
					s = NaN;
				}
			} else {
				s -= iterators[ i ];
			}
		}
		return {
			'value': s,
			'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() {
		var args;
		var i;
 
		args = [];
		for ( i = 0; i < niter; i++ ) {
			if ( types[ i ] ) {
				args.push( iterators[ i ][ iteratorSymbol ]() );
			} else {
				args.push( iterators[ i ] );
			}
		}
		return iterSubtract.apply( null, args );
	}
}
 
 
// EXPORTS //
 
module.exports = iterSubtract;