Skip to content

docs: update REPL namespace documentation #8123

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
Sep 22, 2025
Merged

docs: update REPL namespace documentation #8123

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
16 changes: 16 additions & 0 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 @@ -4163,6 +4163,22 @@ ndarrayCastingModes,"var out = ndarrayCastingModes()\n"
ndarrayDataBuffer,"var opts = { 'dtype': 'float64' };\nvar out = ndarrayDataBuffer( ndzeros( [ 3, 3, 3 ], opts ) )\n"
ndarrayDataType,"var opts = { 'dtype': 'float64' };\nvar dt = ndarrayDataType( ndzeros( [ 3, 3, 3 ], opts ) )\n"
ndarrayDataTypes,"var out = ndarrayDataTypes()\nout = ndarrayDataTypes( 'floating_point' )\nout = ndarrayDataTypes( 'floating_point_and_generic' )\n"
ndarrayDataTypes.binary,"var dt = ndarrayDataTypes.binary\n"
ndarrayDataTypes.boolean,"var dt = ndarrayDataTypes.boolean\n"
ndarrayDataTypes.complex32,"var dt = ndarrayDataTypes.complex32\n"
ndarrayDataTypes.complex64,"var dt = ndarrayDataTypes.complex64\n"
ndarrayDataTypes.complex128,"var dt = ndarrayDataTypes.complex128\n"
ndarrayDataTypes.float16,"var dt = ndarrayDataTypes.float16\n"
ndarrayDataTypes.float32,"var dt = ndarrayDataTypes.float32\n"
ndarrayDataTypes.float64,"var dt = ndarrayDataTypes.float64\n"
ndarrayDataTypes.generic,"var dt = ndarrayDataTypes.generic\n"
ndarrayDataTypes.int8,"var dt = ndarrayDataTypes.int8\n"
ndarrayDataTypes.int16,"var dt = ndarrayDataTypes.int16\n"
ndarrayDataTypes.int32,"var dt = ndarrayDataTypes.int32\n"
ndarrayDataTypes.uint8,"var dt = ndarrayDataTypes.uint8\n"
ndarrayDataTypes.uint8c,"var dt = ndarrayDataTypes.uint8c\n"
ndarrayDataTypes.uint16,"var dt = ndarrayDataTypes.uint16\n"
ndarrayDataTypes.uint32,"var dt = ndarrayDataTypes.uint32\n"
ndarrayDispatch,"var t = [ 'float64', 'float64', 'float32', 'float32' ];\nvar d = [ base.abs, base.absf ];\nvar f = ndarrayDispatch( base.ndarrayUnary, t, d, 2, 1, 1 );\nvar xbuf = new Float64Array( [ -1.0, -2.0, -3.0, -4.0 ] );\nvar x = ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );\nvar ybuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );\nvar y = ndarray( 'float64', ybuf, [ 4 ], [ 1 ], 0, 'row-major' );\nf( x, y );\nybuf\n"
ndarrayFlag,"var out = ndarrayFlag( ndzeros( [ 3, 3, 3 ] ), 'READONLY' )\n"
ndarrayFlags,"var out = ndarrayFlags( ndzeros( [ 3, 3, 3 ] ) )\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.

22 changes: 19 additions & 3 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.

16 changes: 16 additions & 0 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 @@ -4164,6 +4164,22 @@ ndarrayCastingModes,"\nndarrayCastingModes()\n Returns a list of ndarray cast
ndarrayDataBuffer,"\nndarrayDataBuffer( x:ndarray )\n Returns the underlying data buffer of a provided ndarray.\n"
ndarrayDataType,"\nndarrayDataType( x:ndarray )\n Returns the data type of a provided ndarray.\n"
ndarrayDataTypes,"\nndarrayDataTypes( [kind:string] )\n Returns a list of ndarray data types.\n"
ndarrayDataTypes.binary,"\nndarrayDataTypes.binary\n Read-only property returning a data type instance representing a binary data\n type.\n"
ndarrayDataTypes.boolean,"\nndarrayDataTypes.boolean\n Read-only property returning a data type instance representing a boolean\n data type.\n"
ndarrayDataTypes.complex32,"\nndarrayDataTypes.complex32\n Read-only property returning a data type instance representing a half-\n precision complex floating-point number data type.\n"
ndarrayDataTypes.complex64,"\nndarrayDataTypes.complex64\n Read-only property returning a data type instance representing a single-\n precision complex floating-point number data type.\n"
ndarrayDataTypes.complex128,"\nndarrayDataTypes.complex128\n Read-only property returning a data type instance representing a double-\n precision complex floating-point number data type.\n"
ndarrayDataTypes.float16,"\nndarrayDataTypes.float16\n Read-only property returning a data type instance representing a half-\n precision real-valued floating-point number data type.\n"
ndarrayDataTypes.float32,"\nndarrayDataTypes.float32\n Read-only property returning a data type instance representing a single-\n precision real-valued floating-point number data type.\n"
ndarrayDataTypes.float64,"\nndarrayDataTypes.float64\n Read-only property returning a data type instance representing a double-\n precision real-valued floating-point number data type.\n"
ndarrayDataTypes.generic,"\nndarrayDataTypes.generic\n Read-only property returning a data type instance representing a \"generic\"\n data type.\n"
ndarrayDataTypes.int8,"\nndarrayDataTypes.int8\n Read-only property returning a data type instance representing a signed\n 8-bit integer data type.\n"
ndarrayDataTypes.int16,"\nndarrayDataTypes.int16\n Read-only property returning a data type instance representing a signed\n 16-bit integer data type.\n"
ndarrayDataTypes.int32,"\nndarrayDataTypes.int32\n Read-only property returning a data type instance representing a signed\n 32-bit integer data type.\n"
ndarrayDataTypes.uint8,"\nndarrayDataTypes.uint8\n Read-only property returning a data type instance representing an unsigned\n 8-bit integer data type.\n"
ndarrayDataTypes.uint8c,"\nndarrayDataTypes.uint8c\n Read-only property returning a data type instance representing an unsigned\n clamped 8-bit integer data type.\n"
ndarrayDataTypes.uint16,"\nndarrayDataTypes.uint16\n Read-only property returning a data type instance representing an unsigned\n 16-bit integer data type.\n"
ndarrayDataTypes.uint32,"\nndarrayDataTypes.uint32\n Read-only property returning a data type instance representing an unsigned\n 32-bit integer data type.\n"
ndarrayDispatch,"\nndarrayDispatch( fcns:Function|ArrayLikeObject<Function>, \n types:ArrayLikeObject, data:ArrayLikeObject|null, nargs:integer, nin:integer, \n nout:integer )\n Returns an ndarray function interface which performs multiple dispatch.\n"
ndarrayFlag,"\nndarrayFlag( x:ndarray, name:string|symbol )\n Returns a specified flag for a provided ndarray.\n"
ndarrayFlags,"\nndarrayFlags( x:ndarray )\n Returns the flags of a provided ndarray.\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.

