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/lib/docs.js
+1-1
Original file line number
Diff line number
Diff line change
@@ -458,7 +458,7 @@ module.exports = {
458
458
"base.hacoversin": "\nbase.hacoversin( x )\n Computes the half-value coversed sine.\n\n The half-value coversed sine is defined as `(1 - sin(x)) / 2`.\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Half-value coversed sine (in radians).\n\n Examples\n --------\n > var y = base.hacoversin( 3.14 )\n ~0.4992\n > y = base.hacoversin( -4.2 )\n ~0.0642\n > y = base.hacoversin( -4.6 )\n ~0.0032\n > y = base.hacoversin( 9.5 )\n ~0.4624\n > y = base.hacoversin( -0.0 )\n 0.5\n\n See Also\n --------\n base.hacovercos, base.haversin\n",
459
459
"base.havercos": "\nbase.havercos( x )\n Computes the half-value versed cosine.\n\n The half-value versed cosine is defined as `(1 + cos(x)) / 2`.\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Half-value versed cosine (in radians).\n\n Examples\n --------\n > var y = base.havercos( 3.14 )\n ~0.0\n > y = base.havercos( -4.2 )\n ~0.2549\n > y = base.havercos( -4.6 )\n ~0.4439\n > y = base.havercos( 9.5 )\n ~0.0014\n > y = base.havercos( -0.0 )\n 1.0\n\n See Also\n --------\n base.haversin, base.vercos\n",
460
460
"base.haversin": "\nbase.haversin( x )\n Computes the half-value versed sine.\n\n The half-value versed sine is defined as `(1 - cos(x)) / 2`.\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Half-value versed sine (in radians).\n\n Examples\n --------\n > var y = base.haversin( 3.14 )\n ~1.0\n > y = base.haversin( -4.2 )\n ~0.7451\n > y = base.haversin( -4.6 )\n ~0.5561\n > y = base.haversin( 9.5 )\n ~0.9986\n > y = base.haversin( -0.0 )\n 0.0\n\n See Also\n --------\n base.havercos, base.versin\n",
461
-
"base.heaviside": "\nbase.heaviside( x[, continuity] )\n Evaluates the Heaviside function.\n\n To `continuity` argument may be one of the following:\n\n - `half-maximum`: if `x == 0`, the function returns `0.5`.\n - `left-continuous`: if `x == 0`, the function returns `0`.\n - `right-continuous`: if `x == 0`, the function returns `1`.\n\n By default, if `x == 0`, the function returns `NaN` (i.e., the function is\n discontinuous).\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Function value.\n\n Examples\n --------\n > var y = base.heaviside( 3.14 )\n 1.0\n > y = base.heaviside( -3.14 )\n 0.0\n > y = base.heaviside( 0.0 )\n NaN\n > y = base.heaviside( 0.0, 'half-maximum' )\n 0.5\n > y = base.heaviside( 0.0, 'left-continuous' )\n 0.0\n > y = base.heaviside( 0.0, 'right-continuous' )\n 1.0\n\n See Also\n --------\n base.ramp\n",
461
+
"base.heaviside": "\nbase.heaviside( x[, continuity] )\n Evaluates the Heaviside function.\n\n To `continuity` argument may be one of the following:\n\n - 'half-maximum': if `x == 0`, the function returns `0.5`.\n - 'left-continuous': if `x == 0`, the function returns `0`.\n - 'right-continuous': if `x == 0`, the function returns `1`.\n\n By default, if `x == 0`, the function returns `NaN` (i.e., the function is\n discontinuous).\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Function value.\n\n Examples\n --------\n > var y = base.heaviside( 3.14 )\n 1.0\n > y = base.heaviside( -3.14 )\n 0.0\n > y = base.heaviside( 0.0 )\n NaN\n > y = base.heaviside( 0.0, 'half-maximum' )\n 0.5\n > y = base.heaviside( 0.0, 'left-continuous' )\n 0.0\n > y = base.heaviside( 0.0, 'right-continuous' )\n 1.0\n\n See Also\n --------\n base.ramp\n",
462
462
"base.hypot": "\nbase.hypot( x, y )\n Computes the hypotenuse avoiding overflow and underflow.\n\n If either argument is `NaN`, the function returns `NaN`.\n\n Parameters\n ----------\n x: number\n First number.\n\n y: number\n Second number.\n\n Returns\n -------\n out: number\n Hypotenuse.\n\n Examples\n --------\n > var h = base.hypot( -5.0, 12.0 )\n 13.0\n > h = base.hypot( NaN, 12.0 )\n NaN\n > h = base.hypot( -0.0, -0.0 )\n 0.0\n\n",
463
463
"base.int32ToUint32": "\nbase.int32ToUint32( x )\n Converts a signed 32-bit integer to an unsigned 32-bit integer.\n\n Parameters\n ----------\n x: integer\n Signed 32-bit integer.\n\n Returns\n -------\n out: integer\n Unsigned 32-bit integer.\n\n Examples\n --------\n > var y = base.int32ToUint32( base.float64ToInt32( -32 ) )\n 4294967264\n > y = base.int32ToUint32( base.float64ToInt32( 3 ) )\n 3\n\n See Also\n --------\n base.uint32ToInt32\n",
464
464
"base.isEven": "\nbase.isEven( x )\n Tests if a finite numeric value is an even number.\n\n The function assumes a finite number. If provided positive or negative\n infinity, the function will return `true`, when, in fact, the result is\n undefined.\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 an even number.\n\n Examples\n --------\n > var bool = base.isEven( 5.0 )\n false\n > bool = base.isEven( -2.0 )\n true\n > bool = base.isEven( 0.0 )\n true\n > bool = base.isEven( NaN )\n false\n\n See Also\n --------\n base.isOdd\n",
0 commit comments