You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/repl/help/lib/db.js
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -1429,6 +1429,7 @@ var db = {
1429
1429
"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",
1430
1430
"iterPipeline": "\niterPipeline( iterFcn[, ...iterFcn] )\n Returns an iterator pipeline.\n\n Parameters\n ----------\n iterFcn: Function|Array\n Iterator function or an array of iterator functions.\n\n iterFcn: ...Function (optional)\n Iterator functions.\n\n Returns\n -------\n fcn( src ): Function\n Iterator pipeline which accepts a single argument, a source iterator.\n\n Examples\n --------\n > var it1 = iterThunk( iterHead, 100 );\n > function f( r ) { return ( r > 0.95 ); };\n > var it2 = iterThunk( iterSomeBy, 5, f );\n > var p = iterPipeline( it1, it2 );\n > var bool = p( random.iterators.randu() )\n <boolean>\n\n See Also\n --------\n iterFlow, iterThunk\n",
1431
1431
"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 itermprod, itersum\n",
1432
+
"iterPush": "\niterPush( iterator, ...items )\n Returns an iterator which appends additional values to the end of a provided\n iterator.\n\n If an environment supports Symbol.iterator and a provided iterator is\n iterable, the returned iterator is iterable.\n\n Parameters\n ----------\n iterator: Object\n Input iterator.\n\n items: ...any\n Items to append.\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 it1 = array2iterator( [ 1, 2 ] );\n > var it2 = iterPush( it1, 3, 4 );\n > var v = it2.next().value\n 1\n > v = it2.next().value\n 2\n > v = it2.next().value\n 3\n > v = it2.next().value\n 4\n > var bool = it2.next().done\n true\n\n See Also\n --------\n iterConcat\n",
1432
1433
"iterrange": "\niterrange( iterator )\n Computes the range of all iterated values.\n\n Parameters\n ----------\n iterator: Object\n Input iterator.\n\n Returns\n -------\n out: number|null\n Range.\n\n Examples\n --------\n > var arr = array2iterator( [ 1.0, -2.0, 3.0, -4.0 ] );\n > var m = iterrange( arr )\n 7.0\n\n See Also\n --------\n itermax, itermean, itermin, itermrange\n",
1433
1434
"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",
1434
1435
"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",
0 commit comments