"iterNoneBy": "arr = array2iterator( [ 1, 1, 1, 1, 1 ] );\nfunction fcn( v ) { return ( v <= 0 ); };\nbool = iterNoneBy( arr, fcn )\n",

"iterNth": "arr = array2iterator( [ 0, 0, 1, 0, 0 ] );\nv = iterNth( arr, 3 )\n",

"iterprod": "arr = array2iterator( [ 1.0, 2.0, 3.0, 4.0 ] );\ns = iterprod( arr )\n",

"iterSlice": "it = iterSlice( random.iterators.randu(), 5, 10 );\nr = it.next().value\nr = it.next().value\n",

"iterSome": "arr = array2iterator( [ 0, 0, 1, 1, 1 ] );\nbool = iterSome( arr, 3 )\n",

"iterSomeBy": "arr = array2iterator( [ 1, 1, 0, 0, 1 ] );\nfunction fcn( v ) { return ( v > 0 ); };\nbool = iterSomeBy( arr, 3, fcn )\n",

"iterHead": "\niterHead( iterator, n )\n Returns an iterator which returns the first `n` values of a provided\n iterator.\n\n If a provided iterator only generates `m` values and `m` is less than `n`,\n the returned iterator only returns `m` values.\n\n If an environment supports Symbol.iterator, the returned iterator is\n iterable.\n\n Parameters\n ----------\n iterator: Object\n Input iterator.\n\n n: integer\n Number of values.\n\n Returns\n -------\n iterator: Object\n Iterator.\n\n iterator.next(): Function\n Returns an iterator protocol-compliant object containing the next\n iterated value (if one exists) and a boolean flag indicating whether the\n iterator is finished.\n\n iterator.return( [value] ): Function\n Finishes an iterator and returns a provided value.\n\n Examples\n --------\n > var it = iterHead( random.iterators.randu(), 5 );\n > var r = it.next().value\n <number>\n > r = it.next().value\n <number>\n\n See Also\n --------\n iterFirst, iterSlice\n",

"iterLast": "\niterLast( iterator )\n Consumes an entire iterator and returns the last iterated value.\n\n Parameters\n ----------\n iterator: Object\n Input iterator over which to iterate.\n\n Returns\n -------\n v: any\n The last iterated value.\n\n Examples\n --------\n > var arr = array2iterator( [ 0, 0, 0, 0, 1 ] );\n > var v = iterLast( arr )\n 1\n\n See Also\n --------\n iterFirst, iterNth\n",

"iterMap": "\niterMap( iterator, fcn[, thisArg] )\n Returns an iterator which invokes a function for each iterated value.\n\n When invoked, the input function is provided two arguments:\n\n - value: iterated value\n - index: iteration index (zero-based)\n\n If an environment supports Symbol.iterator, the returned iterator is\n iterable.\n\n Parameters\n ----------\n iterator: Object\n Input iterator.\n\n fcn: Function\n Function to invoke for each iterated value.\n\n thisArg: any (optional)\n Execution context.\n\n Returns\n -------\n iterator: Object\n Iterator.\n\n iterator.next(): Function\n Returns an iterator protocol-compliant object containing the next\n iterated value (if one exists) and a boolean flag indicating whether the\n iterator is finished.\n\n iterator.return( [value] ): Function\n Finishes an iterator and returns a provided value.\n\n Examples\n --------\n > function f( v ) { return v * 10.0; };\n > var it = iterMap( random.iterators.randu(), f );\n > var r = it.next().value\n <number>\n > r = it.next().value\n <number>\n\n See Also\n --------\n iterForEach\n",

"itermaxabs": "\nitermaxabs( iterator )\n Computes the maximum absolute value of all iterated values.\n\n Parameters\n ----------\n iterator: Object\n Input iterator.\n\n Returns\n -------\n out: number|null\n Maximum absolute value.\n\n Examples\n --------\n > var arr = array2iterator( [ 1.0, -2.0, 3.0, -4.0 ] );\n > var m = itermaxabs( arr )\n 4.0\n\n See Also\n --------\n itermax, iterminabs\n",

