Skip to content

docs: update REPL namespace documentation #5061

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
merged 1 commit into from
Feb 5, 2025
+25 −25
Merged

docs: update REPL namespace documentation #5061

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
8 changes: 4 additions & 4 deletions lib/node_modules/@stdlib/repl/code-blocks/data/data.csv
View file
Original file line number Diff line number Diff line change
@@ -1946,10 +1946,10 @@ base.strided.dsort2ins,"var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nv
base.strided.dsort2ins.ndarray,"var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nvar y = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] );\nbase.strided.dsort2ins.ndarray( x.length, 1, x, 1, 0, y, 1, 0 )\ny\nx = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\ny = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] );\nbase.strided.dsort2ins.ndarray( 2, 1, x, 2, 1, y, 2, 1 )\ny\n"
base.strided.dsort2sh,"var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nvar y = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] );\nbase.strided.dsort2sh( x.length, 1, x, 1, y, 1 )\ny\nx = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\ny = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] );\nvar N = base.floor( x.length / 2 );\nbase.strided.dsort2sh( N, -1, x, 2, y, 2 )\ny\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nvar y0 = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] );\nvar y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 );\nN = base.floor( x0.length / 2 );\nbase.strided.dsort2sh( N, 1, x1, 2, y1, 2 )\nx0\ny0\n"
base.strided.dsort2sh.ndarray,"var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nvar y = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] );\nbase.strided.dsort2sh.ndarray( x.length, 1, x, 1, 0, y, 1, 0 )\ny\nx = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\ny = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] );\nvar N = base.floor( x.length / 2 );\nbase.strided.dsort2sh.ndarray( N, 1, x, 2, 1, y, 2, 1 )\ny\n"
base.strided.dsorthp,"var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nbase.strided.dsorthp( x.length, 1, x, 1 )\nx = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nvar N = base.floor( x.length / 2 );\nbase.strided.dsorthp( N, -1, x, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nN = base.floor( x0.length / 2 );\nbase.strided.dsorthp( N, 1, x1, 2 )\nx0\n"
base.strided.dsorthp.ndarray,"var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nbase.strided.dsorthp.ndarray( x.length, 1, x, 1, 0 )\nx = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nvar N = base.floor( x.length / 2 );\nbase.strided.dsorthp.ndarray( N, 1, x, 2, 1 )\n"
base.strided.dsortins,"var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nbase.strided.dsortins( x.length, 1, x, 1 )\nx = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nvar N = base.floor( x.length / 2 );\nbase.strided.dsortins( N, -1, x, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nN = base.floor( x0.length / 2 );\nbase.strided.dsortins( N, 1, x1, 2 )\nx0\n"
base.strided.dsortins.ndarray,"var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nbase.strided.dsortins.ndarray( x.length, 1, x, 1, 0 )\nx = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nvar N = base.floor( x.length / 2 );\nbase.strided.dsortins.ndarray( N, 1, x, 2, 1 )\n"
base.strided.dsorthp,"var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nbase.strided.dsorthp( x.length, 1, x, 1 )\nx = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nbase.strided.dsorthp( 2, -1, x, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nbase.strided.dsorthp( 2, 1, x1, 2 )\nx0\n"
base.strided.dsorthp.ndarray,"var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nbase.strided.dsorthp.ndarray( x.length, 1, x, 1, 0 )\nx = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nbase.strided.dsorthp.ndarray( 2, 1, x, 2, 1 )\n"
base.strided.dsortins,"var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nbase.strided.dsortins( x.length, 1, x, 1 )\nx = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nbase.strided.dsortins( 2, -1, x, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nbase.strided.dsortins( 2, 1, x1, 2 )\nx0\n"
base.strided.dsortins.ndarray,"var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nbase.strided.dsortins.ndarray( x.length, 1, x, 1, 0 )\nx = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nbase.strided.dsortins.ndarray( 2, 1, x, 2, 1 )\n"
base.strided.dsortsh,"var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nbase.strided.dsortsh( x.length, 1, x, 1 )\nx = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nvar N = base.floor( x.length / 2 );\nbase.strided.dsortsh( N, -1, x, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nN = base.floor( x0.length / 2 );\nbase.strided.dsortsh( N, 1, x1, 2 )\nx0\n"
base.strided.dsortsh.ndarray,"var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nbase.strided.dsortsh.ndarray( x.length, 1, x, 1, 0 )\nx = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );\nvar N = base.floor( x.length / 2 );\nbase.strided.dsortsh.ndarray( N, 1, x, 2, 1 )\n"
base.strided.dsqrt,"var x = new Float64Array( [ 0.0, 4.0, 9.0, 12.0 ] );\nvar y = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );\nbase.strided.dsqrt( x.length, x, 1, y, 1 )\nvar N = base.floor( x.length / 2 );\ny = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );\nbase.strided.dsqrt( N, x, 2, y, -1 )\nvar x0 = new Float64Array( [ 0.0, 4.0, 9.0, 12.0 ] );\nvar y0 = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nvar y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*2 );\nN = base.floor( x0.length / 2 );\nbase.strided.dsqrt( N, x1, -2, y1, 1 )\ny0\n"
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/code-blocks/data/data.json
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions lib/node_modules/@stdlib/repl/help/data/data.csv
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.json
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions lib/node_modules/@stdlib/repl/info/data/data.csv
View file
Original file line number Diff line number Diff line change
@@ -1946,10 +1946,10 @@ base.strided.dsort2ins,"\nbase.strided.dsort2ins( N:integer, order:number, x:Flo
base.strided.dsort2ins.ndarray,"\nbase.strided.dsort2ins.ndarray( N:integer, order:number, x:Float64Array, \n strideX:integer, offsetX:integer, y:Float64Array, strideY:integer, \n offsetY:integer )\n Simultaneously sorts two double-precision floating-point strided arrays\n based on the sort order of the first array using insertion sort and\n alternative indexing semantics.\n"
base.strided.dsort2sh,"\nbase.strided.dsort2sh( N:integer, order:number, x:Float64Array, \n strideX:integer, y:Float64Array, strideY:integer )\n Simultaneously sorts two double-precision floating-point strided arrays\n based on the sort order of the first array using Shellsort.\n"
base.strided.dsort2sh.ndarray,"\nbase.strided.dsort2sh.ndarray( N:integer, order:number, x:Float64Array, \n strideX:integer, offsetX:integer, y:Float64Array, strideY:integer, \n offsetY:integer )\n Simultaneously sorts two double-precision floating-point strided arrays\n based on the sort order of the first array using Shellsort and alternative\n indexing semantics.\n"
base.strided.dsorthp,"\nbase.strided.dsorthp( N:integer, order:number, x:Float64Array, stride:integer )\n Sorts a double-precision floating-point strided array using heapsort.\n"
base.strided.dsorthp.ndarray,"\nbase.strided.dsorthp.ndarray( N:integer, order:number, x:Float64Array, \n stride:integer, offset:integer )\n Sorts a double-precision floating-point strided array using heapsort and\n alternative indexing semantics.\n"
base.strided.dsortins,"\nbase.strided.dsortins( N:integer, order:number, x:Float64Array, stride:integer )\n Sorts a double-precision floating-point strided array using insertion sort.\n"
base.strided.dsortins.ndarray,"\nbase.strided.dsortins.ndarray( N:integer, order:number, x:Float64Array, \n stride:integer, offset:integer )\n Sorts a double-precision floating-point strided array using insertion sort\n and alternative indexing semantics.\n"
base.strided.dsorthp,"\nbase.strided.dsorthp( N:integer, order:number, x:Float64Array, strideX:integer )\n Sorts a double-precision floating-point strided array using heapsort.\n"
base.strided.dsorthp.ndarray,"\nbase.strided.dsorthp.ndarray( N:integer, order:number, x:Float64Array, \n strideX:integer, offsetX:integer )\n Sorts a double-precision floating-point strided array using heapsort and\n alternative indexing semantics.\n"
base.strided.dsortins,"\nbase.strided.dsortins( N:integer, order:number, x:Float64Array, \n strideX:integer )\n Sorts a double-precision floating-point strided array using insertion sort.\n"
base.strided.dsortins.ndarray,"\nbase.strided.dsortins.ndarray( N:integer, order:number, x:Float64Array, \n strideX:integer, offsetX:integer )\n Sorts a double-precision floating-point strided array using insertion sort\n and alternative indexing semantics.\n"
base.strided.dsortsh,"\nbase.strided.dsortsh( N:integer, order:number, x:Float64Array, stride:integer )\n Sorts a double-precision floating-point strided array using Shellsort.\n"
base.strided.dsortsh.ndarray,"\nbase.strided.dsortsh.ndarray( N:integer, order:number, x:Float64Array, \n stride:integer, offset:integer )\n Sorts a double-precision floating-point strided array using Shellsort and\n alternative indexing semantics.\n"
base.strided.dsqrt,"\nbase.strided.dsqrt( N:integer, x:Float64Array, strideX:integer, y:Float64Array, \n strideY:integer )\n Computes the principal square root for each element in a double-precision\n floating-point strided array `x` and assigns the results to elements in a\n double-precision floating-point strided array `y`.\n"
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/info/data/data.json
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions lib/node_modules/@stdlib/repl/signature/data/data.csv
View file
Original file line number Diff line number Diff line change
@@ -1947,10 +1947,10 @@ base.strided.dsort2ins,"base.strided.dsort2ins( N, order, x, strideX, y, strideY
base.strided.dsort2ins.ndarray,"base.strided.dsort2ins.ndarray( N, order, x, strideX, offsetX, y, strideY, offsetY )"
base.strided.dsort2sh,"base.strided.dsort2sh( N, order, x, strideX, y, strideY )"
base.strided.dsort2sh.ndarray,"base.strided.dsort2sh.ndarray( N, order, x, strideX, offsetX, y, strideY, offsetY )"
base.strided.dsorthp,"base.strided.dsorthp( N, order, x, stride )"
base.strided.dsorthp.ndarray,"base.strided.dsorthp.ndarray( N, order, x, stride, offset )"
base.strided.dsortins,"base.strided.dsortins( N, order, x, stride )"
base.strided.dsortins.ndarray,"base.strided.dsortins.ndarray( N, order, x, stride, offset )"
base.strided.dsorthp,"base.strided.dsorthp( N, order, x, strideX )"
base.strided.dsorthp.ndarray,"base.strided.dsorthp.ndarray( N, order, x, strideX, offsetX )"
base.strided.dsortins,"base.strided.dsortins( N, order, x, strideX )"
base.strided.dsortins.ndarray,"base.strided.dsortins.ndarray( N, order, x, strideX, offsetX )"
base.strided.dsortsh,"base.strided.dsortsh( N, order, x, stride )"
base.strided.dsortsh.ndarray,"base.strided.dsortsh.ndarray( N, order, x, stride, offset )"
base.strided.dsqrt,"base.strided.dsqrt( N, x, strideX, y, strideY )"
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/signature/data/data.json
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions lib/node_modules/@stdlib/repl/typed-signature/data/data.csv
View file
Original file line number Diff line number Diff line change
@@ -1947,10 +1947,10 @@ base.strided.dsort2ins,"base.strided.dsort2ins( N:integer, order:number, x:Float
base.strided.dsort2ins.ndarray,"base.strided.dsort2ins.ndarray( N:integer, order:number, x:Float64Array, strideX:integer, offsetX:integer, y:Float64Array, strideY:integer, offsetY:integer )"
base.strided.dsort2sh,"base.strided.dsort2sh( N:integer, order:number, x:Float64Array, strideX:integer, y:Float64Array, strideY:integer )"
base.strided.dsort2sh.ndarray,"base.strided.dsort2sh.ndarray( N:integer, order:number, x:Float64Array, strideX:integer, offsetX:integer, y:Float64Array, strideY:integer, offsetY:integer )"
base.strided.dsorthp,"base.strided.dsorthp( N:integer, order:number, x:Float64Array, stride:integer )"
base.strided.dsorthp.ndarray,"base.strided.dsorthp.ndarray( N:integer, order:number, x:Float64Array, stride:integer, offset:integer )"
base.strided.dsortins,"base.strided.dsortins( N:integer, order:number, x:Float64Array, stride:integer )"
base.strided.dsortins.ndarray,"base.strided.dsortins.ndarray( N:integer, order:number, x:Float64Array, stride:integer, offset:integer )"
base.strided.dsorthp,"base.strided.dsorthp( N:integer, order:number, x:Float64Array, strideX:integer )"
base.strided.dsorthp.ndarray,"base.strided.dsorthp.ndarray( N:integer, order:number, x:Float64Array, strideX:integer, offsetX:integer )"
base.strided.dsortins,"base.strided.dsortins( N:integer, order:number, x:Float64Array, strideX:integer )"
base.strided.dsortins.ndarray,"base.strided.dsortins.ndarray( N:integer, order:number, x:Float64Array, strideX:integer, offsetX:integer )"
base.strided.dsortsh,"base.strided.dsortsh( N:integer, order:number, x:Float64Array, stride:integer )"
base.strided.dsortsh.ndarray,"base.strided.dsortsh.ndarray( N:integer, order:number, x:Float64Array, stride:integer, offset:integer )"
base.strided.dsqrt,"base.strided.dsqrt( N:integer, x:Float64Array, strideX:integer, y:Float64Array, strideY:integer )"
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/typed-signature/data/data.json
View file

Large diffs are not rendered by default.