docs: update REPL namespace

PR-URL: #1101 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]>
stdlib-js · Sep 21, 2023 · acea23e · acea23e · stdlib-bot · Sep 21, 2023
1 parent e18b248
commit acea23e
Show file tree

Hide file tree

Showing 10 changed files with 92 additions and 20 deletions.
diff --git a/lib/node_modules/@stdlib/repl/code-blocks/data/data.csv b/lib/node_modules/@stdlib/repl/code-blocks/data/data.csv
@@ -2485,6 +2485,24 @@ exists.sync,"var bool = exists.sync( './beep/boop' )\n"
 expandAcronyms,"var str = 'LOL, this is fun. I am ROFL.';\nvar out = expandAcronyms( str )\nstr = 'brb, I need to check my mail. thx!';\nout = expandAcronyms( str )\n"
 expandContractions,"var str = 'I won\'t be able to get y\'all out of this one.';\nvar out = expandContractions( str )\nstr = 'It oughtn\'t to be my fault, because, you know, I didn\'t know';\nout = expandContractions( str )\n"
 extname,"var ext = extname( 'index.js' )\n"
+FancyArray,"var b = [ 1.0, 2.0, 3.0, 4.0 ]; // underlying data buffer\nvar d = [ 2, 2 ]; // shape\nvar s = [ 2, 1 ]; // strides\nvar o = 0; // index offset\nvar arr = FancyArray( 'generic', b, d, s, o, 'row-major' )\nvar v = arr.get( 1, 1 )\nv = arr.iget( 3 )\narr.set( 1, 1, 40.0 );\narr.get( 1, 1 )\narr.iset( 3, 99.0 );\narr.get( 1, 1 )\n"
+FancyArray.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 = FancyArray( 'float64', b, d, s, o, 'row-major' );\nvar sz = arr.byteLength\n"
+FancyArray.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 = FancyArray( 'float64', b, d, s, o, 'row-major' );\nvar sz = arr.BYTES_PER_ELEMENT\n"
+FancyArray.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 = FancyArray( 'float64', b, d, s, o, 'row-major' );\nvar buf = arr.data\n"
+FancyArray.prototype.dtype,"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 = FancyArray( 'float64', b, d, s, o, 'row-major' );\nvar dt = arr.dtype\n"
+FancyArray.prototype.flags,"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 = FancyArray( 'float64', b, d, s, o, 'row-major' );\nvar fl = arr.flags\n"
+FancyArray.prototype.length,"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 = FancyArray( 'float64', b, d, s, o, 'row-major' );\nvar len = arr.length\n"
+FancyArray.prototype.ndims,"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 = FancyArray( 'float64', b, d, s, o, 'row-major' );\nvar n = arr.ndims\n"
+FancyArray.prototype.offset,"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 = FancyArray( 'float64', b, d, s, o, 'row-major' );\nvar v = arr.offset\n"
+FancyArray.prototype.order,"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 = FancyArray( 'float64', b, d, s, o, 'row-major' );\nvar ord = arr.order\n"
+FancyArray.prototype.shape,"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 = FancyArray( 'float64', b, d, s, o, 'row-major' );\nvar sh = arr.shape\n"
+FancyArray.prototype.strides,"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 = FancyArray( 'float64', b, d, s, o, 'row-major' );\nvar st = arr.strides\n"
+FancyArray.prototype.get,"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 = FancyArray( 'float64', b, d, s, o, 'row-major' );\nvar v = arr.get( 1, 1 )\n"
+FancyArray.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 = FancyArray( 'float64', b, d, s, o, 'row-major' );\nvar v = arr.iget( 3 )\n"
+FancyArray.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 = FancyArray( 'float64', b, d, s, o, 'row-major' );\narr.set( 1, 1, -4.0 );\narr.get( 1, 1 )\n"
+FancyArray.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 = FancyArray( 'float64', b, d, s, o, 'row-major' );\narr.iset( 3, -4.0 );\narr.iget( 3 )\n"
+FancyArray.prototype.toString,"var b = [ 1, 2, 3, 4 ];\nvar d = [ 2, 2 ];\nvar s = [ 2, 1 ];\nvar o = 0;\nvar arr = FancyArray( 'generic', b, d, s, o, 'row-major' );\narr.toString()\n"
+FancyArray.prototype.toJSON,"var b = [ 1, 2, 3, 4 ];\nvar d = [ 2, 2 ];\nvar s = [ 2, 1 ];\nvar o = 0;\nvar arr = FancyArray( 'generic', b, d, s, o, 'row-major' );\narr.toJSON()\n"
 fastmath.abs,"var v = fastmath.abs( -1.0 )\nv = fastmath.abs( 2.0 )\nv = fastmath.abs( 0.0 )\nv = fastmath.abs( -0.0 )\nv = fastmath.abs( NaN )\n"
 fastmath.acosh,"var v = fastmath.acosh( 1.0 )\nv = fastmath.acosh( 2.0 )\nv = fastmath.acosh( NaN )\nv = fastmath.acosh( 1.0e308 )\n"
 fastmath.ampbm,"var h = fastmath.ampbm( 5.0, 12.0 )\n"

