Skip to content

Commit a20ca4a

Browse files
docs: update REPL namespace documentation
PR-URL: #10309 Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent 17fd10b commit a20ca4a

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ base.capitalize,"var out = base.capitalize( 'beep' )\nout = base.capitalize( 'Bo
228228
base.cbrt,"var y = base.cbrt( 64.0 )\ny = base.cbrt( 27.0 )\ny = base.cbrt( 0.0 )\ny = base.cbrt( -0.0 )\ny = base.cbrt( -9.0 )\ny = base.cbrt( NaN )\n"
229229
base.cbrtf,"var y = base.cbrtf( 64.0 )\ny = base.cbrtf( 27.0 )\ny = base.cbrtf( 0.0 )\ny = base.cbrtf( -0.0 )\ny = base.cbrtf( -9.0 )\ny = base.cbrtf( NaN )\n"
230230
base.cceil,"var v = base.cceil( new Complex128( -1.5, 2.5 ) )\n"
231-
base.cceilf,"var v = base.cceilf( new Complex64( -1.5, 2.5 ) )\nvar re = realf( v )\nvar im = imagf( v )\n"
231+
base.cceilf,"var v = base.cceilf( new Complex64( -1.5, 2.5 ) )\n"
232232
base.cceiln,"var out = base.cceiln( new Complex128( 5.555, -3.333 ), -2 )\nvar re = real( out )\nvar im = imag( out )\n"
233233
base.ccis,"var y = base.ccis( new Complex128( 0.0, 0.0 ) )\ny = base.ccis( new Complex128( 1.0, 0.0 ) )\n"
234234
base.cdiv,"var z1 = new Complex128( -13.0, -1.0 )\nvar z2 = new Complex128( -2.0, 1.0 )\nvar y = base.cdiv( z1, z2 )\nvar re = real( y )\nvar im = imag( y )\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
@@ -228,7 +228,7 @@ base.capitalize,"\nbase.capitalize( str )\n Capitalizes the first character i
228228
base.cbrt,"\nbase.cbrt( x )\n Computes the cube root of a double-precision floating-point number.\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Cube root.\n\n Examples\n --------\n > var y = base.cbrt( 64.0 )\n 4.0\n > y = base.cbrt( 27.0 )\n 3.0\n > y = base.cbrt( 0.0 )\n 0.0\n > y = base.cbrt( -0.0 )\n -0.0\n > y = base.cbrt( -9.0 )\n ~-2.08\n > y = base.cbrt( NaN )\n NaN\n\n See Also\n --------\n base.pow, base.sqrt\n"
229229
base.cbrtf,"\nbase.cbrtf( x )\n Computes the cube root of a single-precision floating-point number.\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Cube root.\n\n Examples\n --------\n > var y = base.cbrtf( 64.0 )\n 4.0\n > y = base.cbrtf( 27.0 )\n 3.0\n > y = base.cbrtf( 0.0 )\n 0.0\n > y = base.cbrtf( -0.0 )\n -0.0\n > y = base.cbrtf( -9.0 )\n ~-2.08\n > y = base.cbrtf( NaN )\n NaN\n\n See Also\n --------\n base.cbrt, base.sqrtf\n"
230230
base.cceil,"\nbase.cceil( z )\n Rounds each component of a double-precision complex floating-point number\n toward positive 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.cceil( new Complex128( -1.5, 2.5 ) )\n <Complex128>[ -1.0, 3.0 ]\n\n See Also\n --------\n base.cceiln, base.cfloor, base.cround\n"
231-
base.cceilf,"\nbase.cceilf( z )\n Rounds each component of a single-precision complex floating-point number\n toward positive infinity.\n\n Parameters\n ----------\n z: Complex64\n Complex number.\n\n Returns\n -------\n out: Complex64\n Result.\n\n Examples\n --------\n > var v = base.cceilf( new Complex64( -1.5, 2.5 ) )\n <Complex64>\n > var re = realf( v )\n -1.0\n > var im = imagf( v )\n 3.0\n\n See Also\n --------\n base.cceil\n"
231+
base.cceilf,"\nbase.cceilf( z )\n Rounds each component of a single-precision complex floating-point number\n toward positive infinity.\n\n Parameters\n ----------\n z: Complex64\n Complex number.\n\n Returns\n -------\n out: Complex64\n Result.\n\n Examples\n --------\n > var v = base.cceilf( new Complex64( -1.5, 2.5 ) )\n <Complex64>[ -1.0, 3.0 ]\n\n See Also\n --------\n base.cceil\n"
232232
base.cceiln,"\nbase.cceiln( z, n )\n Rounds each component of a double-precision complex number to the nearest\n multiple of `10^n` toward positive 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 out: Complex128\n Real and imaginary components.\n\n Examples\n --------\n > var out = base.cceiln( new Complex128( 5.555, -3.333 ), -2 )\n <Complex128>\n > var re = real( out )\n 5.56\n > var im = imag( out )\n -3.33\n\n See Also\n --------\n base.cceil, base.cfloorn, base.croundn\n"
233233
base.ccis,"\nbase.ccis( z )\n Evaluates the cis function for a double-precision complex floating-point\n 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.ccis( new Complex128( 0.0, 0.0 ) )\n <Complex128>[ 1.0, 0.0 ]\n > y = base.ccis( new Complex128( 1.0, 0.0 ) )\n <Complex128>[ ~0.540, ~0.841 ]\n\n"
234234
base.cdiv,"\nbase.cdiv( z1, z2 )\n Divides two double-precision complex floating-point numbers.\n\n Parameters\n ----------\n z1: Complex128\n Complex number.\n\n z2: Complex128\n Complex number.\n\n Returns\n -------\n out: Complex128\n Result.\n\n Examples\n --------\n > var z1 = new Complex128( -13.0, -1.0 )\n <Complex128>\n > var z2 = new Complex128( -2.0, 1.0 )\n <Complex128>\n > var y = base.cdiv( z1, z2 )\n <Complex128>\n > var re = real( y )\n 5.0\n > var im = imag( y )\n 3.0\n\n\nbase.cdiv.assign( re1, im1, re2, im2, out, strideOut, offsetOut )\n Divides two double-precision complex floating-point numbers and assigns\n results to a provided output array.\n\n Parameters\n ----------\n re1: number\n Real component of the first complex number.\n\n im1: number\n Imaginary component of the first complex number.\n\n re2: number\n Real component of the second complex number.\n\n im2: number\n Imaginary component of the second complex number.\n\n out: ArrayLikeObject\n Output array.\n\n strideOut: integer\n Stride length.\n\n offsetOut: integer\n Starting index.\n\n Returns\n -------\n out: ArrayLikeObject\n Output array.\n\n Examples\n --------\n > var out = new Float64Array( 2 );\n > base.cdiv.assign( -13.0, -1.0, -2.0, 1.0, out, 1, 0 )\n <Float64Array>[ 5.0, 3.0 ]\n\n\nbase.cdiv.strided( z1, sz1, oz1, z2, sz2, oz2, out, so, oo )\n Divides two double-precision complex floating-point numbers stored in real-\n valued strided array views and assigns results to a provided strided output\n array.\n\n Parameters\n ----------\n z1: ArrayLikeObject\n First complex number view.\n\n sz1: integer\n Stride length for `z1`.\n\n oz1: integer\n Starting index for `z1`.\n\n z2: ArrayLikeObject\n Second complex number view.\n\n sz2: integer\n Stride length for `z2`.\n\n oz2: integer\n Starting index for `z2`.\n\n out: ArrayLikeObject\n Output array.\n\n so: integer\n Stride length for `out`.\n\n oo: integer\n Starting index for `out`.\n\n Returns\n -------\n out: ArrayLikeObject\n Output array.\n\n Examples\n --------\n > var z1 = new Float64Array( [ -13.0, -1.0 ] );\n > var z2 = new Float64Array( [ -2.0, 1.0 ] );\n > var out = new Float64Array( 2 );\n > base.cdiv.strided( z1, 1, 0, z2, 1, 0, out, 1, 0 )\n <Float64Array>[ 5.0, 3.0 ]\n\n See Also\n --------\n base.cadd, base.cmul, base.csub"

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)