"itermean": "\nitermean( iterator )\n Computes an arithmetic mean over all iterated values.\n\n Parameters\n ----------\n iterator: Object\n Input iterator.\n\n Returns\n -------\n out: number|null\n Arithmetic mean.\n\n Examples\n --------\n > var arr = array2iterator( [ 1.0, 2.0, 3.0, 4.0 ] );\n > var m = itermean( arr )\n 2.5\n\n See Also\n --------\n itermmean, itersum, itervariance\n",

"iterminabs": "\niterminabs( iterator )\n Computes the minimum absolute value of all iterated values.\n\n Parameters\n ----------\n iterator: Object\n Input iterator.\n\n Returns\n -------\n out: number|null\n Minimum absolute value.\n\n Examples\n --------\n > var arr = array2iterator( [ 1.0, -2.0, 3.0, -4.0 ] );\n > var m = iterminabs( arr )\n 1.0\n\n See Also\n --------\n itermaxabs, itermin\n",

"itermmean": "\nitermmean( iterator, W )\n Returns an iterator which iteratively computes a moving arithmetic mean.\n\n The `W` parameter defines the number of iterated values over which to\n compute the moving mean.\n\n As `W` values are needed to fill the window buffer, the first `W-1` returned\n values are calculated from smaller sample sizes. Until the window is full,\n each returned value is calculated from all previously iterated values.\n\n If an environment supports Symbol.iterator, the returned iterator is\n iterable.\n\n Parameters\n ----------\n iterator: Object\n Input iterator.\n\n W: integer\n Window size.\n\n Returns\n -------\n iterator: Object\n Iterator.\n\n iterator.next(): Function\n Returns an iterator protocol-compliant object containing the next\n iterated value (if one exists) and a boolean flag indicating whether the\n iterator is finished.\n\n iterator.return( [value] ): Function\n Finishes an iterator and returns a provided value.\n\n Examples\n --------\n > var arr = array2iterator( [ 2.0, -5.0, 3.0, 5.0 ] );\n > var it = itermmean( arr, 3 );\n > var m = it.next().value\n 2.0\n > m = it.next().value\n -1.5\n > m = it.next().value\n 0.0\n > m = it.next().value\n 1.0\n\n See Also\n --------\n itermean\n",

"iterNone": "\niterNone( iterator )\n Tests whether all iterated values are falsy.\n\n The function immediately returns upon encountering a truthy value.\n\n If provided an iterator which does not return any iterated values, the\n function returns `true`.\n\n Parameters\n ----------\n iterator: Object\n Input iterator over which to iterate.\n\n Returns\n -------\n bool: boolean\n The function returns `false` if a value is truthy; otherwise, the\n function returns `true`.\n\n Examples\n --------\n > var arr = array2iterator( [ 0, 0, 0, 0, 1 ] );\n > var bool = iterNone( arr )\n false\n\n See Also\n --------\n iterAny, iterEvery, iterForEach, iterNoneBy, iterSome\n",

"iterNoneBy": "\niterNoneBy( iterator, predicate[, thisArg ] )\n Tests whether every iterated value fails a test implemented by a predicate\n function.\n\n The predicate function is provided two arguments:\n\n - `value`: iterated value\n - `index`: iteration index\n\n The function immediately returns upon encountering a truthy return value.\n\n If provided an iterator which does not return any iterated values, the\n function returns `true`.\n\n Parameters\n ----------\n iterator: Object\n Input iterator over which to iterate.\n\n predicate: Function\n The test function.\n\n thisArg: any (optional)\n Execution context.\n\n Returns\n -------\n bool: boolean\n The function returns `true` if a predicate function returns a falsy\n value for all iterated values. Otherwise, the function returns `false`.\n\n Examples\n --------\n > var arr = array2iterator( [ 1, 1, 1, 1, 1 ] );\n > function fcn( v ) { return ( v <= 0 ); };\n > var bool = iterNoneBy( arr, fcn )\n true\n\n See Also\n --------\n iterAnyBy, iterEveryBy, iterForEach, iterNone, iterSomeBy\n",

