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
@@ -1022,6 +1022,7 @@ var db = {
1022
1022
"incrmpe": "\nincrmpe()\n Returns an accumulator function which incrementally computes the mean\n percentage error (MPE).\n\n If provided input values, the accumulator function returns an updated mean\n percentage error. If not provided input values, the accumulator function\n returns the current mean percentage error.\n\n If provided `NaN` or a value which, when used in computations, results in\n `NaN`, the accumulated value is `NaN` for all future invocations.\n\n Returns\n -------\n acc: Function\n Accumulator function.\n\n Examples\n --------\n > var accumulator = incrmpe();\n > var m = accumulator()\n null\n > m = accumulator( 2.0, 3.0 )\n ~33.33\n > m = accumulator( 5.0, 2.0 )\n ~-58.33\n > m = accumulator()\n ~-58.33\n\n See Also\n --------\n incrmape, incrme, incrmmpe\n",
1023
1023
"incrmprod": "\nincrmprod( W )\n Returns an accumulator function which incrementally computes a moving\n product.\n\n The `W` parameter defines the number of values over which to compute the\n moving product.\n\n If provided a value, the accumulator function returns an updated moving\n product. If not provided a value, the accumulator function returns the\n current moving product.\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 provided values.\n\n For accumulations over large windows or accumulations of large numbers, care\n should be taken to prevent overflow. Note, however, that overflow/underflow\n may be transient, as the accumulator does not use a double-precision\n floating-point number to store an accumulated product. Instead, the\n accumulator splits an accumulated product into a normalized fraction and\n exponent and updates each component separately. Doing so guards against a\n loss in precision.\n\n Parameters\n ----------\n W: integer\n Window size.\n\n Returns\n -------\n acc: Function\n Accumulator function.\n\n Examples\n --------\n > var accumulator = incrmprod( 3 );\n > var p = accumulator()\n null\n > p = accumulator( 2.0 )\n 2.0\n > p = accumulator( -5.0 )\n -10.0\n > p = accumulator( 3.0 )\n -30.0\n > p = accumulator( 5.0 )\n -75.0\n > p = accumulator()\n -75.0\n\n See Also\n --------\n incrmsum, incrprod\n",
1024
1024
"incrmrange": "\nincrmrange( W )\n Returns an accumulator function which incrementally computes a moving range.\n\n The `W` parameter defines the number of values over which to compute the\n moving range.\n\n If provided a value, the accumulator function returns an updated moving\n range. If not provided a value, the accumulator function returns the current\n moving range.\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 provided values.\n\n Parameters\n ----------\n W: integer\n Window size.\n\n Returns\n -------\n acc: Function\n Accumulator function.\n\n Examples\n --------\n > var accumulator = incrmrange( 3 );\n > var r = accumulator()\n null\n > r = accumulator( 2.0 )\n 0.0\n > r = accumulator( -5.0 )\n 7.0\n > r = accumulator( 3.0 )\n 8.0\n > r = accumulator( 5.0 )\n 10.0\n > r = accumulator()\n 10.0\n\n See Also\n --------\n incrmmax, incrmmean, incrmmin, incrmsummary, incrrange\n",
1025
+
"incrmrss": "\nincrmrss( W )\n Returns an accumulator function which incrementally computes a moving\n residual sum of squares.\n\n The `W` parameter defines the number of values over which to compute the\n moving residual sum of squares.\n\n If provided a value, the accumulator function returns an updated moving\n residual sum of squares. If not provided a value, the accumulator function\n returns the current moving residual sum of squares.\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 provided values.\n\n Parameters\n ----------\n W: integer\n Window size.\n\n Returns\n -------\n acc: Function\n Accumulator function.\n\n Examples\n --------\n > var accumulator = incrmrss( 3 );\n > var r = accumulator()\n null\n > r = accumulator( 2.0, 3.0 )\n 1.0\n > r = accumulator( -5.0, 2.0 )\n 50.0\n > r = accumulator( 3.0, 2.0 )\n 51.0\n > r = accumulator( 5.0, -2.0 )\n 99.0\n > r = accumulator()\n 99.0\n\n See Also\n --------\n incrrss\n",
1025
1026
"incrmstdev": "\nincrmstdev( W[, mean] )\n Returns an accumulator function which incrementally computes a moving\n corrected sample standard deviation.\n\n The `W` parameter defines the number of values over which to compute the\n moving corrected sample standard deviation.\n\n If provided a value, the accumulator function returns an updated moving\n corrected sample standard deviation. If not provided a value, the\n accumulator function returns the current moving corrected sample standard\n deviation.\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 provided values.\n\n Parameters\n ----------\n W: integer\n Window size.\n\n mean: number (optional)\n Known mean.\n\n Returns\n -------\n acc: Function\n Accumulator function.\n\n Examples\n --------\n > var accumulator = incrmstdev( 3 );\n > var s = accumulator()\n null\n > s = accumulator( 2.0 )\n 0.0\n > s = accumulator( -5.0 )\n ~4.95\n > s = accumulator( 3.0 )\n ~4.36\n > s = accumulator( 5.0 )\n ~5.29\n > s = accumulator()\n ~5.29\n\n See Also\n --------\n incrmmean, incrmsummary, incrmvariance, incrstdev\n",
1026
1027
"incrmsum": "\nincrmsum( W )\n Returns an accumulator function which incrementally computes a moving sum.\n\n The `W` parameter defines the number of values over which to compute the\n moving sum.\n\n If provided a value, the accumulator function returns an updated moving sum.\n If not provided a value, the accumulator function returns the current moving\n sum.\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 provided values.\n\n Parameters\n ----------\n W: integer\n Window size.\n\n Returns\n -------\n acc: Function\n Accumulator function.\n\n Examples\n --------\n > var accumulator = incrmsum( 3 );\n > var s = accumulator()\n null\n > s = accumulator( 2.0 )\n 2.0\n > s = accumulator( -5.0 )\n -3.0\n > s = accumulator( 3.0 )\n 0.0\n > s = accumulator( 5.0 )\n 3.0\n > s = accumulator()\n 3.0\n\n See Also\n --------\n incrmmean, incrmsummary, incrsum\n",
1027
1028
"incrmsumabs": "\nincrmsumabs( W )\n Returns an accumulator function which incrementally computes a moving sum of\n absolute values.\n\n The `W` parameter defines the number of values over which to compute the\n moving sum.\n\n If provided a value, the accumulator function returns an updated moving sum.\n If not provided a value, the accumulator function returns the current moving\n sum.\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 provided values.\n\n Parameters\n ----------\n W: integer\n Window size.\n\n Returns\n -------\n acc: Function\n Accumulator function.\n\n Examples\n --------\n > var accumulator = incrmsumabs( 3 );\n > var s = accumulator()\n null\n > s = accumulator( 2.0 )\n 2.0\n > s = accumulator( -5.0 )\n 7.0\n > s = accumulator( 3.0 )\n 10.0\n > s = accumulator( -5.0 )\n 13.0\n > s = accumulator()\n 13.0\n\n See Also\n --------\n incrmmeanabs, incrmsum, incrsum, incrsumabs\n",
@@ -1035,7 +1036,7 @@ var db = {
1035
1036
"incrpcorrmat": "\nincrpcorrmat( out[, means] )\n Returns an accumulator function which incrementally computes a sample\n Pearson product-moment correlation matrix.\n\n If provided a data vector, the accumulator function returns an updated\n sample correlation matrix. If not provided a data vector, the accumulator\n function returns the current sample correlation matrix.\n\n Parameters\n ----------\n out: integer|ndarray\n Order of the correlation matrix or a square 2-dimensional ndarray for\n storing the correlation matrix.\n\n means: ndarray (optional)\n Known means.\n\n Returns\n -------\n acc: Function\n Accumulator function.\n\n Examples\n --------\n > var accumulator = incrpcorrmat( 2 );\n > var out = accumulator()\n <ndarray>\n > var vec = {{alias:@stdlib/ndarray/ctor}}( 'float64', 1 );\n > var buf = new Float64Array( 2 );\n > var shape = [ 2 ];\n > var strides = [ 1 ];\n > var v = vec( buf, shape, strides, 0, 'row-major' );\n > v.set( 0, 2.0 );\n > v.set( 1, 1.0 );\n > out = accumulator( v )\n <ndarray>\n > v.set( 0, -5.0 );\n > v.set( 1, 3.14 );\n > out = accumulator( v )\n <ndarray>\n > out = accumulator()\n <ndarray>\n\n See Also\n --------\n incrcovmat, incrpcorr, incrpcorrdistmat\n",
1036
1037
"incrprod": "\nincrprod()\n Returns an accumulator function which incrementally computes a product.\n\n If provided a value, the accumulator function returns an updated product. If\n not provided a value, the accumulator function returns the current product.\n\n If provided `NaN` or a value which, when used in computations, results in\n `NaN`, the accumulated value is `NaN` for all future invocations.\n\n For long running accumulations or accumulations of large numbers, care\n should be taken to prevent overflow. Note, however, that overflow/underflow\n may be transient, as the accumulator does not use a double-precision\n floating-point number to store an accumulated product. Instead, the\n accumulator splits an accumulated product into a normalized fraction and\n exponent and updates each component separately. Doing so guards against a\n loss in precision.\n\n Returns\n -------\n acc: Function\n Accumulator function.\n\n Examples\n --------\n > var accumulator = incrprod();\n > var v = accumulator()\n null\n > v = accumulator( 2.0 )\n 2.0\n > v = accumulator( -5.0 )\n -10.0\n > v = accumulator()\n -10.0\n\n See Also\n --------\n incrsum, incrsummary\n",
1037
1038
"incrrange": "\nincrrange()\n Returns an accumulator function which incrementally computes a range.\n\n If provided a value, the accumulator function returns an updated range. If\n not provided a value, the accumulator function returns the current range.\n\n If provided `NaN`, the range is `NaN` for all future invocations.\n\n Returns\n -------\n acc: Function\n Accumulator function.\n\n Examples\n --------\n > var accumulator = incrrange();\n > var v = accumulator()\n null\n > v = accumulator( -2.0 )\n 0.0\n > v = accumulator( 1.0 )\n 3.0\n > v = accumulator( 3.0 )\n 5.0\n > v = accumulator()\n 5.0\n\n See Also\n --------\n incrmax, incrmean, incrmin, incrmrange, incrsummary\n",
1038
-
"incrrss": "\nincrrss()\n Returns an accumulator function which incrementally computes the residual\n sum of squares.\n\n If provided input values, the accumulator function returns an updated\n residual sum of squares. If not provided input values, the accumulator\n function returns the current residual sum of squares.\n\n If provided `NaN` or a value which, when used in computations, results in\n `NaN`, the accumulated value is `NaN` for all future invocations.\n\n Returns\n -------\n acc: Function\n Accumulator function.\n\n Examples\n --------\n > var accumulator = incrrss();\n > var r = accumulator()\n null\n > r = accumulator( 2.0, 3.0 )\n 1.0\n > r = accumulator( -5.0, 2.0 )\n 50.0\n > r = accumulator()\n 50.0\n\n",
1039
+
"incrrss": "\nincrrss()\n Returns an accumulator function which incrementally computes the residual\n sum of squares.\n\n If provided input values, the accumulator function returns an updated\n residual sum of squares. If not provided input values, the accumulator\n function returns the current residual sum of squares.\n\n If provided `NaN` or a value which, when used in computations, results in\n `NaN`, the accumulated value is `NaN` for all future invocations.\n\n Returns\n -------\n acc: Function\n Accumulator function.\n\n Examples\n --------\n > var accumulator = incrrss();\n > var r = accumulator()\n null\n > r = accumulator( 2.0, 3.0 )\n 1.0\n > r = accumulator( -5.0, 2.0 )\n 50.0\n > r = accumulator()\n 50.0\n\n See Also\n --------\n incrmrss\n",
1039
1040
"incrskewness": "\nincrskewness()\n Returns an accumulator function which incrementally computes a corrected\n sample skewness.\n\n If provided a value, the accumulator function returns an updated corrected\n sample skewness. If not provided a value, the accumulator function returns\n the current corrected sample skewness.\n\n If provided `NaN` or a value which, when used in computations, results in\n `NaN`, the accumulated value is `NaN` for all future invocations.\n\n Returns\n -------\n acc: Function\n Accumulator function.\n\n Examples\n --------\n > var accumulator = incrskewness();\n > var v = accumulator( 2.0 )\n null\n > v = accumulator( -5.0 )\n null\n > v = accumulator( -10.0 )\n ~0.492\n > v = accumulator()\n ~0.492\n\n See Also\n --------\n incrkurtosis, incrmean, incrstdev, incrsummary, incrvariance\n",
1040
1041
"incrspace": "\nincrspace( start, stop[, increment] )\n Generates a linearly spaced numeric array using a provided increment.\n\n If an `increment` is not provided, the default `increment` is `1`.\n\n The output array is guaranteed to include the `start` value but does not\n include the `stop` value.\n\n Parameters\n ----------\n start: number\n First array value.\n\n stop: number\n Array element bound.\n\n increment: number (optional)\n Increment. Default: `1`.\n\n Returns\n -------\n arr: Array\n Linearly spaced numeric array.\n\n Examples\n --------\n > var arr = incrspace( 0, 11, 2 )\n [ 0, 2, 4, 6, 8, 10 ]\n\n See Also\n --------\n linspace, logspace\n",
1041
1042
"incrstdev": "\nincrstdev( [mean] )\n Returns an accumulator function which incrementally computes a corrected\n sample standard deviation.\n\n If provided a value, the accumulator function returns an updated corrected\n sample standard deviation. If not provided a value, the accumulator function\n returns the current corrected sample standard deviation.\n\n If provided `NaN` or a value which, when used in computations, results in\n `NaN`, the accumulated value is `NaN` for all future invocations.\n\n Parameters\n ----------\n mean: number (optional)\n Known mean.\n\n Returns\n -------\n acc: Function\n Accumulator function.\n\n Examples\n --------\n > var accumulator = incrstdev();\n > var s = accumulator()\n null\n > s = accumulator( 2.0 )\n 0.0\n > s = accumulator( -5.0 )\n ~4.95\n > s = accumulator()\n ~4.95\n\n See Also\n --------\n incrkurtosis, incrmean, incrmstdev, incrskewness, incrsummary, incrvariance\n",
0 commit comments