repl.txt (1094B)
1 2 {{alias}}( iterator ) 3 Returns an iterator which iteratively computes the inverse hyperbolic 4 cotangent. 5 6 The domain of the inverse hyperbolic cotangent is restricted to (-inf,-1] 7 and [1,inf). If an iterated value is outside of the domain, the returned 8 iterator returns `NaN`. 9 10 If an environment supports Symbol.iterator and a provided iterator is 11 iterable, the returned iterator is iterable. 12 13 Parameters 14 ---------- 15 iterator: Object 16 Input iterator. 17 18 Returns 19 ------- 20 iterator: Object 21 Iterator. 22 23 iterator.next(): Function 24 Returns an iterator protocol-compliant object containing the next 25 iterated value (if one exists) and a boolean flag indicating whether the 26 iterator is finished. 27 28 iterator.return( [value] ): Function 29 Finishes an iterator and returns a provided value. 30 31 Examples 32 -------- 33 > var it = {{alias}}( {{alias:@stdlib/random/iter/uniform}}( 1.0, 10.0 ) ); 34 > var r = it.next().value 35 <number> 36 > r = it.next().value 37 <number> 38 39 See Also 40 -------- 41