16 changes: 16 additions & 0 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 @@ -4215,6 +4215,22 @@ ndarrayCastingModes,"ndarrayCastingModes()"
ndarrayDataBuffer,"ndarrayDataBuffer( x )"
ndarrayDataType,"ndarrayDataType( x )"
ndarrayDataTypes,"ndarrayDataTypes( [kind] )"
ndarrayDataTypes.binary,"ndarrayDataTypes.binary"
ndarrayDataTypes.boolean,"ndarrayDataTypes.boolean"
ndarrayDataTypes.complex32,"ndarrayDataTypes.complex32"
ndarrayDataTypes.complex64,"ndarrayDataTypes.complex64"
ndarrayDataTypes.complex128,"ndarrayDataTypes.complex128"
ndarrayDataTypes.float16,"ndarrayDataTypes.float16"
ndarrayDataTypes.float32,"ndarrayDataTypes.float32"
ndarrayDataTypes.float64,"ndarrayDataTypes.float64"
ndarrayDataTypes.generic,"ndarrayDataTypes.generic"
ndarrayDataTypes.int8,"ndarrayDataTypes.int8"
ndarrayDataTypes.int16,"ndarrayDataTypes.int16"
ndarrayDataTypes.int32,"ndarrayDataTypes.int32"
ndarrayDataTypes.uint8,"ndarrayDataTypes.uint8"
ndarrayDataTypes.uint8c,"ndarrayDataTypes.uint8c"
ndarrayDataTypes.uint16,"ndarrayDataTypes.uint16"
ndarrayDataTypes.uint32,"ndarrayDataTypes.uint32"
ndarrayDispatch,"ndarrayDispatch( fcns, types, data, nargs, nin, nout )"
ndarrayFlag,"ndarrayFlag( x, name )"
ndarrayFlags,"ndarrayFlags( x )"
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.

16 changes: 16 additions & 0 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 @@ -4215,6 +4215,22 @@ ndarrayCastingModes,"ndarrayCastingModes()"
ndarrayDataBuffer,"ndarrayDataBuffer( x:ndarray )"
ndarrayDataType,"ndarrayDataType( x:ndarray )"
ndarrayDataTypes,"ndarrayDataTypes( [kind:string] )"
ndarrayDataTypes.binary,"ndarrayDataTypes.binary"
ndarrayDataTypes.boolean,"ndarrayDataTypes.boolean"
ndarrayDataTypes.complex32,"ndarrayDataTypes.complex32"
ndarrayDataTypes.complex64,"ndarrayDataTypes.complex64"
ndarrayDataTypes.complex128,"ndarrayDataTypes.complex128"
ndarrayDataTypes.float16,"ndarrayDataTypes.float16"
ndarrayDataTypes.float32,"ndarrayDataTypes.float32"
ndarrayDataTypes.float64,"ndarrayDataTypes.float64"
ndarrayDataTypes.generic,"ndarrayDataTypes.generic"
ndarrayDataTypes.int8,"ndarrayDataTypes.int8"
ndarrayDataTypes.int16,"ndarrayDataTypes.int16"
ndarrayDataTypes.int32,"ndarrayDataTypes.int32"
ndarrayDataTypes.uint8,"ndarrayDataTypes.uint8"
ndarrayDataTypes.uint8c,"ndarrayDataTypes.uint8c"
ndarrayDataTypes.uint16,"ndarrayDataTypes.uint16"
ndarrayDataTypes.uint32,"ndarrayDataTypes.uint32"
ndarrayDispatch,"ndarrayDispatch( fcns:Function|ArrayLikeObject<Function>, types:ArrayLikeObject, data:ArrayLikeObject|null, nargs:integer, nin:integer, nout:integer )"
ndarrayFlag,"ndarrayFlag( x:ndarray, name:string|symbol )"
ndarrayFlags,"ndarrayFlags( x:ndarray )"
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.