index.js (1296B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2020 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Create an iterator which invokes a binary function accepting numeric arguments for each iterated value. 23 * 24 * @module @stdlib/math/iter/tools/map2 25 * 26 * @example 27 * var randu = require( '@stdlib/random/iter/randu' ); 28 * var copysign = require( '@stdlib/math/base/special/copysign' ); 29 * var iterMap2 = require( '@stdlib/math/iter/tools/map2' ); 30 * 31 * var iter = iterMap2( randu(), randu(), copysign ); 32 * 33 * var r = iter.next().value; 34 * // returns <number> 35 * 36 * r = iter.next().value; 37 * // returns <number> 38 * 39 * r = iter.next().value; 40 * // returns <number> 41 * 42 * // ... 43 */ 44 45 // MODULES // 46 47 var iterator = require( './main.js' ); 48 49 50 // EXPORTS // 51 52 module.exports = iterator;