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
+2-1Lines changed: 2 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1376,7 +1376,8 @@ var db = {
1376
1376
"iterConcat": "\niterConcat( iter0, ...iterator )\n Returns an iterator which iterates over the values of two or more iterators.\n\n If an environment supports Symbol.iterator and provided iterators are\n iterable, the returned iterator is iterable.\n\n Parameters\n ----------\n iter0: Object\n Input iterator.\n\n iterator: ...Object\n Iterators to concatenate.\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 = array2iterator( [ 3, 4 ] );\n > var it = iterConcat( it1, it2 );\n > var v = it.next().value\n 1\n > v = it.next().value\n 2\n > v = it.next().value\n 3\n > v = it.next().value\n 4\n > var bool = it.next().done\n true\n\n",
1377
1377
"iterConstant": "\niterConstant( value[, options] )\n Returns an iterator which always returns the same value.\n\n When provided an object reference, the returned iterator always returns the\n same reference.\n\n If an environment supports Symbol.iterator, the returned iterator is\n iterable.\n\n Parameters\n ----------\n value: any\n Value to return.\n\n options: Object (optional)\n Function options.\n\n options.iter: integer (optional)\n Number of iterations. Default: 1e308.\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 = iterConstant( 3.14 );\n > var v = it.next().value\n 3.14\n > v = it.next().value\n 3.14\n\n See Also\n --------\n constantFunction\n",
1378
1378
"iterCounter": "\niterCounter( iterator )\n Returns an iterator which iteratively computes the number of iterated\n 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 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 = iterCounter( random.iterators.randu() );\n > var v = it.next().value\n 1\n > v = it.next().value\n 2\n\n See Also\n --------\n iterLength\n",
1379
-
"itercugmean": "\nitercugmean( iterator )\n Returns an iterator which iteratively computes a cumulative geometric mean.\n\n If provided a negative value, the iterated value is `NaN` for all future\n invocations.\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 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 = itercugmean( arr );\n > var v = it.next().value\n 2.0\n > v = it.next().value\n ~3.16\n > v = it.next().value\n ~3.11\n > v = it.next().value\n ~3.50\n\n See Also\n --------\n itercumean\n",
1379
+
"itercugmean": "\nitercugmean( iterator )\n Returns an iterator which iteratively computes a cumulative geometric mean.\n\n If provided a negative value, the iterated value is `NaN` for all future\n invocations.\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 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 = itercugmean( arr );\n > var v = it.next().value\n 2.0\n > v = it.next().value\n ~3.16\n > v = it.next().value\n ~3.11\n > v = it.next().value\n ~3.50\n\n See Also\n --------\n itercuhmean, itercumean\n",
1380
+
"itercuhmean": "\nitercuhmean( iterator )\n Returns an iterator which iteratively computes a cumulative harmonic mean.\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 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 = itercuhmean( arr );\n > var v = it.next().value\n 2.0\n > v = it.next().value\n ~2.86\n > v = it.next().value\n ~2.90\n > v = it.next().value\n ~3.24\n\n See Also\n --------\n itercugmean, itercumean\n",
1380
1381
"itercumax": "\nitercumax( iterator )\n Returns an iterator which iteratively computes a cumulative maximum value.\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 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 = itercumax( arr );\n > var m = it.next().value\n 2.0\n > m = it.next().value\n 2.0\n > m = it.next().value\n 3.0\n > m = it.next().value\n 5.0\n\n See Also\n --------\n itercumidrange, itercumin, itercurange, itermax\n",
1381
1382
"itercumaxabs": "\nitercumaxabs( iterator )\n Returns an iterator which iteratively computes a cumulative maximum absolute\n value.\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 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 = itercumaxabs( arr );\n > var m = it.next().value\n 2.0\n > m = it.next().value\n 5.0\n > m = it.next().value\n 5.0\n > m = it.next().value\n 5.0\n\n See Also\n --------\n itercumax, itercuminabs, itermaxabs\n",
1382
1383
"itercumean": "\nitercumean( iterator )\n Returns an iterator which iteratively computes a cumulative arithmetic mean.\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 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 = itercumean( arr );\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.25\n\n See Also\n --------\n itercumidrange, itercusum, itermean\n",
0 commit comments