diff --git a/lib/node_modules/@stdlib/repl/code-blocks/data/data.json b/lib/node_modules/@stdlib/repl/code-blocks/data/data.json
diff --git a/lib/node_modules/@stdlib/repl/help/data/data.csv b/lib/node_modules/@stdlib/repl/help/data/data.csv
diff --git a/lib/node_modules/@stdlib/repl/help/data/data.json b/lib/node_modules/@stdlib/repl/help/data/data.json
diff --git a/lib/node_modules/@stdlib/repl/info/data/data.csv b/lib/node_modules/@stdlib/repl/info/data/data.csv
@@ -2485,6 +2485,24 @@ exists.sync,"\nexists.sync( path:string|Buffer )\n    Synchronously tests whethe
 expandAcronyms,"\nexpandAcronyms( str:string )\n    Expands acronyms in a string.\n"
 expandContractions,"\nexpandContractions( str:string )\n    Expands all contractions to their formal equivalents.\n"
 extname,"\nextname( filename:string )\n    Returns a filename extension.\n"
+FancyArray,"\nFancyArray( dtype:string, buffer:ArrayLikeObject|TypedArray|Buffer, \n  shape:ArrayLikeObject<integer>, strides:ArrayLikeObject<integer>, \n  offset:integer, order:string[, options:Object] )\n    Returns a FancyArray instance.\n"
+FancyArray.prototype.byteLength,"\nFancyArray.prototype.byteLength\n    Size (in bytes) of the array (if known).\n"
+FancyArray.prototype.BYTES_PER_ELEMENT,"\nFancyArray.prototype.BYTES_PER_ELEMENT\n    Size (in bytes) of each array element (if known).\n"
+FancyArray.prototype.data,"\nFancyArray.prototype.data\n    Pointer to the underlying data buffer.\n"
+FancyArray.prototype.dtype,"\nFancyArray.prototype.dtype\n    Underlying data type.\n"
+FancyArray.prototype.flags,"\nFancyArray.prototype.flags\n    Meta information, such as information concerning the memory layout of the\n    array.\n"
+FancyArray.prototype.length,"\nFancyArray.prototype.length\n    Length of the array (i.e., number of elements).\n"
+FancyArray.prototype.ndims,"\nFancyArray.prototype.ndims\n    Number of dimensions.\n"
+FancyArray.prototype.offset,"\nFancyArray.prototype.offset\n    Index offset which specifies the buffer index at which to start iterating\n    over array elements.\n"
+FancyArray.prototype.order,"\nFancyArray.prototype.order\n    Array order.\n"
+FancyArray.prototype.shape,"\nFancyArray.prototype.shape\n    Array shape.\n"
+FancyArray.prototype.strides,"\nFancyArray.prototype.strides\n    Index strides which specify how to access data along corresponding array\n    dimensions.\n"
+FancyArray.prototype.get,"\nFancyArray.prototype.get( ...idx:integer )\n    Returns an array element specified according to provided subscripts.\n"
+FancyArray.prototype.iget,"\nFancyArray.prototype.iget( idx:integer )\n    Returns an array element located at a specified linear index.\n"
+FancyArray.prototype.set,"\nFancyArray.prototype.set( ...idx:integer, v:any )\n    Sets an array element specified according to provided subscripts.\n"
+FancyArray.prototype.iset,"\nFancyArray.prototype.iset( idx:integer, v:any )\n    Sets an array element located at a specified linear index.\n"
+FancyArray.prototype.toString,"\nFancyArray.prototype.toString()\n    Serializes a FancyArray as a string.\n"
+FancyArray.prototype.toJSON,"\nFancyArray.prototype.toJSON()\n    Serializes a FancyArray as a JSON object.\n"
 fastmath.abs,"\nfastmath.abs( x:number )\n    Computes an absolute value.\n"
 fastmath.acosh,"\nfastmath.acosh( x:number )\n    Computes the hyperbolic arccosine of a number.\n"
 fastmath.ampbm,"\nfastmath.ampbm( x:number, y:number )\n    Computes the hypotenuse using the alpha max plus beta min algorithm.\n"
