Skip to content

Commit 54fb9de

Browse files
docs: update REPL namespace documentation
PR-URL: #3978 Reviewed-by: Athan Reines <[email protected]> Signed-off-by: stdlib-bot <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]>
1 parent c5a9ae2 commit 54fb9de

File tree

10 files changed

+10
-6
lines changed

10 files changed

+10
-6
lines changed

lib/node_modules/@stdlib/repl/code-blocks/data/data.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4099,6 +4099,7 @@ ndarray.prototype.iset,"var b = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar
40994099
ndarray.prototype.toString,"var b = [ 1, 2, 3, 4 ];\nvar d = [ 2, 2 ];\nvar s = [ 2, 1 ];\nvar o = 0;\nvar arr = ndarray( 'generic', b, d, s, o, 'row-major' );\narr.toString()\n"
41004100
ndarray.prototype.toJSON,"var b = [ 1, 2, 3, 4 ];\nvar d = [ 2, 2 ];\nvar s = [ 2, 1 ];\nvar o = 0;\nvar arr = ndarray( 'generic', b, d, s, o, 'row-major' );\narr.toJSON()\n"
41014101
ndarray2array,"var arr = array( [ [ 1, 2 ], [ 3, 4 ] ] );\nvar out = ndarray2array( arr )\n"
4102+
ndarray2json,"var arr = array( [ [ 1, 2 ], [ 3, 4 ] ] );\nvar out = ndarray2json( arr )\n"
41024103
ndarrayCastingModes,"var out = ndarrayCastingModes()\n"
41034104
ndarrayDataBuffer,"var opts = { 'dtype': 'float64' };\nvar out = ndarrayDataBuffer( ndzeros( [ 3, 3, 3 ], opts ) )\n"
41044105
ndarrayDataType,"var opts = { 'dtype': 'float64' };\nvar dt = ndarrayDataType( ndzeros( [ 3, 3, 3 ], opts ) )\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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4099,7 +4099,7 @@ ndarray.prototype.set,"\nndarray.prototype.set( ...idx, v )\n Sets an array e
40994099
ndarray.prototype.iset,"\nndarray.prototype.iset( idx, v )\n Sets an array element located at a specified linear index.\n\n For zero-dimensional arrays, the first, and only, argument should be the\n value to set.\n\n Parameters\n ----------\n idx: integer\n Linear index.\n\n v: any\n Value to set.\n\n Returns\n -------\n out: ndarray\n ndarray instance.\n\n Examples\n --------\n > var b = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\n > var d = [ 2, 2 ];\n > var s = [ 2, 1 ];\n > var o = 0;\n > var arr = ndarray( 'float64', b, d, s, o, 'row-major' );\n > arr.iset( 3, -4.0 );\n > arr.iget( 3 )\n -4.0"
41004100
ndarray.prototype.toString,"\nndarray.prototype.toString()\n Serializes an ndarray as a string.\n\n This method does **not** serialize data outside of the buffer region defined\n by the array configuration.\n\n Returns\n -------\n str: string\n Serialized ndarray string.\n\n Examples\n --------\n > var b = [ 1, 2, 3, 4 ];\n > var d = [ 2, 2 ];\n > var s = [ 2, 1 ];\n > var o = 0;\n > var arr = ndarray( 'generic', b, d, s, o, 'row-major' );\n > arr.toString()\n '...'"
41014101
ndarray.prototype.toJSON,"\nndarray.prototype.toJSON()\n Serializes an ndarray as a JSON object.\n\n This method does **not** serialize data outside of the buffer region defined\n by the array configuration.\n\n Returns\n -------\n obj: Object\n JSON object.\n\n Examples\n --------\n > var b = [ 1, 2, 3, 4 ];\n > var d = [ 2, 2 ];\n > var s = [ 2, 1 ];\n > var o = 0;\n > var arr = ndarray( 'generic', b, d, s, o, 'row-major' );\n > arr.toJSON()\n {...}\n\n See Also\n --------\n array, FancyArray"
4102-
ndarray2array,"\nndarray2array( x )\n Converts an ndarray to a generic array.\n\n Parameters\n ----------\n x: ndarray\n Input array.\n\n Returns\n -------\n out: Array|Array<Array>\n Generic array (which may include nested arrays).\n\n Examples\n --------\n > var arr = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n > var out = ndarray2array( arr )\n [ [ 1, 2 ], [ 3, 4 ] ]\n\n See Also\n --------\n array, ndarray\n"
4102+
ndarray2array,"\nndarray2array( x )\n Converts an ndarray to a generic array.\n\n Parameters\n ----------\n x: ndarray\n Input array.\n\n Returns\n -------\n out: Array|Array<Array>\n Generic array (which may include nested arrays).\n\n Examples\n --------\n > var arr = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n > var out = ndarray2array( arr )\n [ [ 1, 2 ], [ 3, 4 ] ]\n\n See Also\n --------\n array, ndarray, ndarray2json\n"
41034103
ndarray2json,"\nndarray2json( x )\n Serializes an ndarray as a JSON object.\n\n This function does *not* serialize data outside of the buffer region defined\n by the ndarray view.\n\n Parameters\n ----------\n x: ndarray\n Input ndarray.\n\n Returns\n -------\n out: Object\n JSON object.\n\n Examples\n --------\n > var arr = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n > var out = ndarray2json( arr )\n {...}\n\n See Also\n --------\n array, ndarray, ndarray2array\n"
41044104
ndarrayCastingModes,"\nndarrayCastingModes()\n Returns a list of ndarray casting modes.\n\n The output array contains the following modes:\n\n - 'none': only allow casting between identical types.\n - 'equiv': allow casting between identical and byte swapped types.\n - 'safe': only allow \"safe\" casts.\n - 'mostly-safe': allow \"safe\" casts and, for floating-point data types,\n downcasts.\n - 'same-kind': allow \"safe\" casts and casts within the same kind (e.g.,\n between signed integers or between floats).\n - 'unsafe': allow casting between all types (including between integers and\n floats).\n\n Returns\n -------\n out: Array<string>\n List of ndarray casting modes.\n\n Examples\n --------\n > var out = ndarrayCastingModes()\n [ 'none', 'equiv', 'safe', 'mostly-safe', 'same-kind', 'unsafe' ]\n\n See Also\n --------\n array, ndarray\n"
41054105
ndarrayDataBuffer,"\nndarrayDataBuffer( x )\n Returns the underlying data buffer of a provided ndarray.\n\n Parameters\n ----------\n x: ndarray\n Input ndarray.\n\n Returns\n -------\n out: ArrayLikeObject\n Underlying data buffer.\n\n Examples\n --------\n > var opts = { 'dtype': 'float64' };\n > var out = ndarrayDataBuffer( ndzeros( [ 3, 3, 3 ], opts ) )\n <Float64Array>\n\n See Also\n --------\n array, ndarray, ndarrayDataType\n"

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: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4100,6 +4100,7 @@ ndarray.prototype.iset,"\nndarray.prototype.iset( idx:integer, v:any )\n Sets
41004100
ndarray.prototype.toString,"\nndarray.prototype.toString()\n Serializes an ndarray as a string.\n"
41014101
ndarray.prototype.toJSON,"\nndarray.prototype.toJSON()\n Serializes an ndarray as a JSON object.\n"
41024102
ndarray2array,"\nndarray2array( x:ndarray )\n Converts an ndarray to a generic array.\n"
4103+
ndarray2json,"\nndarray2json( x:ndarray )\n Serializes an ndarray as a JSON object.\n"
41034104
ndarrayCastingModes,"\nndarrayCastingModes()\n Returns a list of ndarray casting modes.\n"
41044105
ndarrayDataBuffer,"\nndarrayDataBuffer( x:ndarray )\n Returns the underlying data buffer of a provided ndarray.\n"
41054106
ndarrayDataType,"\nndarrayDataType( x:ndarray )\n Returns the data type of a provided ndarray.\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: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4152,6 +4152,7 @@ ndarray.prototype.iset,"ndarray.prototype.iset( idx, v )"
41524152
ndarray.prototype.toString,"ndarray.prototype.toString()"
41534153
ndarray.prototype.toJSON,"ndarray.prototype.toJSON()"
41544154
ndarray2array,"ndarray2array( x )"
4155+
ndarray2json,"ndarray2json( x )"
41554156
ndarrayCastingModes,"ndarrayCastingModes()"
41564157
ndarrayDataBuffer,"ndarrayDataBuffer( x )"
41574158
ndarrayDataType,"ndarrayDataType( x )"

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: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4152,6 +4152,7 @@ ndarray.prototype.iset,"ndarray.prototype.iset( idx:integer, v:any )"
41524152
ndarray.prototype.toString,"ndarray.prototype.toString()"
41534153
ndarray.prototype.toJSON,"ndarray.prototype.toJSON()"
41544154
ndarray2array,"ndarray2array( x:ndarray )"
4155+
ndarray2json,"ndarray2json( x:ndarray )"
41554156
ndarrayCastingModes,"ndarrayCastingModes()"
41564157
ndarrayDataBuffer,"ndarrayDataBuffer( x:ndarray )"
41574158
ndarrayDataType,"ndarrayDataType( x:ndarray )"

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)