"iterNth": "\niterNth( iterator, n )\n Returns the nth iterated value.\n\n If `n` exceeds the total number of iterations, the function returns\n `undefined`.\n\n Parameters\n ----------\n iterator: Object\n Input iterator over which to iterate.\n\n n: integer\n Iteration number.\n\n Returns\n -------\n v: any\n The nth iterated value.\n\n Examples\n --------\n > var arr = array2iterator( [ 0, 0, 1, 0, 0 ] );\n > var v = iterNth( arr, 3 )\n 1\n\n See Also\n --------\n iterFirst, iterLast\n",

"iterprod": "\niterprod( iterator )\n Computes the product of all iterated values.\n\n For iterators which can generate many values or which may output large\n numbers, care should be taken to prevent overflow.\n\n Parameters\n ----------\n iterator: Object\n Input iterator.\n\n Returns\n -------\n out: number|null\n Product.\n\n Examples\n --------\n > var arr = array2iterator( [ 1.0, 2.0, 3.0, 4.0 ] );\n > var s = iterprod( arr )\n 24.0\n\n See Also\n --------\n itersum\n",

"iterSlice": "\niterSlice( iterator, [begin[, end]] )\n Returns an iterator which returns a subsequence of iterated values from a\n provided iterator.\n\n If `end` exceeds the length of the provided iterator, the returned iterator\n returns the subsequence of iterated values starting from `begin` until the\n last iterated value of the provided iterator.\n\n If an environment supports Symbol.iterator, the returned iterator is\n iterable.\n\n Parameters\n ----------\n iterator: Object\n Input iterator.\n\n begin: integer (optional)\n Start iteration index (zero-based and inclusive). Default: 0.\n\n end: integer (optional)\n End iteration index (zero-based and non-inclusive).\n\n Returns\n -------\n iterator: Object\n Iterator.\n\n iterator.next(): Function\n Returns an iterator protocol-compliant object containing the next\n iterated value (if one exists) and a boolean flag indicating whether the\n iterator is finished.\n\n iterator.return( [value] ): Function\n Finishes an iterator and returns a provided value.\n\n Examples\n --------\n > var it = iterSlice( random.iterators.randu(), 5, 10 );\n > var r = it.next().value\n <number>\n > r = it.next().value\n <number>\n\n See Also\n --------\n iterFirst, iterHead\n",

"iterSome": "\niterSome( iterator, n )\n Tests whether at least `n` iterated values are truthy.\n\n The function immediately returns upon finding `n` truthy values.\n\n If provided an iterator which does not return any iterated values, the\n function returns `false`.\n\n Parameters\n ----------\n iterator: Object\n Input iterator over which to iterate.\n\n n: number\n Minimum number of truthy elements.\n\n Returns\n -------\n bool: boolean\n The function returns `true` if an iterator returns at least `n` truthy\n elements; otherwise, the function returns `false`.\n\n Examples\n --------\n > var arr = array2iterator( [ 0, 0, 1, 1, 1 ] );\n > var bool = iterSome( arr, 3 )\n true\n\n See Also\n --------\n iterAny, iterEvery, iterForEach, iterNone, iterSomeBy\n",

"iterSomeBy": "\niterSomeBy( iterator, n, predicate[, thisArg ] )\n Tests whether at least `n` iterated values pass a test implemented by a\n predicate function.\n\n The predicate function is provided two arguments:\n\n - `value`: iterated value\n - `index`: iteration index\n\n The function immediately returns upon encountering `n` truthy return values.\n\n If provided an iterator which does not return any iterated values, the\n function returns `false`.\n\n Parameters\n ----------\n iterator: Object\n Input iterator over which to iterate.\n\n n: integer\n Minimum number of successful values.\n\n predicate: Function\n The test function.\n\n thisArg: any (optional)\n Execution context.\n\n Returns\n -------\n bool: boolean\n The function returns `true` if a predicate function returns a truthy\n value for at least `n` iterated values. Otherwise, the function returns\n `false`.\n\n Examples\n --------\n > var arr = array2iterator( [ 1, 1, 0, 0, 1 ] );\n > function fcn( v ) { return ( v > 0 ); };\n > var bool = iterSomeBy( arr, 3, fcn )\n true\n\n See Also\n --------\n iterAnyBy, iterEveryBy, iterForEach, iterNoneBy, iterSome\n",