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/data/data.csv
+2-1
Original file line number
Diff line number
Diff line change
@@ -3272,7 +3272,8 @@ iterCeil10,"\niterCeil10( iterator )\n Returns an iterator which rounds each
3272
3272
iterCompositesSeq,"\niterCompositesSeq( [options] )\n Returns an iterator which generates a sequence of composite numbers.\n\n If an environment supports Symbol.iterator, the returned iterator is\n iterable.\n\n Parameters\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 = iterCompositesSeq();\n > var v = it.next().value\n 4\n > v = it.next().value\n 6\n > v = it.next().value\n 8\n\n See Also\n --------\n iterIntegersSeq, iterPositiveIntegersSeq, iterPrimesSeq\n"
3273
3273
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"
3274
3274
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"
3275
-
iterContinuedFractionSeq,"\niterContinuedFractionSeq( x, [options] )\n Returns an iterator which generates a list of all continued fraction terms\n which can be obtained given the precision of `x`.\n\n If an environment supports Symbol.iterator, the returned iterator is\n iterable.\n\n Parameters\n ----------\n x: number\n Input value.\n\n options: Object (optional)\n Function options.\n\n options.iter: integer (optional)\n Number of iterations. Default: 1e308.\n\n options.tol: number (optional)\n Tolerance at which to terminate further evaluation of the continued\n fraction. Default: floating-point epsilon.\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 = iterContinuedFractionSeq( 3.245 );\n > var v = it.next().value\n 3\n > v = it.next().value\n 4\n > v = it.next().value\n 12\n > v = it.next().value\n 4\n > var bool = it.next().done\n true\n\n"
3275
+
iterContinuedFraction,"\niterContinuedFraction( iterator[, options] )\n Evaluates the terms of a continued fraction.\n\n Parameters\n ----------\n iterator: Object\n Input iterator.\n\n options: Object (optional)\n Function options.\n\n options.iter: integer (optional)\n Maximum number of iterations. Default: 1e308.\n\n options.tol: number (optional)\n Tolerance at which to terminate further evaluation of the continued\n fraction. Default: floating-point epsilon.\n\n Returns\n -------\n out: number|null\n Result.\n\n Examples\n --------\n > var terms = array2iterator( [ 3, 4, 12, 4 ] );\n > var v = iterContinuedFraction( terms )\n ~3.245\n\n See Also\n --------\n iterContinuedFractionSeq\n"
3276
+
iterContinuedFractionSeq,"\niterContinuedFractionSeq( x[, options] )\n Returns an iterator which generates a list of all continued fraction terms\n which can be obtained given the precision of `x`.\n\n If an environment supports Symbol.iterator, the returned iterator is\n iterable.\n\n Parameters\n ----------\n x: number\n Input value.\n\n options: Object (optional)\n Function options.\n\n options.iter: integer (optional)\n Maximum number of iterations. Default: 1e308.\n\n options.tol: number (optional)\n Tolerance at which to terminate further evaluation of the continued\n fraction. Default: floating-point epsilon.\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 = iterContinuedFractionSeq( 3.245 );\n > var v = it.next().value\n 3\n > v = it.next().value\n 4\n > v = it.next().value\n 12\n > v = it.next().value\n 4\n > var bool = it.next().done\n true\n\n"
3276
3277
iterCos,"\niterCos( iterator )\n Returns an iterator which iteratively computes the cosine.\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 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 = iterCos( random.iterators.randu() );\n > var r = it.next().value\n <number>\n > r = it.next().value\n <number>\n\n See Also\n --------\n base.cos, iterCospi, iterSin, iterTan\n"
3277
3278
iterCosh,"\niterCosh( iterator )\n Returns an iterator which iteratively computes the hyperbolic cosine.\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 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 r = random.iterators.uniform( -5.0, 5.0 );\n > var it = iterCosh( r );\n > var v = it.next().value\n <number>\n > v = it.next().value\n <number>\n\n See Also\n --------\n base.cosh, iterCos, iterSinh, iterTanh\n"
3278
3279
iterCosineWave,"\niterCosineWave( [options] )\n Returns an iterator which generates a cosine wave.\n\n If an environment supports Symbol.iterator, the returned iterator is\n iterable.\n\n Parameters\n ----------\n options: Object (optional)\n Function options.\n\n options.period: integer (optional)\n Period (i.e., the number of iterations before a cosine wave repeats).\n Default: 10.\n\n options.amplitude: number (optional)\n Peak amplitude. Default: 1.0.\n\n options.offset: integer (optional)\n Phase offset (in units of iterations; zero-based). A negative offset\n translates the waveform to the left. A positive offset translates a\n waveform to the right. Default: 0.\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 = iterCosineWave();\n > var v = it.next().value\n <number>\n > v = it.next().value\n <number>\n\n See Also\n --------\n iterPulse, iterSawtoothWave, iterSineWave, iterSquareWave, iterTriangleWave\n"
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/repl/info/data/data.csv
+1
Original file line number
Diff line number
Diff line change
@@ -3272,6 +3272,7 @@ iterCeil10,"\niterCeil10( iterator:Object )\n Returns an iterator which round
3272
3272
iterCompositesSeq,"\niterCompositesSeq( [options:Object] )\n Returns an iterator which generates a sequence of composite numbers.\n"
3273
3273
iterConcat,"\niterConcat( iter0:Object, ...iterator:Object )\n Returns an iterator which iterates over the values of two or more iterators.\n"
3274
3274
iterConstant,"\niterConstant( value:any[, options:Object] )\n Returns an iterator which always returns the same value.\n"
3275
+
iterContinuedFractionSeq,"\niterContinuedFractionSeq( x:number[, options:Object] )\n Returns an iterator which generates a list of all continued fraction terms\n which can be obtained given the precision of `x`.\n"
3275
3276
iterCos,"\niterCos( iterator:Object )\n Returns an iterator which iteratively computes the cosine.\n"
3276
3277
iterCosh,"\niterCosh( iterator:Object )\n Returns an iterator which iteratively computes the hyperbolic cosine.\n"
3277
3278
iterCosineWave,"\niterCosineWave( [options:Object] )\n Returns an iterator which generates a cosine wave.\n"
0 commit comments