Skip to content

docs: update REPL namespace documentation #2638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/code-blocks/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ base.ceil10,"var y = base.ceil10( 3.14 )\ny = base.ceil10( -4.2 )\ny = base.ceil
base.ceilb,"var y = base.ceilb( 3.14159, -4, 10 )\ny = base.ceilb( 3.14159, 0, 2 )\ny = base.ceilb( 5.0, 1, 2 )\n"
base.ceilf,"var y = base.ceilf( 3.14 )\ny = base.ceilf( -4.2 )\ny = base.ceilf( -4.6 )\ny = base.ceilf( 9.5 )\ny = base.ceilf( -0.0 )\n"
base.ceiln,"var y = base.ceiln( 3.14159, -2 )\ny = base.ceiln( 3.14159, 0 )\ny = base.ceiln( 12368.0, 3 )\n"
base.ceilsd,"var y = base.ceilsd( 3.14159, 5 )\ny = base.ceilsd( 3.14159, 1 )\ny = base.ceilsd( 12368.0, 2 )\ny = base.ceilsd( 0.0313, 2, 2 )\n"
base.ceilsd,"var y = base.ceilsd( 3.14159, 5, 10 )\ny = base.ceilsd( 3.14159, 1, 10 )\ny = base.ceilsd( 12368.0, 2, 10 )\ny = base.ceilsd( 0.0313, 2, 2 )\n"
base.cexp,"var y = base.cexp( new Complex128( 0.0, 0.0 ) )\nvar re = real( y )\nvar im = imag( y )\ny = base.cexp( new Complex128( 0.0, 1.0 ) )\nre = real( y )\nim = imag( y )\n"
base.cflipsign,"var v = base.cflipsign( new Complex128( -4.2, 5.5 ), -9.0 )\nvar re = real( v )\nvar im = imag( v )\n"
base.cflipsignf,"var v = base.cflipsignf( new Complex64( -4.0, 5.0 ), -9.0 )\nvar re = realf( v )\nvar im = imagf( v )\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/code-blocks/data/data.json

Large diffs are not rendered by default.

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 (optional)\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 )\n 3.1416\n > y = base.ceilsd( 3.14159, 1 )\n 4.0\n > y = base.ceilsd( 12368.0, 2 )\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. 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.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.

2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/info/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ base.ceil10,"\nbase.ceil10( x:number )\n Rounds a numeric value to the neares
base.ceilb,"\nbase.ceilb( x:number, n:integer, b:integer )\n Rounds a numeric value to the nearest multiple of `b^n` toward positive\n infinity.\n"
base.ceilf,"\nbase.ceilf( x:number )\n Rounds a single-precision floating-point number toward positive infinity.\n"
base.ceiln,"\nbase.ceiln( x:number, n:integer )\n Rounds a numeric value to the nearest multiple of `10^n` toward positive\n infinity.\n"
base.ceilsd,"\nbase.ceilsd( x:number, n:integer[, b:integer] )\n Rounds a numeric value to the nearest number toward positive infinity with\n `n` significant figures.\n"
base.ceilsd,"\nbase.ceilsd( x:number, n:integer, b:integer )\n Rounds a numeric value to the nearest number toward positive infinity with\n `n` significant figures.\n"
base.cexp,"\nbase.cexp( z:Complex128 )\n Evaluates the exponential function for a double-precision complex floating-\n point number.\n"
base.cflipsign,"\nbase.cflipsign( z:Complex128, y:number )\n Returns a double-precision complex floating-point number with the same\n magnitude as `z` and the sign of `y*z`.\n"
base.cflipsignf,"\nbase.cflipsignf( z:Complex64, y:number )\n Returns a single-precision complex floating-point number with the same\n magnitude as `z` and the sign of `y*z`.\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/info/data/data.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/signature/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ base.ceil10,"base.ceil10( x )"
base.ceilb,"base.ceilb( x, n, b )"
base.ceilf,"base.ceilf( x )"
base.ceiln,"base.ceiln( x, n )"
base.ceilsd,"base.ceilsd( x, n[, b] )"
base.ceilsd,"base.ceilsd( x, n, b )"
base.cexp,"base.cexp( z )"
base.cflipsign,"base.cflipsign( z, y )"
base.cflipsignf,"base.cflipsignf( z, y )"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/signature/data/data.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ base.ceil10,"base.ceil10( x:number )"
base.ceilb,"base.ceilb( x:number, n:integer, b:integer )"
base.ceilf,"base.ceilf( x:number )"
base.ceiln,"base.ceiln( x:number, n:integer )"
base.ceilsd,"base.ceilsd( x:number, n:integer[, b:integer] )"
base.ceilsd,"base.ceilsd( x:number, n:integer, b:integer )"
base.cexp,"base.cexp( z:Complex128 )"
base.cflipsign,"base.cflipsign( z:Complex128, y:number )"
base.cflipsignf,"base.cflipsignf( z:Complex64, y:number )"
Expand Down

Large diffs are not rendered by default.

Loading