@@ -4178,7 +4196,7 @@ reim,"\nreim( z:Complex128 )\n    Returns the real and imaginary components of a
 reimf,"\nreimf( z:Complex64 )\n    Returns the real and imaginary components of a single-precision complex\n    floating-point number.\n"
 rejectArguments,"\nrejectArguments( fcn:Function, predicate:Function[, thisArg:any] )\n    Returns a function that applies arguments to a provided function according\n    to a predicate function.\n"
 removeFirst,"\nremoveFirst( str:string[, n:integer][, options:Object] )\n    Removes the first character(s) of a `string`.\n"
-removeLast,"\nremoveLast( str:string[, n:integer] )\n    Removes the last character(s) of a `string`.\n"
+removeLast,"\nremoveLast( str:string[, n:integer][, options:Object] )\n    Removes the last character(s) of a `string`.\n"
 removePunctuation,"\nremovePunctuation( str:string )\n    Removes punctuation characters from a `string`.\n"
 removeUTF8BOM,"\nremoveUTF8BOM( str:string )\n    Removes a UTF-8 byte order mark (BOM) from the beginning of a `string`.\n"
 removeWords,"\nremoveWords( str:string, words:Array<string>[, ignoreCase:boolean] )\n    Removes all occurrences of the given words from a `string`.\n"

diff --git a/lib/node_modules/@stdlib/repl/info/data/data.json b/lib/node_modules/@stdlib/repl/info/data/data.json
diff --git a/lib/node_modules/@stdlib/repl/signature/data/data.csv b/lib/node_modules/@stdlib/repl/signature/data/data.csv
@@ -2494,6 +2494,24 @@ exists.sync,"exists.sync( path )"
 expandAcronyms,"expandAcronyms( str )"
 expandContractions,"expandContractions( str )"
 extname,"extname( filename )"
+FancyArray,"FancyArray( dtype, buffer, shape, strides, offset, order[, options] )"
+FancyArray.prototype.byteLength,"FancyArray.prototype.byteLength"
+FancyArray.prototype.BYTES_PER_ELEMENT,"FancyArray.prototype.BYTES_PER_ELEMENT"
+FancyArray.prototype.data,"FancyArray.prototype.data"
+FancyArray.prototype.dtype,"FancyArray.prototype.dtype"
+FancyArray.prototype.flags,"FancyArray.prototype.flags"
+FancyArray.prototype.length,"FancyArray.prototype.length"
+FancyArray.prototype.ndims,"FancyArray.prototype.ndims"
+FancyArray.prototype.offset,"FancyArray.prototype.offset"
+FancyArray.prototype.order,"FancyArray.prototype.order"
+FancyArray.prototype.shape,"FancyArray.prototype.shape"
+FancyArray.prototype.strides,"FancyArray.prototype.strides"
+FancyArray.prototype.get,"FancyArray.prototype.get( ...idx )"
+FancyArray.prototype.iget,"FancyArray.prototype.iget( idx )"
+FancyArray.prototype.set,"FancyArray.prototype.set( ...idx, v )"
+FancyArray.prototype.iset,"FancyArray.prototype.iset( idx, v )"
+FancyArray.prototype.toString,"FancyArray.prototype.toString()"
+FancyArray.prototype.toJSON,"FancyArray.prototype.toJSON()"
 fastmath.abs,"fastmath.abs( x )"
 fastmath.acosh,"fastmath.acosh( x )"
 fastmath.ampbm,"fastmath.ampbm( x, y )"
@@ -4219,7 +4237,7 @@ reim,"reim( z )"
 reimf,"reimf( z )"
 rejectArguments,"rejectArguments( fcn, predicate[, thisArg] )"
 removeFirst,"removeFirst( str[, n][, options] )"
