Skip to content

Commit cde3eaa

Browse files
stdlib-botstdlib-bot
authored
docs: update REPL namespace documentation
PR-URL: stdlib-js#10559 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 2cc758b commit cde3eaa

File tree

10 files changed

+48
-43
lines changed

10 files changed

+48
-43
lines changed

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1136,7 +1136,7 @@ base.modf,"var parts = base.modf( 3.14 )\nparts = base.modf( 3.14 )\nparts = bas
11361136
base.modf.assign,"var out = new Float64Array( 2 );\nvar parts = base.modf.assign( 3.14, out, 1, 0 )\nvar bool = ( parts === out )\n"
11371137
base.mul,"var v = base.mul( -1.0, 5.0 )\nv = base.mul( 2.0, 5.0 )\nv = base.mul( 0.0, 5.0 )\nv = base.mul( -0.0, 0.0 )\nv = base.mul( NaN, NaN )\n"
11381138
base.mulf,"var v = base.mulf( -1.0, 5.0 )\nv = base.mulf( 2.0, 5.0 )\nv = base.mulf( 0.0, 5.0 )\nv = base.mulf( -0.0, 0.0 )\nv = base.mulf( NaN, NaN )\n"
1139-
base.ndarray,"var b = [ 1, 2, 3, 4 ]; // underlying data buffer\nvar d = [ 2, 2 ]; // shape\nvar s = [ 2, 1 ]; // strides\nvar o = 0; // index offset\nvar arr = base.ndarray( 'generic', b, d, s, o, 'row-major' )\nvar v = arr.get( 1, 1 )\nv = arr.iget( 3 )\narr.set( 1, 1, 40 );\narr.get( 1, 1 )\narr.iset( 3, 99 );\narr.get( 1, 1 )\n"
1139+
base.ndarray,"var b = [ 1, 2, 3, 4 ];\nvar d = [ 2, 2 ];\nvar s = [ 2, 1 ];\nvar o = 0;\nvar arr = base.ndarray( 'generic', b, d, s, o, 'row-major' )\nvar v = arr.get( 1, 1 )\nv = arr.iget( 3 )\narr.set( 1, 1, 40 );\narr.get( 1, 1 )\narr.iset( 3, 99 );\narr.get( 1, 1 )\n"
11401140
base.ndarray.prototype.byteLength,"var b = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar d = [ 2, 2 ];\nvar s = [ 2, 1 ];\nvar o = 0;\nvar arr = base.ndarray( 'float64', b, d, s, o, 'row-major' );\nvar sz = arr.byteLength\n"
11411141
base.ndarray.prototype.BYTES_PER_ELEMENT,"var b = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar d = [ 2, 2 ];\nvar s = [ 2, 1 ];\nvar o = 0;\nvar arr = base.ndarray( 'float64', b, d, s, o, 'row-major' );\nvar sz = arr.BYTES_PER_ELEMENT\n"
11421142
base.ndarray.prototype.data,"var b = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar d = [ 2, 2 ];\nvar s = [ 2, 1 ];\nvar o = 0;\nvar arr = base.ndarray( 'float64', b, d, s, o, 'row-major' );\nvar buf = arr.data\n"
@@ -1152,6 +1152,7 @@ base.ndarray.prototype.get,"var b = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\
11521152
base.ndarray.prototype.iget,"var b = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar d = [ 2, 2 ];\nvar s = [ 2, 1 ];\nvar o = 0;\nvar arr = base.ndarray( 'float64', b, d, s, o, 'row-major' );\nvar v = arr.iget( 3 )\n"
11531153
base.ndarray.prototype.set,"var b = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar d = [ 2, 2 ];\nvar s = [ 2, 1 ];\nvar o = 0;\nvar arr = base.ndarray( 'float64', b, d, s, o, 'row-major' );\narr.set( 1, 1, -4.0 );\narr.get( 1, 1 )\n"
11541154
base.ndarray.prototype.iset,"var b = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );\nvar d = [ 2, 2 ];\nvar s = [ 2, 1 ];\nvar o = 0;\nvar arr = base.ndarray( 'float64', b, d, s, o, 'row-major' );\narr.iset( 3, -4.0 );\narr.iget( 3 )\n"
1155+
base.ndarray.prototype.toLocaleString,"var b = [ 1, 2, 3, 4 ];\nvar d = [ 2, 2 ];\nvar s = [ 2, 1 ];\nvar o = 0;\nvar arr = base.ndarray( 'generic', b, d, s, o, 'row-major' );\narr.toLocaleString()\n"
11551156
base.ndarray.prototype.toString,"var b = [ 1, 2, 3, 4 ];\nvar d = [ 2, 2 ];\nvar s = [ 2, 1 ];\nvar o = 0;\nvar arr = base.ndarray( 'generic', b, d, s, o, 'row-major' );\narr.toString()\n"
11561157
base.ndarray.prototype.toJSON,"var b = [ 1, 2, 3, 4 ];\nvar d = [ 2, 2 ];\nvar s = [ 2, 1 ];\nvar o = 0;\nvar arr = base.ndarray( 'generic', b, d, s, o, 'row-major' );\narr.toJSON()\n"
11571158
base.ndarrayUnary,"var xbuf = new Float64Array( [ -1.0, -2.0, -3.0, -4.0 ] );\nvar ybuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );\nvar dtype = 'float64';\nvar shape = [ 2, 2 ];\nvar sx = [ 2, 1 ];\nvar sy = [ 2, 1 ];\nvar ox = 0;\nvar oy = 0;\nvar order = 'row-major';\nvar x = ndarray( dtype, xbuf, shape, sx, ox, order );\nvar y = ndarray( dtype, ybuf, shape, sy, oy, order );\nbase.ndarrayUnary( [ x, y ], base.abs );\ny.data\nx = {\n 'dtype': dtype,\n 'data': xbuf,\n 'shape': shape,\n 'strides': sx,\n 'offset': ox,\n 'order': order\n };\ny = {\n 'dtype': dtype,\n 'data': ybuf,\n 'shape': shape,\n 'strides': sy,\n 'offset': oy,\n 'order': order\n };\nbase.ndarrayUnary( [ x, y ], base.abs );\ny.data\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: 38 additions & 37 deletions
Large diffs are not rendered by default.

