Skip to content

Commit 1af75ce

Browse files
authored
docs: update REPL namespace documentation
PR-URL: #9269 Reviewed-by: Athan Reines <[email protected]>
1 parent c1bdfd1 commit 1af75ce

File tree

10 files changed

+17
-7
lines changed

10 files changed

+17
-7
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
@@ -2655,6 +2655,7 @@ commonKeys,"var obj1 = { 'a': 1, 'b': 2 };\nvar obj2 = { 'a': 1, 'b': 2, 'c': 3,
26552655
commonKeysIn,"var obj1 = { 'a': 1, 'b': 2 };\nvar obj2 = { 'a': 1, 'b': 2, 'c': 3, 'd': 4 };\nvar keys = commonKeysIn( obj1, obj2 )\n"
26562656
complex,"var z = complex( 5.0, 3.0, 'float64' )\nz = complex( 5.0, 3.0, 'float32' )\n"
26572657
Complex64,"var z = new Complex64( 5.0, 3.0 )\nz.re\nz.im\n"
2658+
Complex64.name,"var str = Complex64.name\n"
26582659
Complex64.BYTES_PER_ELEMENT,"var s = Complex64.BYTES_PER_ELEMENT\n"
26592660
Complex64.prototype.BYTES_PER_ELEMENT,"var z = new Complex64( 5.0, 3.0 )\nvar s = z.BYTES_PER_ELEMENT\n"
26602661
Complex64.prototype.byteLength,"var z = new Complex64( 5.0, 3.0 )\nvar s = z.byteLength\n"
@@ -2703,6 +2704,7 @@ Complex64Array.prototype.toSorted,"function compare( a, b ) { return ( realf( a
27032704
Complex64Array.prototype.toString,"var arr = new Complex64Array( [ 1.0, 1.0, 2.0, -2.0, 3.0, 3.0 ] )\nvar str = arr.toString()\n"
27042705
Complex64Array.prototype.values,"var arr = new Complex64Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar it = arr.values();\nvar v = it.next().value\nvar re = realf( v )\nvar im = imagf( v )\nv = it.next().value\nre = realf( v )\nim = imagf( v )\nvar bool = it.next().done\n"
27052706
Complex64Array.prototype.with,"var arr = new Complex64Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar out = arr.with( 1, new Complex64( 3.0, -3.0 ) )\nvar z = out.get( 1 )\nvar re = realf( z )\nvar im = imagf( z )\n"
2707+
Complex128.name,"var str = Complex128.name\n"
27062708
Complex128.BYTES_PER_ELEMENT,"var s = Complex128.BYTES_PER_ELEMENT\n"
27072709
Complex128.prototype.BYTES_PER_ELEMENT,"var z = new Complex128( 5.0, 3.0 )\nvar s = z.BYTES_PER_ELEMENT\n"
27082710
Complex128.prototype.byteLength,"var z = new Complex128( 5.0, 3.0 )\nvar s = z.byteLength\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: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2654,7 +2654,8 @@ codePointAt,"\ncodePointAt( str, idx[, backward] )\n Returns a Unicode code p
26542654
commonKeys,"\ncommonKeys( obj1, obj2[, ...obj] )\n Returns the common own property names of two or more objects.\n\n Parameters\n ----------\n obj1: any\n First object.\n\n obj2: any\n Second object.\n\n obj: ...any (optional)\n Additional objects.\n\n Returns\n -------\n out: Array<string>\n Common keys of objects.\n\n Examples\n --------\n > var obj1 = { 'a': 1, 'b': 2 };\n > var obj2 = { 'a': 1, 'b': 2, 'c': 3, 'd': 4 };\n > var keys = commonKeys( obj1, obj2 )\n [ 'a', 'b' ]\n\n See Also\n --------\n commonKeysIn, objectKeys"
26552655
commonKeysIn,"\ncommonKeysIn( obj1, obj2[, ...obj] )\n Returns the common own and inherited property names of two or more objects.\n\n Parameters\n ----------\n obj1: any\n First object.\n\n obj2: any\n Second object.\n\n obj: ...any (optional)\n Additional objects.\n\n Returns\n -------\n out: Array<string>\n Common keys.\n\n Examples\n --------\n > var obj1 = { 'a': 1, 'b': 2 };\n > var obj2 = { 'a': 1, 'b': 2, 'c': 3, 'd': 4 };\n > var keys = commonKeysIn( obj1, obj2 )\n [ 'a', 'b' ]\n\n See Also\n --------\n commonKeys, keysIn"
26562656
complex,"\ncomplex( real, imag[, dtype] )\n Creates a complex number.\n\n The function supports the following data types:\n\n - float64\n - float32\n\n Parameters\n ----------\n real: number\n Real component.\n\n imag: number\n Imaginary component.\n\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n z: Complex\n Complex number.\n\n Examples\n --------\n > var z = complex( 5.0, 3.0, 'float64' )\n <Complex128>\n > z = complex( 5.0, 3.0, 'float32' )\n <Complex64>\n\n See Also\n --------\n Complex128, Complex64\n"
2657-
Complex64,"\nComplex64( real, imag )\n 64-bit complex number constructor.\n\n Both the real and imaginary components are stored as single-precision\n floating-point numbers.\n\n Parameters\n ----------\n real: number\n Real component.\n\n imag: number\n Imaginary component.\n\n Returns\n -------\n z: Complex64\n 64-bit complex number.\n\n z.re: number\n Read-only property returning the real component.\n\n z.im: number\n Read-only property returning the imaginary component.\n\n Examples\n --------\n > var z = new Complex64( 5.0, 3.0 )\n <Complex64>\n > z.re\n 5.0\n > z.im\n 3.0\n\n\nComplex64.BYTES_PER_ELEMENT\n Size (in bytes) of each component.\n\n Returns\n -------\n v: integer\n Size (in bytes) of each component.\n\n Examples\n --------\n > var s = Complex64.BYTES_PER_ELEMENT\n 4\n\n\nComplex64.prototype.BYTES_PER_ELEMENT\n Size (in bytes) of each component.\n\n Returns\n -------\n s: integer\n Size (in bytes) of each component.\n\n Examples\n --------\n > var z = new Complex64( 5.0, 3.0 )\n <Complex64>\n > var s = z.BYTES_PER_ELEMENT\n 4\n\n\nComplex64.prototype.byteLength\n Length (in bytes) of a complex number.\n\n Returns\n -------\n len: integer\n Length (in bytes) of a complex number.\n\n Examples\n --------\n > var z = new Complex64( 5.0, 3.0 )\n <Complex64>\n > var s = z.byteLength\n 8\n\n See Also\n --------\n complex, Complex128\n"
2657+
Complex64,"\nComplex64( real, imag )\n 64-bit complex number constructor.\n\n Both the real and imaginary components are stored as single-precision\n floating-point numbers.\n\n Parameters\n ----------\n real: number\n Real component.\n\n imag: number\n Imaginary component.\n\n Returns\n -------\n z: Complex64\n 64-bit complex number.\n\n z.re: number\n Read-only property returning the real component.\n\n z.im: number\n Read-only property returning the imaginary component.\n\n Examples\n --------\n > var z = new Complex64( 5.0, 3.0 )\n <Complex64>\n > z.re\n 5.0\n > z.im\n 3.0\n\n\nComplex64.name\n Constructor name.\n\n Examples\n --------\n > var str = Complex64.name\n 'Complex64'\n\n\nComplex64.BYTES_PER_ELEMENT\n Size (in bytes) of each component.\n\n Returns\n -------\n v: integer\n Size (in bytes) of each component.\n\n Examples\n --------\n > var s = Complex64.BYTES_PER_ELEMENT\n 4\n\n\nComplex64.prototype.BYTES_PER_ELEMENT\n Size (in bytes) of each component.\n\n Returns\n -------\n s: integer\n Size (in bytes) of each component.\n\n Examples\n --------\n > var z = new Complex64( 5.0, 3.0 )\n <Complex64>\n > var s = z.BYTES_PER_ELEMENT\n 4\n\n\nComplex64.prototype.byteLength\n Length (in bytes) of a complex number.\n\n Returns\n -------\n len: integer\n Length (in bytes) of a complex number.\n\n Examples\n --------\n > var z = new Complex64( 5.0, 3.0 )\n <Complex64>\n > var s = z.byteLength\n 8\n\n See Also\n --------\n complex, Complex128\n"
2658+
Complex64.name,"\nComplex64.name\n Constructor name.\n\n Examples\n --------\n > var str = Complex64.name\n 'Complex64'"
26582659
Complex64.BYTES_PER_ELEMENT,"\nComplex64.BYTES_PER_ELEMENT\n Size (in bytes) of each component.\n\n Returns\n -------\n v: integer\n Size (in bytes) of each component.\n\n Examples\n --------\n > var s = Complex64.BYTES_PER_ELEMENT\n 4"
26592660
Complex64.prototype.BYTES_PER_ELEMENT,"\nComplex64.prototype.BYTES_PER_ELEMENT\n Size (in bytes) of each component.\n\n Returns\n -------\n s: integer\n Size (in bytes) of each component.\n\n Examples\n --------\n > var z = new Complex64( 5.0, 3.0 )\n <Complex64>\n > var s = z.BYTES_PER_ELEMENT\n 4"
26602661
Complex64.prototype.byteLength,"\nComplex64.prototype.byteLength\n Length (in bytes) of a complex number.\n\n Returns\n -------\n len: integer\n Length (in bytes) of a complex number.\n\n Examples\n --------\n > var z = new Complex64( 5.0, 3.0 )\n <Complex64>\n > var s = z.byteLength\n 8\n\n See Also\n --------\n complex, Complex128"
@@ -2703,7 +2704,8 @@ Complex64Array.prototype.toSorted,"\nComplex64Array.prototype.toSorted( compareF
27032704
Complex64Array.prototype.toString,"\nComplex64Array.prototype.toString()\n Serializes an array as a string.\n\n Returns\n -------\n str: string\n String serialization of the array.\n \n Examples\n --------\n > var arr = new Complex64Array( [ 1.0, 1.0, 2.0, -2.0, 3.0, 3.0 ] )\n <Complex64Array>\n > var str = arr.toString()\n '1 + 1i,2 - 2i,3 + 3i'"
27042705
Complex64Array.prototype.values,"\nComplex64Array.prototype.values()\n Returns an iterator for iterating over each value in a typed array.\n\n Returns\n -------\n iterator: Iterator\n Iterator for iterating over array values.\n \n Examples\n --------\n > var arr = new Complex64Array( [ 1.0, -1.0, 2.0, -2.0 ] )\n <Complex64Array>\n > var it = arr.values();\n > var v = it.next().value\n <Complex64>\n > var re = realf( v )\n 1.0\n > var im = imagf( v )\n -1.0\n > v = it.next().value\n <Complex64>\n > re = realf( v )\n 2.0\n > im = imagf( v )\n -2.0\n > var bool = it.next().done\n true"
27052706
Complex64Array.prototype.with,"\nComplex64Array.prototype.with( index, value )\n Returns a new typed array with the element at a provided index replaced\n with a provided value.\n\n Parameters\n ----------\n index: integer\n Element index.\n \n value: Complex64\n Element value. \n\n Returns\n -------\n out: Complex64Array\n New typed array.\n \n Examples\n --------\n > var arr = new Complex64Array( [ 1.0, -1.0, 2.0, -2.0 ] )\n <Complex64Array>\n > var out = arr.with( 1, new Complex64( 3.0, -3.0 ) )\n <Complex64Array>\n > var z = out.get( 1 )\n <Complex64>\n > var re = realf( z )\n 3.0\n > var im = imagf( z )\n -3.0\n\n\n See Also\n --------\n Complex128Array, complex, Complex64"
2706-
Complex128,"\nComplex128( real, imag )\n 128-bit complex number constructor.\n\n Both the real and imaginary components are stored as double-precision\n floating-point numbers.\n\n Parameters\n ----------\n real: number\n Real component.\n\n imag: number\n Imaginary component.\n\n Returns\n -------\n z: Complex128\n 128-bit complex number.\n\n z.re: number\n Read-only property returning the real component.\n\n z.im: number\n Read-only property returning the imaginary component.\n\n\nComplex128.BYTES_PER_ELEMENT\n Size (in bytes) of each component.\n\n Returns\n -------\n v: integer\n Size (in bytes) of each component.\n\n Examples\n --------\n > var s = Complex128.BYTES_PER_ELEMENT\n 8\n\n\nComplex128.prototype.BYTES_PER_ELEMENT\n Size (in bytes) of each component.\n\n Returns\n -------\n s: integer\n Size (in bytes) of each component.\n\n Examples\n --------\n > var z = new Complex128( 5.0, 3.0 )\n <Complex128>\n > var s = z.BYTES_PER_ELEMENT\n 8\n\n\nComplex128.prototype.byteLength\n Length (in bytes) of a complex number.\n\n Returns\n -------\n len: integer\n Length (in bytes) of a complex number.\n\n Examples\n --------\n > var z = new Complex128( 5.0, 3.0 )\n <Complex128>\n > var s = z.byteLength\n 16\n\n See Also\n --------\n complex, Complex64\n"
2707+
Complex128,"\nComplex128( real, imag )\n 128-bit complex number constructor.\n\n Both the real and imaginary components are stored as double-precision\n floating-point numbers.\n\n Parameters\n ----------\n real: number\n Real component.\n\n imag: number\n Imaginary component.\n\n Returns\n -------\n z: Complex128\n 128-bit complex number.\n\n z.re: number\n Read-only property returning the real component.\n\n z.im: number\n Read-only property returning the imaginary component.\n\n\nComplex128.name\n Constructor name.\n\n Examples\n --------\n > var str = Complex128.name\n 'Complex128'\n\n\nComplex128.BYTES_PER_ELEMENT\n Size (in bytes) of each component.\n\n Returns\n -------\n v: integer\n Size (in bytes) of each component.\n\n Examples\n --------\n > var s = Complex128.BYTES_PER_ELEMENT\n 8\n\n\nComplex128.prototype.BYTES_PER_ELEMENT\n Size (in bytes) of each component.\n\n Returns\n -------\n s: integer\n Size (in bytes) of each component.\n\n Examples\n --------\n > var z = new Complex128( 5.0, 3.0 )\n <Complex128>\n > var s = z.BYTES_PER_ELEMENT\n 8\n\n\nComplex128.prototype.byteLength\n Length (in bytes) of a complex number.\n\n Returns\n -------\n len: integer\n Length (in bytes) of a complex number.\n\n Examples\n --------\n > var z = new Complex128( 5.0, 3.0 )\n <Complex128>\n > var s = z.byteLength\n 16\n\n See Also\n --------\n complex, Complex64\n"
2708+
Complex128.name,"\nComplex128.name\n Constructor name.\n\n Examples\n --------\n > var str = Complex128.name\n 'Complex128'"
27072709
Complex128.BYTES_PER_ELEMENT,"\nComplex128.BYTES_PER_ELEMENT\n Size (in bytes) of each component.\n\n Returns\n -------\n v: integer\n Size (in bytes) of each component.\n\n Examples\n --------\n > var s = Complex128.BYTES_PER_ELEMENT\n 8"
27082710
Complex128.prototype.BYTES_PER_ELEMENT,"\nComplex128.prototype.BYTES_PER_ELEMENT\n Size (in bytes) of each component.\n\n Returns\n -------\n s: integer\n Size (in bytes) of each component.\n\n Examples\n --------\n > var z = new Complex128( 5.0, 3.0 )\n <Complex128>\n > var s = z.BYTES_PER_ELEMENT\n 8"
27092711
Complex128.prototype.byteLength,"\nComplex128.prototype.byteLength\n Length (in bytes) of a complex number.\n\n Returns\n -------\n len: integer\n Length (in bytes) of a complex number.\n\n Examples\n --------\n > var z = new Complex128( 5.0, 3.0 )\n <Complex128>\n > var s = z.byteLength\n 16\n\n See Also\n --------\n complex, Complex64"

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
@@ -2655,6 +2655,7 @@ commonKeys,"\ncommonKeys( obj1:any, obj2:any[, ...obj:any] )\n Returns the co
26552655
commonKeysIn,"\ncommonKeysIn( obj1:any, obj2:any[, ...obj:any] )\n Returns the common own and inherited property names of two or more objects.\n"
26562656
complex,"\ncomplex( real:number, imag:number[, dtype:string] )\n Creates a complex number.\n"
26572657
Complex64,"\nComplex64( real:number, imag:number )\n 64-bit complex number constructor.\n"
2658+
Complex64.name,"\nComplex64.name\n Constructor name.\n"
26582659
Complex64.BYTES_PER_ELEMENT,"\nComplex64.BYTES_PER_ELEMENT\n Size (in bytes) of each component.\n"
26592660
Complex64.prototype.BYTES_PER_ELEMENT,"\nComplex64.prototype.BYTES_PER_ELEMENT\n Size (in bytes) of each component.\n"
26602661
Complex64.prototype.byteLength,"\nComplex64.prototype.byteLength\n Length (in bytes) of a complex number.\n"
@@ -2704,6 +2705,7 @@ Complex64Array.prototype.toString,"\nComplex64Array.prototype.toString()\n Se
27042705
Complex64Array.prototype.values,"\nComplex64Array.prototype.values()\n Returns an iterator for iterating over each value in a typed array.\n"
27052706
Complex64Array.prototype.with,"\nComplex64Array.prototype.with( index, value )\n Returns a new typed array with the element at a provided index replaced\n with a provided value.\n"
27062707
Complex128,"\nComplex128( real:number, imag:number )\n 128-bit complex number constructor.\n"
2708+
Complex128.name,"\nComplex128.name\n Constructor name.\n"
27072709
Complex128.BYTES_PER_ELEMENT,"\nComplex128.BYTES_PER_ELEMENT\n Size (in bytes) of each component.\n"
27082710
Complex128.prototype.BYTES_PER_ELEMENT,"\nComplex128.prototype.BYTES_PER_ELEMENT\n Size (in bytes) of each component.\n"
27092711
Complex128.prototype.byteLength,"\nComplex128.prototype.byteLength\n Length (in bytes) of a complex number.\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
@@ -2664,6 +2664,7 @@ commonKeys,"commonKeys( obj1, obj2[, ...obj] )"
26642664
commonKeysIn,"commonKeysIn( obj1, obj2[, ...obj] )"
26652665
complex,"complex( real, imag[, dtype] )"
26662666
Complex64,"Complex64( real, imag )"
2667+
Complex64.name,"Complex64.name"
26672668
Complex64.BYTES_PER_ELEMENT,"Complex64.BYTES_PER_ELEMENT"
26682669
Complex64.prototype.BYTES_PER_ELEMENT,"Complex64.prototype.BYTES_PER_ELEMENT"
26692670
Complex64.prototype.byteLength,"Complex64.prototype.byteLength"
@@ -2718,6 +2719,7 @@ Complex64Array.prototype.toString,"Complex64Array.prototype.toString()"
27182719
Complex64Array.prototype.values,"Complex64Array.prototype.values()"
27192720
Complex64Array.prototype.with,"Complex64Array.prototype.with( index, value )"
27202721
Complex128,"Complex128( real, imag )"
2722+
Complex128.name,"Complex128.name"
27212723
Complex128.BYTES_PER_ELEMENT,"Complex128.BYTES_PER_ELEMENT"
27222724
Complex128.prototype.BYTES_PER_ELEMENT,"Complex128.prototype.BYTES_PER_ELEMENT"
27232725
Complex128.prototype.byteLength,"Complex128.prototype.byteLength"

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
@@ -2664,6 +2664,7 @@ commonKeys,"commonKeys( obj1:any, obj2:any[, ...obj:any] )"
26642664
commonKeysIn,"commonKeysIn( obj1:any, obj2:any[, ...obj:any] )"
26652665
complex,"complex( real:number, imag:number[, dtype:string] )"
26662666
Complex64,"Complex64( real:number, imag:number )"
2667+
Complex64.name,"Complex64.name"
26672668
Complex64.BYTES_PER_ELEMENT,"Complex64.BYTES_PER_ELEMENT"
26682669
Complex64.prototype.BYTES_PER_ELEMENT,"Complex64.prototype.BYTES_PER_ELEMENT"
26692670
Complex64.prototype.byteLength,"Complex64.prototype.byteLength"
@@ -2718,6 +2719,7 @@ Complex64Array.prototype.toString,"Complex64Array.prototype.toString()"
27182719
Complex64Array.prototype.values,"Complex64Array.prototype.values()"
27192720
Complex64Array.prototype.with,"Complex64Array.prototype.with( index, value )"
27202721
Complex128,"Complex128( real:number, imag:number )"
2722+
Complex128.name,"Complex128.name"
27212723
Complex128.BYTES_PER_ELEMENT,"Complex128.BYTES_PER_ELEMENT"
27222724
Complex128.prototype.BYTES_PER_ELEMENT,"Complex128.prototype.BYTES_PER_ELEMENT"
27232725
Complex128.prototype.byteLength,"Complex128.prototype.byteLength"

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)