-removeLast,"removeLast( str[, n] )"
+removeLast,"removeLast( str[, n][, options] )"
 removePunctuation,"removePunctuation( str )"
 removeUTF8BOM,"removeUTF8BOM( str )"
 removeWords,"removeWords( str, words[, ignoreCase] )"

diff --git a/lib/node_modules/@stdlib/repl/signature/data/data.json b/lib/node_modules/@stdlib/repl/signature/data/data.json
diff --git a/lib/node_modules/@stdlib/repl/typed-signature/data/data.csv b/lib/node_modules/@stdlib/repl/typed-signature/data/data.csv
@@ -2494,6 +2494,24 @@ exists.sync,"exists.sync( path:string|Buffer )"
 expandAcronyms,"expandAcronyms( str:string )"
 expandContractions,"expandContractions( str:string )"
 extname,"extname( filename:string )"
+FancyArray,"FancyArray( dtype:string, buffer:ArrayLikeObject|TypedArray|Buffer, shape:ArrayLikeObject<integer>, strides:ArrayLikeObject<integer>, offset:integer, order:string[, options:Object] )"
+FancyArray.prototype.byteLength,"FancyArray.prototype.byteLength"
+FancyArray.prototype.BYTES_PER_ELEMENT,"FancyArray.prototype.BYTES_PER_ELEMENT"
+FancyArray.prototype.data,"FancyArray.prototype.data"
+FancyArray.prototype.dtype,"FancyArray.prototype.dtype"
+FancyArray.prototype.flags,"FancyArray.prototype.flags"
+FancyArray.prototype.length,"FancyArray.prototype.length"
+FancyArray.prototype.ndims,"FancyArray.prototype.ndims"
+FancyArray.prototype.offset,"FancyArray.prototype.offset"
+FancyArray.prototype.order,"FancyArray.prototype.order"
+FancyArray.prototype.shape,"FancyArray.prototype.shape"
+FancyArray.prototype.strides,"FancyArray.prototype.strides"
+FancyArray.prototype.get,"FancyArray.prototype.get( ...idx:integer )"
+FancyArray.prototype.iget,"FancyArray.prototype.iget( idx:integer )"
+FancyArray.prototype.set,"FancyArray.prototype.set( ...idx:integer, v:any )"
+FancyArray.prototype.iset,"FancyArray.prototype.iset( idx:integer, v:any )"
+FancyArray.prototype.toString,"FancyArray.prototype.toString()"
+FancyArray.prototype.toJSON,"FancyArray.prototype.toJSON()"
 fastmath.abs,"fastmath.abs( x:number )"
 fastmath.acosh,"fastmath.acosh( x:number )"
 fastmath.ampbm,"fastmath.ampbm( x:number, y:number )"
@@ -4219,7 +4237,7 @@ reim,"reim( z:Complex128 )"
 reimf,"reimf( z:Complex64 )"
 rejectArguments,"rejectArguments( fcn:Function, predicate:Function[, thisArg:any] )"
 removeFirst,"removeFirst( str:string[, n:integer][, options:Object] )"
-removeLast,"removeLast( str:string[, n:integer] )"
+removeLast,"removeLast( str:string[, n:integer][, options:Object] )"
 removePunctuation,"removePunctuation( str:string )"
 removeUTF8BOM,"removeUTF8BOM( str:string )"
 removeWords,"removeWords( str:string, words:Array<string>[, ignoreCase:boolean] )"

diff --git a/lib/node_modules/@stdlib/repl/typed-signature/data/data.json b/lib/node_modules/@stdlib/repl/typed-signature/data/data.json
Package	Statements	Branches	Functions	Lines
repl/code-blocks	$\color{green}95/95$ $\color{green}+100.00\%$	$\color{green}7/7$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}95/95$ $\color{green}+100.00\%$
repl/help	$\color{green}95/95$ $\color{green}+100.00\%$	$\color{green}7/7$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}95/95$ $\color{green}+100.00\%$
repl/info	$\color{green}95/95$ $\color{green}+100.00\%$	$\color{green}7/7$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}95/95$ $\color{green}+100.00\%$
repl/signature	$\color{green}99/99$ $\color{green}+100.00\%$	$\color{green}10/10$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}99/99$ $\color{green}+100.00\%$
repl/typed-signature	$\color{green}99/99$ $\color{green}+100.00\%$	$\color{green}10/10$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}99/99$ $\color{green}+100.00\%$