Skip to content

Commit fdf0183

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

File tree

10 files changed

+16
-6
lines changed

10 files changed

+16
-6
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,8 @@ base.cceilf,"var v = base.cceilf( new Complex64( -1.5, 2.5 ) )\nvar re = realf(
230230
base.cceiln,"var out = base.cceiln( new Complex128( 5.555, -3.333 ), -2 )\nvar re = real( out )\nvar im = imag( out )\n"
231231
base.ccis,"var y = base.ccis( new Complex128( 0.0, 0.0 ) )\nvar re = real( y )\nvar im = imag( y )\ny = base.ccis( new Complex128( 1.0, 0.0 ) )\nre = real( y )\nim = imag( y )\n"
232232
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"
233+
base.cdiv.assign,"var out = new Float64Array( 2 );\nbase.cdiv.assign( -13.0, -1.0, -2.0, 1.0, out, 1, 0 )\n"
234+
base.cdiv.strided,"var z1 = new Float64Array( [ -13.0, -1.0 ] );\nvar z2 = new Float64Array( [ -2.0, 1.0 ] );\nvar out = new Float64Array( 2 );\nbase.cdiv.strided( z1, 1, 0, z2, 1, 0, out, 1, 0 )\n"
233235
base.ceil,"var y = base.ceil( 3.14 )\ny = base.ceil( -4.2 )\ny = base.ceil( -4.6 )\ny = base.ceil( 9.5 )\ny = base.ceil( -0.0 )\n"
234236
base.ceil2,"var y = base.ceil2( 3.14 )\ny = base.ceil2( -4.2 )\ny = base.ceil2( -4.6 )\ny = base.ceil2( 9.5 )\ny = base.ceil2( 13.0 )\ny = base.ceil2( -13.0 )\ny = base.ceil2( -0.0 )\n"
235237
base.ceil10,"var y = base.ceil10( 3.14 )\ny = base.ceil10( -4.2 )\ny = base.ceil10( -4.6 )\ny = base.ceil10( 9.5 )\ny = base.ceil10( 13.0 )\ny = base.ceil10( -13.0 )\ny = base.ceil10( -0.0 )\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: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,9 @@ base.cceil,"\nbase.cceil( z )\n Rounds each component of a double-precision c
229229
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"
230230
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"
231231
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>\n > var re = real( y )\n 1.0\n > var im = imag( y )\n 0.0\n > y = base.ccis( new Complex128( 1.0, 0.0 ) )\n <Complex128>\n > re = real( y )\n ~0.540\n > im = imag( y )\n ~0.841\n\n"
232-
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 See Also\n --------\n base.cadd, base.cmul, base.csub\n"
232+
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"
233+
base.cdiv.assign,"\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 ]"
234+
base.cdiv.strided,"\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"
233235
base.ceil,"\nbase.ceil( x )\n Rounds a double-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.ceil( 3.14 )\n 4.0\n > y = base.ceil( -4.2 )\n -4.0\n > y = base.ceil( -4.6 )\n -4.0\n > y = base.ceil( 9.5 )\n 10.0\n > y = base.ceil( -0.0 )\n -0.0\n\n See Also\n --------\n base.ceiln, base.floor, base.round\n"
234236
base.ceil2,"\nbase.ceil2( x )\n Rounds a numeric value to the nearest power of two 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.ceil2( 3.14 )\n 4.0\n > y = base.ceil2( -4.2 )\n -4.0\n > y = base.ceil2( -4.6 )\n -4.0\n > y = base.ceil2( 9.5 )\n 16.0\n > y = base.ceil2( 13.0 )\n 16.0\n > y = base.ceil2( -13.0 )\n -8.0\n > y = base.ceil2( -0.0 )\n -0.0\n\n See Also\n --------\n base.ceil, base.ceil10, base.floor2, base.round2\n"
235237
base.ceil10,"\nbase.ceil10( x )\n Rounds a numeric value to the nearest power of ten toward positive infinity.\n\n The function may not return accurate results for subnormals due to a general\n loss in precision.\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.ceil10( 3.14 )\n 10.0\n > y = base.ceil10( -4.2 )\n -1.0\n > y = base.ceil10( -4.6 )\n -1.0\n > y = base.ceil10( 9.5 )\n 10.0\n > y = base.ceil10( 13.0 )\n 100.0\n > y = base.ceil10( -13.0 )\n -10.0\n > y = base.ceil10( -0.0 )\n -0.0\n\n See Also\n --------\n base.ceil, base.ceil2, base.floor10, base.round10\n"

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

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

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,8 @@ base.cceilf,"\nbase.cceilf( z:Complex64 )\n Rounds each component of a single
230230
base.cceiln,"\nbase.cceiln( z:Complex128, n:integer )\n Rounds each component of a double-precision complex number to the nearest\n multiple of `10^n` toward positive infinity.\n"
231231
base.ccis,"\nbase.ccis( z:Complex128 )\n Evaluates the cis function for a double-precision complex floating-point\n number.\n"
232232
base.cdiv,"\nbase.cdiv( z1:Complex128, z2:Complex128 )\n Divides two double-precision complex floating-point numbers.\n"
233+
base.cdiv.assign,"\nbase.cdiv.assign( re1:number, im1:number, re2:number, im2:number, \n out:ArrayLikeObject, strideOut:integer, offsetOut:integer )\n Divides two double-precision complex floating-point numbers and assigns\n results to a provided output array.\n"
234+
base.cdiv.strided,"\nbase.cdiv.strided( z1:ArrayLikeObject, sz1:integer, oz1:integer, \n z2:ArrayLikeObject, sz2:integer, oz2:integer, out:ArrayLikeObject, \n so:integer, oo:integer )\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"
233235
base.ceil,"\nbase.ceil( x:number )\n Rounds a double-precision floating-point number toward positive infinity.\n"
234236
base.ceil2,"\nbase.ceil2( x:number )\n Rounds a numeric value to the nearest power of two toward positive infinity.\n"
235237
base.ceil10,"\nbase.ceil10( x:number )\n Rounds a numeric value to the nearest power of ten toward positive infinity.\n"

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

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

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,8 @@ base.cceilf,"base.cceilf( z )"
230230
base.cceiln,"base.cceiln( z, n )"
231231
base.ccis,"base.ccis( z )"
232232
base.cdiv,"base.cdiv( z1, z2 )"
233+
base.cdiv.assign,"base.cdiv.assign( re1, im1, re2, im2, out, strideOut, offsetOut )"
234+
base.cdiv.strided,"base.cdiv.strided( z1, sz1, oz1, z2, sz2, oz2, out, so, oo )"
233235
base.ceil,"base.ceil( x )"
234236
base.ceil2,"base.ceil2( x )"
235237
base.ceil10,"base.ceil10( x )"

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

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

lib/node_modules/@stdlib/repl/typed-signature/data/data.csv

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,8 @@ base.cceilf,"base.cceilf( z:Complex64 )"
230230
base.cceiln,"base.cceiln( z:Complex128, n:integer )"
231231
base.ccis,"base.ccis( z:Complex128 )"
232232
base.cdiv,"base.cdiv( z1:Complex128, z2:Complex128 )"
233+
base.cdiv.assign,"base.cdiv.assign( re1:number, im1:number, re2:number, im2:number, out:ArrayLikeObject, strideOut:integer, offsetOut:integer )"
234+
base.cdiv.strided,"base.cdiv.strided( z1:ArrayLikeObject, sz1:integer, oz1:integer, z2:ArrayLikeObject, sz2:integer, oz2:integer, out:ArrayLikeObject, so:integer, oo:integer )"
233235
base.ceil,"base.ceil( x:number )"
234236
base.ceil2,"base.ceil2( x:number )"
235237
base.ceil10,"base.ceil10( x:number )"

lib/node_modules/@stdlib/repl/typed-signature/data/data.json

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

0 commit comments

Comments
 (0)