main.js (1751B)
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 // MODULES // 22 23 var iterMap = require( './../../../../iter/tools/map' ); 24 var ahavercos = require( './../../../../base/special/ahavercos' ); 25 26 27 // MAIN // 28 29 /** 30 * Returns an iterator which iteratively computes the inverse half-value versed cosine. 31 * 32 * ## Notes 33 * 34 * - The domain of inverse half-value versed cosine is restricted to `[0,1]`. If an iterated value is outside of the domain, the returned iterator returns `NaN`. 35 * - If an environment supports `Symbol.iterator` **and** a provided iterator is iterable, the returned iterator is iterable. 36 * 37 * @param {Iterator} iterator - input iterator 38 * @throws {TypeError} must provide an iterator protocol-compliant object 39 * @returns {Iterator} iterator 40 * 41 * @example 42 * var uniform = require( '@stdlib/random/iter/uniform' ); 43 * 44 * var iter = iterAhavercos( uniform( 0.0, 1.0 ) ); 45 * 46 * var r = iter.next().value; 47 * // returns <number> 48 * 49 * r = iter.next().value; 50 * // returns <number> 51 * 52 * r = iter.next().value; 53 * // returns <number> 54 * 55 * // ... 56 */ 57 function iterAhavercos( iterator ) { 58 return iterMap( iterator, ahavercos ); 59 } 60 61 62 // EXPORTS // 63 64 module.exports = iterAhavercos;