‎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
@@ -1152,6 +1152,7 @@ base.ndarray.prototype.get,"\nbase.ndarray.prototype.get( ...idx:integer )\n
11521152
base.ndarray.prototype.iget,"\nbase.ndarray.prototype.iget( idx:integer )\n Returns an array element located at a specified linear index.\n"
11531153
base.ndarray.prototype.set,"\nbase.ndarray.prototype.set( ...idx:integer, v:any )\n Sets an array element specified according to provided subscripts.\n"
11541154
base.ndarray.prototype.iset,"\nbase.ndarray.prototype.iset( idx:integer, v:any )\n Sets an array element located at a specified linear index.\n"
1155+
base.ndarray.prototype.toLocaleString,"\nbase.ndarray.prototype.toLocaleString( [locales:string|Array[, \n options:Object]] )\n Serializes an ndarray as a locale-aware string.\n"
11551156
base.ndarray.prototype.toString,"\nbase.ndarray.prototype.toString()\n Serializes an ndarray as a string.\n"
11561157
base.ndarray.prototype.toJSON,"\nbase.ndarray.prototype.toJSON()\n Serializes an ndarray as a JSON object.\n"
11571158
base.ndarrayUnary,"\nbase.ndarrayUnary( arrays:ArrayLikeObject<ndarray>, fcn:Function )\n Applies a unary callback to elements in an input ndarray and assigns results\n to elements in an output 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
@@ -1152,6 +1152,7 @@ base.ndarray.prototype.get,"base.ndarray.prototype.get( ...idx )"
11521152
base.ndarray.prototype.iget,"base.ndarray.prototype.iget( idx )"
11531153
base.ndarray.prototype.set,"base.ndarray.prototype.set( ...idx, v )"
11541154
base.ndarray.prototype.iset,"base.ndarray.prototype.iset( idx, v )"
1155+
base.ndarray.prototype.toLocaleString,"base.ndarray.prototype.toLocaleString( [locales[, options]] )"
11551156
base.ndarray.prototype.toString,"base.ndarray.prototype.toString()"
11561157
base.ndarray.prototype.toJSON,"base.ndarray.prototype.toJSON()"
11571158
base.ndarrayUnary,"base.ndarrayUnary( arrays, fcn )"

‎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
@@ -1152,6 +1152,7 @@ base.ndarray.prototype.get,"base.ndarray.prototype.get( ...idx:integer )"
11521152
base.ndarray.prototype.iget,"base.ndarray.prototype.iget( idx:integer )"
11531153
base.ndarray.prototype.set,"base.ndarray.prototype.set( ...idx:integer, v:any )"
11541154
base.ndarray.prototype.iset,"base.ndarray.prototype.iset( idx:integer, v:any )"
1155+
base.ndarray.prototype.toLocaleString,"base.ndarray.prototype.toLocaleString( [locales:string|Array[, options:Object]] )"
11551156
base.ndarray.prototype.toString,"base.ndarray.prototype.toString()"
11561157
base.ndarray.prototype.toJSON,"base.ndarray.prototype.toJSON()"
11571158
base.ndarrayUnary,"base.ndarrayUnary( arrays:ArrayLikeObject<ndarray>, fcn:Function )"

‎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)