Skip to content

docs: update REPL namespace documentation #7563

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
Jul 5, 2025
Merged

docs: update REPL namespace documentation #7563

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
4 changes: 2 additions & 2 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 @@ -2208,8 +2208,8 @@ base.strided.quinary,"var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar y
base.strided.quinary.ndarray,"var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar z = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar w = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar u = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar v = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );\nvar shape = [ x.length ];\nvar strides = [ 1, 1, 1, 1, 1, 1 ];\nvar offsets = [ 0, 0, 0, 0, 0, 0 ];\nfunction f( x, y, z, w, u ) { return x + y + z + w + u; };\nbase.strided.quinary.ndarray( [ x, y, z, w, u, v ], shape, strides, offsets, f );\nv\n"
base.strided.range,"var x = [ 1.0, -2.0, 2.0 ];\nbase.strided.range( x.length, x, 1 )\nx = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ];\nbase.strided.range( 3, x, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nbase.strided.range( 3, x1, 2 )\n"
base.strided.range.ndarray,"var x = [ 1.0, -2.0, 2.0 ];\nbase.strided.range.ndarray( x.length, x, 1, 0 )\nvar x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ];\nbase.strided.range.ndarray( 3, x, 2, 1 )\n"
base.strided.rangeBy,"function accessor( v ) { return v * 2.0; };\nvar x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ];\nbase.strided.rangeBy( x.length, x, 1, accessor )\nx = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.rangeBy( N, x, 2, accessor )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nN = base.floor( x0.length / 2 );\nbase.strided.rangeBy( N, x1, 2, accessor )\n"
base.strided.rangeBy.ndarray,"function accessor( v ) { return v * 2.0; };\nvar x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ];\nbase.strided.rangeBy.ndarray( x.length, x, 1, 0, accessor )\nx = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.rangeBy.ndarray( N, x, 2, 1, accessor )\n"
base.strided.rangeBy,"function accessor( v ) { return v * 2.0; };\nvar x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ];\nbase.strided.rangeBy( x.length, x, 1, accessor )\nx = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ];\nbase.strided.rangeBy( 3, x, 2, accessor )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nbase.strided.rangeBy( 3, x1, 2, accessor )\n"
base.strided.rangeBy.ndarray,"function accessor( v ) { return v * 2.0; };\nvar x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ];\nbase.strided.rangeBy.ndarray( x.length, x, 1, 0, accessor )\nx = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ];\nbase.strided.rangeBy.ndarray( 3, x, 2, 1, accessor )\n"
base.strided.reinterpretComplex,"var x = new Complex128Array( 10 );\nvar out = base.strided.reinterpretComplex( x, 0 )\nvar bool = ( out.buffer === x.buffer )\nx = new Complex64Array( 10 );\nout = base.strided.reinterpretComplex( x, 0 )\nbool = ( out.buffer === x.buffer )\n"
base.strided.reinterpretComplex64,"var x = new Complex64Array( 10 );\nvar out = base.strided.reinterpretComplex64( x, 0 )\nvar bool = ( out.buffer === x.buffer )\n"
base.strided.reinterpretComplex128,"var x = new Complex128Array( 10 );\nvar out = base.strided.reinterpretComplex128( x, 0 )\nvar bool = ( out.buffer === x.buffer )\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.

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

