Skip to content

Commit

Permalink
docs: update REPL namespace documentation
Browse files Browse the repository at this point in the history
PR-URL: #2643
Co-authored-by: Athan Reines <[email protected]>
Reviewed-by: Athan Reines <[email protected]> 
Signed-off-by: stdlib-bot <[email protected]>
  • Loading branch information
stdlib-bot and kgryte authored Jul 21, 2024
1 parent 8de8d90 commit cde60a1
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ base.ceil10,"\nbase.ceil10( x )\n Rounds a numeric value to the nearest power
base.ceilb,"\nbase.ceilb( x, n, b )\n Rounds a numeric value to the nearest multiple of `b^n` toward positive\n infinity.\n\n Due to floating-point rounding error, rounding may not be exact.\n\n Parameters\n ----------\n x: number\n Input value.\n\n n: integer\n Integer power.\n\n b: integer\n Base.\n\n Returns\n -------\n y: number\n Rounded value.\n\n Examples\n --------\n // Round to 4 decimal places:\n > var y = base.ceilb( 3.14159, -4, 10 )\n 3.1416\n\n // If `n = 0` or `b = 1`, standard round behavior:\n > y = base.ceilb( 3.14159, 0, 2 )\n 4.0\n\n // Round to nearest multiple of two toward positive infinity:\n > y = base.ceilb( 5.0, 1, 2 )\n 6.0\n\n See Also\n --------\n base.ceil, base.ceiln, base.floorb, base.roundb\n"
base.ceilf,"\nbase.ceilf( x )\n Rounds a single-precision floating-point number toward positive infinity.\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Rounded value.\n\n Examples\n --------\n > var y = base.ceilf( 3.14 )\n 4.0\n > y = base.ceilf( -4.2 )\n -4.0\n > y = base.ceilf( -4.6 )\n -4.0\n > y = base.ceilf( 9.5 )\n 10.0\n > y = base.ceilf( -0.0 )\n -0.0\n\n See Also\n --------\n base.floorf\n"
base.ceiln,"\nbase.ceiln( x, n )\n Rounds a numeric value to the nearest multiple of `10^n` toward positive\n infinity.\n\n When operating on floating-point numbers in bases other than `2`, rounding\n to specified digits can be inexact.\n\n Parameters\n ----------\n x: number\n Input value.\n\n n: integer\n Integer power of 10.\n\n Returns\n -------\n y: number\n Rounded value.\n\n Examples\n --------\n // Round to 2 decimal places:\n > var y = base.ceiln( 3.14159, -2 )\n 3.15\n\n // If `n = 0`, standard round toward positive infinity behavior:\n > y = base.ceiln( 3.14159, 0 )\n 4.0\n\n // Round to nearest thousand:\n > y = base.ceiln( 12368.0, 3 )\n 13000.0\n\n\n See Also\n --------\n base.ceil, base.ceilb, base.floorn, base.roundn\n"
base.ceilsd,"\nbase.ceilsd( x, n, b )\n Rounds a numeric value to the nearest number toward positive infinity with\n `n` significant figures.\n\n Parameters\n ----------\n x: number\n Input value.\n\n n: integer\n Number of significant figures. Must be greater than 0.\n\n b: integer\n Base. Must be greater than 0. Default: 10.\n\n Returns\n -------\n y: number\n Rounded value.\n\n Examples\n --------\n > var y = base.ceilsd( 3.14159, 5, 10 )\n 3.1416\n > y = base.ceilsd( 3.14159, 1, 10 )\n 4.0\n > y = base.ceilsd( 12368.0, 2, 10 )\n 13000.0\n > y = base.ceilsd( 0.0313, 2, 2 )\n 0.046875\n\n See Also\n --------\n base.ceil, base.floorsd, base.roundsd, base.truncsd\n"
base.ceilsd,"\nbase.ceilsd( x, n, b )\n Rounds a numeric value to the nearest number toward positive infinity with\n `n` significant figures.\n\n Parameters\n ----------\n x: number\n Input value.\n\n n: integer\n Number of significant figures. Must be greater than 0.\n\n b: integer\n Base. Must be greater than 0.\n\n Returns\n -------\n y: number\n Rounded value.\n\n Examples\n --------\n > var y = base.ceilsd( 3.14159, 5, 10 )\n 3.1416\n > y = base.ceilsd( 3.14159, 1, 10 )\n 4.0\n > y = base.ceilsd( 12368.0, 2, 10 )\n 13000.0\n > y = base.ceilsd( 0.0313, 2, 2 )\n 0.046875\n\n See Also\n --------\n base.ceil, base.floorsd, base.roundsd, base.truncsd\n"
base.cexp,"\nbase.cexp( z )\n Evaluates the exponential function for a double-precision complex floating-\n point number.\n\n Parameters\n ----------\n z: Complex128\n Complex number.\n\n Returns\n -------\n out: Complex128\n Complex number.\n\n Examples\n --------\n > var y = base.cexp( new Complex128( 0.0, 0.0 ) )\n <Complex128>\n > var re = real( y )\n 1.0\n > var im = imag( y )\n 0.0\n > y = base.cexp( new Complex128( 0.0, 1.0 ) )\n <Complex128>\n > re = real( y )\n ~0.540\n > im = imag( y )\n ~0.841\n\n"
base.cflipsign,"\nbase.cflipsign( z, y )\n Returns a double-precision complex floating-point number with the same\n magnitude as `z` and the sign of `y*z`.\n\n Parameters\n ----------\n z: Complex128\n Complex number.\n\n y: number\n Number from which to derive the sign.\n\n Returns\n -------\n out: Complex128\n Result.\n\n Examples\n --------\n > var v = base.cflipsign( new Complex128( -4.2, 5.5 ), -9.0 )\n <Complex128>\n > var re = real( v )\n 4.2\n > var im = imag( v )\n -5.5\n\n See Also\n --------\n base.cneg, base.csignum\n"
base.cflipsignf,"\nbase.cflipsignf( z, y )\n Returns a single-precision complex floating-point number with the same\n magnitude as `z` and the sign of `y*z`.\n\n Parameters\n ----------\n z: Complex64\n Complex number.\n\n y: number\n Number from which to derive the sign.\n\n Returns\n -------\n out: Complex64\n Result.\n\n Examples\n --------\n > var v = base.cflipsignf( new Complex64( -4.0, 5.0 ), -9.0 )\n <Complex64>\n > var re = realf( v )\n 4.0\n > var im = imagf( v )\n -5.0\n\n See Also\n --------\n base.cnegf, base.cflipsign\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.json

Large diffs are not rendered by default.

1 comment on commit cde60a1

@stdlib-bot
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
repl/help $\color{green}95/95$
$\color{green}+100.00\%$
$\color{green}7/7$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}95/95$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.