Skip to content

Commit 14448a8

Browse files
authored
docs: update REPL namespace documentation
PR-URL: #9836
1 parent 1b8a546 commit 14448a8

4 files changed

Lines changed: 4 additions & 4 deletions

File tree

lib/node_modules/@stdlib/repl/code-blocks/data/data.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ base.ceilf,"var y = base.ceilf( 3.14 )\ny = base.ceilf( -4.2 )\ny = base.ceilf(
242242
base.ceiln,"var y = base.ceiln( 3.14159, -2 )\ny = base.ceiln( 3.14159, 0 )\ny = base.ceiln( 12368.0, 3 )\n"
243243
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"
244244
base.cexp,"var y = base.cexp( new Complex128( 0.0, 0.0 ) )\ny = base.cexp( new Complex128( 0.0, 1.0 ) )\n"
245-
base.cflipsign,"var v = base.cflipsign( new Complex128( -4.2, 5.5 ), -9.0 )\nvar re = real( v )\nvar im = imag( v )\n"
245+
base.cflipsign,"var v = base.cflipsign( new Complex128( -4.2, 5.5 ), -9.0 )\n"
246246
base.cflipsignf,"var v = base.cflipsignf( new Complex64( -4.0, 5.0 ), -9.0 )\n"
247247
base.cfloor,"var v = base.cfloor( new Complex128( 5.5, 3.3 ) )\n"
248248
base.cfloorn,"var v = base.cfloorn( new Complex128( 5.555, -3.333 ), -2 )\n"

lib/node_modules/@stdlib/repl/code-blocks/data/data.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

lib/node_modules/@stdlib/repl/help/data/data.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ base.ceilf,"\nbase.ceilf( x )\n Rounds a single-precision floating-point numb
242242
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"
243243
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"
244244
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>[ 1.0, 0.0 ]\n > y = base.cexp( new Complex128( 0.0, 1.0 ) )\n <Complex128>[ ~0.540, ~0.841 ]\n\n"
245-
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"
245+
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>[ 4.2, -5.5 ]\n\n See Also\n --------\n base.cneg, base.csignum\n"
246246
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>[ 4.0, -5.0 ]\n\n See Also\n --------\n base.cnegf, base.cflipsign\n"
247247
base.cfloor,"\nbase.cfloor( z )\n Rounds a double-precision complex floating-point number toward negative\n infinity.\n\n Parameters\n ----------\n z: Complex128\n Complex number.\n\n Returns\n -------\n out: Complex128\n Result.\n\n Examples\n --------\n > var v = base.cfloor( new Complex128( 5.5, 3.3 ) )\n <Complex128>[ 5.0, 3.0 ]\n\n See Also\n --------\n base.cceil, base.cfloorn, base.cround\n"
248248
base.cfloorn,"\nbase.cfloorn( z, n )\n Rounds each component of a double-precision complex floating-point number\n to the nearest multiple of `10^n` toward negative infinity.\n\n Parameters\n ----------\n z: Complex128\n Complex number.\n\n n: integer\n Integer power of 10.\n\n Returns\n -------\n z: Complex128\n Result.\n\n Examples\n --------\n > var v = base.cfloorn( new Complex128( 5.555, -3.333 ), -2 )\n <Complex128>[ 5.55, -3.34 ]\n\n See Also\n --------\n base.cceiln, base.cfloor, base.croundn\n"

lib/node_modules/@stdlib/repl/help/data/data.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)