Large diffs are not rendered by default.

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

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/repl/info/data/data.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2208,8 +2208,8 @@ base.strided.quinary,"\nbase.strided.quinary( arrays:ArrayLikeObject<ArrayLikeOb
base.strided.quinary.ndarray,"\nbase.strided.quinary.ndarray( arrays:ArrayLikeObject<ArrayLikeObject>, \n shape:ArrayLikeObject<integer>, strides:ArrayLikeObject<integer>, \n offsets:ArrayLikeObject<integer>, fcn:Function )\n Applies a quinary callback to strided input array elements and assigns\n results to elements in a strided output array using alternative indexing\n semantics.\n"
base.strided.range,"\nbase.strided.range( N:integer, x:Array|TypedArray, strideX:integer )\n Computes the range of a strided array.\n"
base.strided.range.ndarray,"\nbase.strided.range.ndarray( N:integer, x:Array|TypedArray, strideX:integer, \n offsetX:integer )\n Computes the range of a strided array using alternative indexing semantics.\n"
base.strided.rangeBy,"\nbase.strided.rangeBy( N:integer, x:Array|TypedArray|Object, stride:integer, \n clbk:Function[, thisArg:any] )\n Calculates the range of a strided array via a callback function.\n"
base.strided.rangeBy.ndarray,"\nbase.strided.rangeBy.ndarray( N:integer, x:Array|TypedArray|Object, \n stride:integer, offset:integer, clbk:Function[, thisArg:any] )\n Calculates the range of a strided array via a callback function and using\n alternative indexing semantics.\n"
base.strided.rangeBy,"\nbase.strided.rangeBy( N:integer, x:Array|TypedArray|Object, strideX:integer, \n clbk:Function[, thisArg:any] )\n Computes the range of a strided array via a callback function.\n"
base.strided.rangeBy.ndarray,"\nbase.strided.rangeBy.ndarray( N:integer, x:Array|TypedArray|Object, \n strideX:integer, offsetX:integer, clbk:Function[, thisArg:any] )\n Calculates the range of a strided array via a callback function and using\n alternative indexing semantics.\n"
base.strided.reinterpretComplex,"\nbase.strided.reinterpretComplex( x:Complex128Array|Complex64Array, \n offset:integer )\n Returns a real-valued floating-point array view of a complex-valued\n floating-point array having the same precision.\n"
base.strided.reinterpretComplex64,"\nbase.strided.reinterpretComplex64( x:Complex64Array, offset:integer )\n Returns a Float32Array view of a Complex64Array.\n"
base.strided.reinterpretComplex128,"\nbase.strided.reinterpretComplex128( x:Complex128Array, offset:integer )\n Returns a Float64Array view of a Complex128Array.\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/info/data/data.json
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/repl/signature/data/data.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2208,8 +2208,8 @@ base.strided.quinary,"base.strided.quinary( arrays, shape, strides, fcn )"
base.strided.quinary.ndarray,"base.strided.quinary.ndarray( arrays, shape, strides, offsets, fcn )"
base.strided.range,"base.strided.range( N, x, strideX )"
base.strided.range.ndarray,"base.strided.range.ndarray( N, x, strideX, offsetX )"
base.strided.rangeBy,"base.strided.rangeBy( N, x, stride, clbk[, thisArg] )"
base.strided.rangeBy.ndarray,"base.strided.rangeBy.ndarray( N, x, stride, offset, clbk[, thisArg] )"
base.strided.rangeBy,"base.strided.rangeBy( N, x, strideX, clbk[, thisArg] )"
base.strided.rangeBy.ndarray,"base.strided.rangeBy.ndarray( N, x, strideX, offsetX, clbk[, thisArg] )"
base.strided.reinterpretComplex,"base.strided.reinterpretComplex( x, offset )"
base.strided.reinterpretComplex64,"base.strided.reinterpretComplex64( x, offset )"
base.strided.reinterpretComplex128,"base.strided.reinterpretComplex128( x, offset )"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/signature/data/data.json
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/repl/typed-signature/data/data.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2208,8 +2208,8 @@ base.strided.quinary,"base.strided.quinary( arrays:ArrayLikeObject<ArrayLikeObje
base.strided.quinary.ndarray,"base.strided.quinary.ndarray( arrays:ArrayLikeObject<ArrayLikeObject>, shape:ArrayLikeObject<integer>, strides:ArrayLikeObject<integer>, offsets:ArrayLikeObject<integer>, fcn:Function )"
base.strided.range,"base.strided.range( N:integer, x:Array|TypedArray, strideX:integer )"
base.strided.range.ndarray,"base.strided.range.ndarray( N:integer, x:Array|TypedArray, strideX:integer, offsetX:integer )"
base.strided.rangeBy,"base.strided.rangeBy( N:integer, x:Array|TypedArray|Object, stride:integer, clbk:Function[, thisArg:any] )"
base.strided.rangeBy.ndarray,"base.strided.rangeBy.ndarray( N:integer, x:Array|TypedArray|Object, stride:integer, offset:integer, clbk:Function[, thisArg:any] )"
base.strided.rangeBy,"base.strided.rangeBy( N:integer, x:Array|TypedArray|Object, strideX:integer, clbk:Function[, thisArg:any] )"
base.strided.rangeBy.ndarray,"base.strided.rangeBy.ndarray( N:integer, x:Array|TypedArray|Object, strideX:integer, offsetX:integer, clbk:Function[, thisArg:any] )"
base.strided.reinterpretComplex,"base.strided.reinterpretComplex( x:Complex128Array|Complex64Array, offset:integer )"
base.strided.reinterpretComplex64,"base.strided.reinterpretComplex64( x:Complex64Array, offset:integer )"
base.strided.reinterpretComplex128,"base.strided.reinterpretComplex128( x:Complex128Array, offset:integer )"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/typed-signature/data/data.json
View file
Open in desktop

Large diffs are not rendered by default.