Skip to content

docs: update REPL namespace documentation #11357

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.

Sign up for GitHub

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
kgryte merged 1 commit into from
Apr 11, 2026
Merged

docs: update REPL namespace documentation #11357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 18 additions & 18 deletions lib/node_modules/@stdlib/repl/code-blocks/data/data.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ base.cbrt,"var y = base.cbrt( 64.0 )\ny = base.cbrt( 27.0 )\ny = base.cbrt( 0.0
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"
base.cceil,"var v = base.cceil( new Complex128( -1.5, 2.5 ) )\n"
base.cceilf,"var v = base.cceilf( new Complex64( -1.5, 2.5 ) )\n"
base.cceiln,"var out = base.cceiln( new Complex128( 5.555, -3.333 ), -2 )\nvar re = real( out )\nvar im = imag( out )\n"
base.cceiln,"var out = base.cceiln( new Complex128( 5.555, -3.333 ), -2 )\n"
base.ccis,"var y = base.ccis( new Complex128( 0.0, 0.0 ) )\ny = base.ccis( new Complex128( 1.0, 0.0 ) )\n"
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"
base.cdiv.assign,"var out = new Float64Array( 2 );\nbase.cdiv.assign( -13.0, -1.0, -2.0, 1.0, out, 1, 0 )\n"
Expand Down Expand Up @@ -2713,40 +2713,40 @@ COMPLEX128_NAN,"COMPLEX128_NAN\n"
COMPLEX128_NUM_BYTES,"COMPLEX128_NUM_BYTES\n"
COMPLEX128_ZERO,"COMPLEX128_ZERO\n"
Complex128Array,"var arr = new Complex128Array()\nvar arr = new Complex128Array( 10 )\nvar len = arr.length\nvar arr1 = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar arr2 = new Complex128Array( arr1 )\nvar len = arr2.length\nvar buf = new Float64Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar arr = new Complex128Array( buf )\nvar len = arr.length\nvar arr1 = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar len = arr1.length\nvar buf = [ new Complex128( 1.0, -1.0 ), new Complex128( 2.0, -2.0 ) ];\nvar arr2 = new Complex128Array( buf )\nlen = arr2.length\nvar buf = new ArrayBuffer( 480 );\nvar arr1 = new Complex128Array( buf )\nvar len = arr1.length\nvar arr2 = new Complex128Array( buf, 16 )\nlen = arr2.length\nvar arr3 = new Complex128Array( buf, 16, 20 )\nlen = arr3.length\n"
Complex128Array.from,"function clbkFcn( v ) { return v * 2.0 };\nvar arr = Complex128Array.from( [ 1.0, -1.0, 2.0, -2.0 ], clbkFcn )\nvar len = arr.length\nvar z = arr.get( 0 )\nvar re = real( z )\nvar im = imag( z )\n"
Complex128Array.of,"var arr = Complex128Array.of( 1.0, -1.0, 2.0, -2.0 )\nvar len = arr.length\nvar z1 = new Complex128( 1.0, -1.0 );\nvar z2 = new Complex128( 2.0, -2.0 );\narr = Complex128Array.of( z1, z2 )\nlen = arr.length\nvar z = arr.get( 0 )\nvar re = real( z )\nvar im = imag( z )\n"
Complex128Array.from,"function clbkFcn( v ) { return v * 2.0 };\nvar arr = Complex128Array.from( [ 1.0, -1.0, 2.0, -2.0 ], clbkFcn )\nvar len = arr.length\nvar z = arr.get( 0 )\n"
Complex128Array.of,"var arr = Complex128Array.of( 1.0, -1.0, 2.0, -2.0 )\nvar len = arr.length\nvar z1 = new Complex128( 1.0, -1.0 );\nvar z2 = new Complex128( 2.0, -2.0 );\narr = Complex128Array.of( z1, z2 )\nlen = arr.length\nvar z = arr.get( 0 )\n"
Complex128Array.BYTES_PER_ELEMENT,"var nbytes = Complex128Array.BYTES_PER_ELEMENT\n"
Complex128Array.name,"var str = Complex128Array.name\n"
Complex128Array.prototype.buffer,"var arr = new Complex128Array( 2 )\nvar buf = arr.buffer\n"
Complex128Array.prototype.byteLength,"var arr = new Complex128Array( 10 )\nvar nbytes = arr.byteLength\n"
Complex128Array.prototype.byteOffset,"var arr = new Complex128Array( 10 )\nvar offset = arr.byteOffset\nvar buf = new ArrayBuffer( 480 );\narr = new Complex128Array( buf, 128 )\noffset = arr.byteOffset\n"
Complex128Array.prototype.BYTES_PER_ELEMENT,"var arr = new Complex128Array( 10 )\narr.BYTES_PER_ELEMENT\n"
Complex128Array.prototype.length,"var arr = new Complex128Array( 10 )\nvar len = arr.length\n"
Complex128Array.prototype.at,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar z = arr.at( 1 )\nvar re = real( z )\nvar im = imag( z )\n"
Complex128Array.prototype.copyWithin,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0 ] )\narr.copyWithin( 0, 2 )\nvar z = arr.get( 0 )\nvar re = real( z )\nvar im = imag( z )\n"
Complex128Array.prototype.entries,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] )\nvar it = arr.entries();\nvar v = it.next().value\nvar re = real( v[ 1 ] )\nvar im = imag( v[ 1 ] )\nv = it.next().value\nre = real( v[ 1 ] )\nim = imag( v[ 1 ] )\nv = it.next().value\nre = real( v[ 1 ] )\nim = imag( v[ 1 ] )\nvar bool = it.next().done\n"
Complex128Array.prototype.at,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar z = arr.at( 1 )\n"
Complex128Array.prototype.copyWithin,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0 ] )\narr.copyWithin( 0, 2 )\nvar z = arr.get( 0 )\n"
Complex128Array.prototype.entries,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] )\nvar it = arr.entries();\nvar v = it.next().value\nv = it.next().value\nv = it.next().value\nvar bool = it.next().done\n"
Complex128Array.prototype.every,"function predicate( v ) { return ( real( v ) > 0.0 ); };\nvar arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar bool = arr.every( predicate )\n"
Complex128Array.prototype.fill,"var arr = new Complex128Array( 3 )\narr.fill( new Complex128( 1.0, 1.0 ) );\nvar z = arr.get( 0 )\nvar re = real( z )\nvar im = imag( z )\nz = arr.get( 1 )\nre = real( z )\nim = imag( z )\nz = arr.get( 2 )\nre = real( z )\nim = imag( z )\n"
Complex128Array.prototype.filter,"function predicate( v ) { return ( real( v ) === imag( v ) ); };\nvar arr = new Complex128Array( [ 1.0, -1.0, 2.0, 2.0, 3.0, -3.0 ] )\nvar out = arr.filter( predicate )\nvar len = out.length\nvar z = out.get( 0 )\nvar re = real( z )\nvar im = imag( z )\n"
Complex128Array.prototype.find,"function predicate( v ) { return ( real( v ) === imag( v ) ); };\nvar arr = new Complex128Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, -3.0 ] )\nvar z = arr.find( predicate )\nvar re = real( z )\nvar im = imag( z )\n"
Complex128Array.prototype.fill,"var arr = new Complex128Array( 3 )\narr.fill( new Complex128( 1.0, 1.0 ) );\nvar z = arr.get( 0 )\nz = arr.get( 1 )\nz = arr.get( 2 )\n"
Complex128Array.prototype.filter,"function predicate( v ) { return ( real( v ) === imag( v ) ); };\nvar arr = new Complex128Array( [ 1.0, -1.0, 2.0, 2.0, 3.0, -3.0 ] )\nvar out = arr.filter( predicate )\nvar len = out.length\nvar z = out.get( 0 )\n"
Complex128Array.prototype.find,"function predicate( v ) { return ( real( v ) === imag( v ) ); };\nvar arr = new Complex128Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, -3.0 ] )\nvar z = arr.find( predicate )\n"
Complex128Array.prototype.findIndex,"function predicate( v ) { return ( real( v ) === imag( v ) ); };\nvar arr = new Complex128Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, -3.0 ] )\nvar idx = arr.findIndex( predicate )\n"
Complex128Array.prototype.findLast,"function predicate( v ) { return ( real( v ) === imag( v ) ); };\nvar arr = new Complex128Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, -3.0 ] )\nvar z = arr.findLast( predicate )\nvar re = real( z )\nvar im = imag( z )\n"
Complex128Array.prototype.findLast,"function predicate( v ) { return ( real( v ) === imag( v ) ); };\nvar arr = new Complex128Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, -3.0 ] )\nvar z = arr.findLast( predicate )\n"
Complex128Array.prototype.findLastIndex,"function predicate( v ) { return ( real( v ) === imag( v ) ); };\nvar arr = new Complex128Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, -3.0 ] )\nvar idx = arr.findLastIndex( predicate )\n"
Complex128Array.prototype.forEach,"var str = '%';\nfunction clbk( v ) { str += v.toString() + '%'; };\nvar arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0 ] )\narr.forEach( clbk );\nstr\n"
Complex128Array.prototype.get,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar z = arr.get( 1 )\nvar re = real( z )\nvar im = imag( z )\n"
Complex128Array.prototype.get,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar z = arr.get( 1 )\n"
Complex128Array.prototype.includes,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0 ] )\nvar bool = arr.includes( new Complex128( 3.0, -3.0 ) )\nbool = arr.includes( new Complex128( 3.0, -3.0 ), 3 )\n"
Complex128Array.prototype.indexOf,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0 ] )\nvar idx = arr.indexOf( new Complex128( 3.0, -3.0 ) )\nidx = arr.indexOf( new Complex128( 3.0, -3.0 ), 3 )\n"
Complex128Array.prototype.join,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar str = arr.join()\nstr = arr.join( '/' )\n"
Complex128Array.prototype.keys,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar it = arr.keys();\nvar v = it.next().value\nv = it.next().value\nv = it.next().done\n"
Complex128Array.prototype.lastIndexOf,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 1.0, -1.0 ] )\nvar idx = arr.lastIndexOf( new Complex128( 1.0, -1.0 ) )\nidx = arr.lastIndexOf( new Complex128( 1.0, -1.0 ), 2 )\n"
Complex128Array.prototype.map,"function clbk( v ) { return v; };\nvar arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar out = arr.map( clbk )\nvar z = out.get( 0 )\nvar re = real( z )\nvar im = imag( z )\nz = out.get( 1 )\nre = real( z )\nim = imag( z )\n"
Complex128Array.prototype.reduce,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar z = arr.reduce( base.cadd )\nvar re = real( z )\nvar im = imag( z )\n"
Complex128Array.prototype.reduceRight,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar z = arr.reduceRight( base.cadd )\nvar re = real( z )\nvar im = imag( z )\n"
Complex128Array.prototype.reverse,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] )\narr.reverse();\nvar z = arr.get( 0 )\nvar re = real( z )\nvar im = imag( z )\nz = arr.get( 1 )\nre = real( z )\nim = imag( z )\nz = arr.get( 2 )\nre = real( z )\nim = imag( z )\n"
Complex128Array.prototype.set,"var arr = new Complex128Array( 2 )\narr.set( new Complex128( 1.0, -1.0 ) );\nvar z = arr.get( 0 )\nvar re = real( z )\nvar im = imag( z )\narr.set( new Complex128( 2.0, -2.0 ), 1 );\nz = arr.get( 1 )\nre = real( z )\nim = imag( z )\n"
Complex128Array.prototype.slice,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] )\nvar out = arr.slice( 1 )\nvar len = out.length\nvar z = out.get( 0 )\nvar re = real( z )\nvar im = imag( z )\nz = out.get( 1 )\nre = real( z )\nim = imag( z )\n"
Complex128Array.prototype.map,"function clbk( v ) { return v; };\nvar arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar out = arr.map( clbk )\nvar z = out.get( 0 )\nz = out.get( 1 )\n"
Complex128Array.prototype.reduce,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar z = arr.reduce( base.cadd )\n"
Complex128Array.prototype.reduceRight,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0 ] )\nvar z = arr.reduceRight( base.cadd )\n"
Complex128Array.prototype.reverse,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] )\narr.reverse();\nvar z = arr.get( 0 )\nz = arr.get( 1 )\nz = arr.get( 2 )\n"
Complex128Array.prototype.set,"var arr = new Complex128Array( 2 )\narr.set( new Complex128( 1.0, -1.0 ) );\nvar z = arr.get( 0 )\narr.set( new Complex128( 2.0, -2.0 ), 1 );\nz = arr.get( 1 )\n"
Complex128Array.prototype.slice,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] )\nvar out = arr.slice( 1 )\nvar len = out.length\nvar z = out.get( 0 )\nz = out.get( 1 )\n"
Complex128Array.prototype.some,"function predicate( v ) { return ( real( v ) === imag( v ) ); };\nvar arr = new Complex128Array( [ 1.0, -1.0, 2.0, 2.0, 3.0, -3.0 ] )\nvar bool = arr.some( predicate )\n"
Complex128Array.prototype.sort,"function compare( a, b ) { return ( real( a ) - real( b ) ); };\nvar arr = new Complex128Array( [ 2.0, -2.0, 3.0, -3.0, 1.0, -1.0 ] )\narr.sort( compare );\nvar z = arr.get( 0 )\nvar re = real( z )\nvar im = imag( z )\nz = arr.get( 1 )\nre = real( z )\nim = imag( z )\nz = arr.get( 2 )\nre = real( z )\nim = imag( z )\n"
Complex128Array.prototype.sort,"function compare( a, b ) { return ( real( a ) - real( b ) ); };\nvar arr = new Complex128Array( [ 2.0, -2.0, 3.0, -3.0, 1.0, -1.0 ] )\narr.sort( compare );\nvar z = arr.get( 0 )\nz = arr.get( 1 )\nz = arr.get( 2 )\n"
Complex128Array.prototype.subarray,"var arr = new Complex128Array( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0 ] )\nvar out = arr.subarray( 1, 3 )\nvar len = out.length\nvar z = out.get( 0 )\nvar re = real( z )\nvar im = imag( z )\nz = out.get( 1 )\nre = real( z )\nim = imag( z )\n"
Complex128Array.prototype.toLocaleString,"var arr = new Complex128Array( [ 1.0, 1.0, 2.0, 2.0 ] )\nvar str = arr.toLocaleString()\n"
Complex128Array.prototype.toReversed,"var arr = new Complex128Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] )\nvar out = arr.toReversed()\nvar z = out.get( 0 )\nvar re = real( z )\nvar im = imag( z )\nz = out.get( 1 )\nre = real( z )\nim = imag( z )\nz = out.get( 2 )\nre = real( z )\nim = imag( z )\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/code-blocks/data/data.json
View file
Open in desktop

Large diffs are not rendered by default.

Loading