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
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -593,6 +593,7 @@ module.exports = {
593
593
"base.isPow2Uint32": "\nbase.isPow2Uint32( x )\n Tests whether an unsigned integer is a power of 2.\n\n Parameters\n ----------\n x: integer\n Unsigned integer.\n\n Returns\n -------\n bool: boolean\n Boolean indicating if a value is a power of 2.\n\n Examples\n --------\n > var bool = base.isPow2Uint32( 2 )\n true\n > bool = base.isPow2Uint32( 5 )\n false\n\n",
594
594
"base.isProbability": "\nbase.isProbability( x )\n Tests if a numeric value is a probability.\n\n A probability is defined as a numeric value on the closed interval `[0,1]`.\n\n Parameters\n ----------\n x: number\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether the value is a probability.\n\n Examples\n --------\n > var bool = base.isProbability( 0.5 )\n true\n > bool = base.isProbability( 3.14 )\n false\n > bool = base.isProbability( NaN )\n false\n\n",
595
595
"base.isSafeInteger": "\nbase.isSafeInteger( x )\n Tests if a finite double-precision floating-point number is a safe integer.\n\n An integer valued number is \"safe\" when the number can be exactly\n represented as a double-precision floating-point number.\n\n Parameters\n ----------\n x: number\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether the value is a safe integer.\n\n Examples\n --------\n > var bool = base.isSafeInteger( 1.0 )\n true\n > bool = base.isSafeInteger( 2.0e200 )\n false\n > bool = base.isSafeInteger( 3.14 )\n false\n\n",
596
+
"base.kernelBetainc": "\nbase.kernelBetainc( [out,] x, a, b, regularized, upper )\n Computes the kernel function for the regularized incomplete beta function.\n\n The `regularized` and `upper` parameters specify whether to evaluate the\n non-regularized and/or upper incomplete beta functions, respectively.\n\n If provided `x < 0` or `x > 1`, the function returns `[ NaN, NaN ]`.\n\n If provided `a < 0` or `b < 0`, the function returns `[ NaN, NaN ]`.\n\n If provided `NaN` for `x`, `a`, or `b`, the function returns `[ NaN, NaN ]`.\n\n Parameters\n ----------\n out: Array|TypedArray|Object (optional)\n Output array.\n\n x: number\n First function parameter.\n\n a: number\n Second function parameter.\n\n b: number\n Third function parameter.\n\n regularized: boolean\n Boolean indicating whether the function should evaluate the regularized\n or non-regularized incomplete beta function.\n\n upper: boolean\n Boolean indicating whether the function should return the upper tail of\n the incomplete beta function.\n\n Returns\n -------\n y: Array|TypedArray|Object\n Function value and first derivative.\n\n Examples\n --------\n > var out = base.kernelBetainc( 2.0, 2.0, false, false )\n [ ~0.083, ~1.5 ]\n > out = base.kernelBetainc( 0.2, 1.0, 2.0, true, false )\n [ 0.32, 1.6 ]\n\n > out = new Array( 2 );\n > var v = base.kernelBetainc( out, 0.2, 1.0, 2.0, true, true )\n [ 0.64, 1.6 ]\n > var bool = ( v === out )\n true\n\n See Also\n --------\n base.betainc\n",
596
597
"base.kernelBetaincinv": "\nbase.kernelBetaincinv( a, b, p, q )\n Computes the inverse of the lower incomplete beta function.\n\n Probabilities `p` and `q` must satisfy `p = 1 - q`.\n\n Parameters\n ----------\n a: number\n First function parameter (a positive number).\n\n b: number\n Second function parameter (a positive number).\n\n p: number\n Probability.\n\n q: number\n Probability equal to `1-p`.\n\n Returns\n -------\n out: Array\n Two-element array holding function value `y` and `1-y`.\n\n Examples\n --------\n > var y = base.kernelBetaincinv( 3.0, 3.0, 0.2, 0.8 )\n [ ~0.327, ~0.673 ]\n > y = base.kernelBetaincinv( 3.0, 3.0, 0.4, 0.6 )\n [ ~0.446, ~0.554 ]\n > y = base.kernelBetaincinv( 1.0, 6.0, 0.4, 0.6 )\n [ ~0.082, ~0.918 ]\n > y = base.kernelBetaincinv( 1.0, 6.0, 0.8, 0.2 )\n [ ~0.235, ~0.765 ]\n\n See Also\n --------\n base.betaincinv\n",
597
598
"base.kernelCos": "\nbase.kernelCos( x, y )\n Computes the cosine of a number on `[-π/4, π/4]`.\n\n For increased accuracy, the number for which the cosine should be evaluated\n can be supplied as a double-double number (i.e., a non-evaluated sum of two\n double-precision floating-point numbers `x` and `y`).\n\n The two numbers must satisfy `|y| < 0.5 * ulp( x )`.\n\n If either argument is `NaN`, the function returns `NaN`.\n\n Parameters\n ----------\n x: number\n Input value (in radians).\n\n y: number\n Tail of `x`.\n\n Returns\n -------\n out: number\n Cosine.\n\n Examples\n --------\n > var out = base.kernelCos( 0.0, 0.0 )\n ~1.0\n > out = base.kernelCos( PI/6.0, 0.0 )\n ~0.866\n > out = base.kernelCos( 0.785, -1.144e-17 )\n ~0.707\n > out = base.kernelCos( NaN )\n NaN\n\n See Also\n --------\n base.cos, base.kernelSin, base.kernelTan\n",
598
599
"base.kernelSin": "\nbase.kernelSin( x, y )\n Computes the sine of a number on `[-π/4, π/4]`.\n\n For increased accuracy, the number for which the cosine should be evaluated\n can be supplied as a double-double number (i.e., a non-evaluated sum of two\n double-precision floating-point numbers `x` and `y`).\n\n The two numbers must satisfy `|y| < 0.5 * ulp( x )`.\n\n If either argument is `NaN`, the function returns `NaN`.\n\n Parameters\n ----------\n x: number\n Input value (in radians).\n\n y: number\n Tail of `x`.\n\n Returns\n -------\n out: number\n Sine.\n\n Examples\n --------\n > var y = base.kernelSin( 0.0, 0.0 )\n ~0.0\n > y = base.kernelSin( PI/6.0, 0.0 )\n ~0.5\n > y = base.kernelSin( 0.619, 9.279e-18 )\n ~0.581\n\n > y = base.kernelSin( NaN, 0.0 )\n NaN\n > y = base.kernelSin( 2.0, NaN )\n NaN\n > y = base.kernelSin( NaN, NaN )\n NaN\n\n See Also\n --------\n base.kernelCos, base.kernelTan, base.sin\n",
@@ -882,6 +883,7 @@ module.exports = {
882
883
"hasInt32ArraySupport": "\nhasInt32ArraySupport()\n Tests for native `Int32Array` support.\n\n Returns\n -------\n bool: boolean\n Boolean indicating if an environment has `Int32Array` support.\n\n Examples\n --------\n > var bool = hasInt32ArraySupport()\n <boolean>\n\n",
883
884
"hasInt8ArraySupport": "\nhasInt8ArraySupport()\n Tests for native `Int8Array` support.\n\n Returns\n -------\n bool: boolean\n Boolean indicating if an environment has `Int8Array` support.\n\n Examples\n --------\n > var bool = hasInt8ArraySupport()\n <boolean>\n\n",
884
885
"hasMapSupport": "\nhasMapSupport()\n Tests for native `Map` support.\n\n Returns\n -------\n bool: boolean\n Boolean indicating if an environment has `Map` support.\n\n Examples\n --------\n > var bool = hasMapSupport()\n <boolean>\n\n",
886
+
"hasNodeBufferSupport": "\nhasNodeBufferSupport()\n Tests for native `Buffer` support.\n\n Returns\n -------\n bool: boolean\n Boolean indicating if an environment has `Buffer` support.\n\n Examples\n --------\n > var bool = hasNodeBufferSupport()\n <boolean>\n\n",
885
887
"hasOwnProp": "\nhasOwnProp( value, property )\n Tests if an object has a specified property.\n\n In contrast to the native `Object.prototype.hasOwnProperty`, this function\n does not throw when provided `null` or `undefined`. Instead, the function\n returns `false`.\n\n Value arguments other than `null` or `undefined` are coerced to objects.\n\n Property arguments are coerced to strings.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n property: any\n Property to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating if an object has a specified property.\n\n Examples\n --------\n > var beep = { 'boop': true };\n > var bool = hasOwnProp( beep, 'boop' )\n true\n > bool = hasOwnProp( beep, 'bop' )\n false\n\n See Also\n --------\n hasProp\n",
886
888
"hasProp": "\nhasProp( value, property )\n Tests if an object has a specified property, either own or inherited.\n\n Value arguments other than `null` or `undefined` are coerced to objects.\n\n Property arguments are coerced to strings.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n property: any\n Property to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating if an object has a specified property.\n\n Examples\n --------\n > var beep = { 'boop': true };\n > var bool = hasProp( beep, 'boop' )\n true\n > bool = hasProp( beep, 'toString' )\n true\n > bool = hasProp( beep, 'bop' )\n false\n\n See Also\n --------\n hasOwnProp\n",
887
889
"hasPrototype": "\nhasPrototype( value, proto )\n Tests if an object's prototype chain contains a provided prototype.\n\n The function returns `false` if provided a primitive value.\n\n This function is generally more robust than the `instanceof` operator (e.g.,\n where inheritance is performed without using constructors).\n\n Parameters\n ----------\n value: any\n Input value.\n\n proto: Object|Function\n Prototype.\n\n Returns\n -------\n bool: boolean\n Boolean indicating if a provided prototype exists in a prototype chain.\n\n Examples\n --------\n > function Foo() { return this; };\n > function Bar() { return this; };\n > inherit( Bar, Foo );\n > var bar = new Bar();\n > var bool = hasPrototype( bar, Foo.prototype )\n true\n\n See Also\n --------\n getPrototypeOf\n",
0 commit comments