You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/repl/help/lib/db.js
+2
Original file line number
Diff line number
Diff line change
@@ -757,6 +757,7 @@ module.exports = {
757
757
"find": "\nfind( arr, [options,] clbk )\n Finds elements in an array-like object that satisfy a test condition.\n\n Parameters\n ----------\n arr: Array|TypedArray|string\n Object from which elements will be tested.\n\n options: Object (optional)\n Options.\n\n options.k: integer (optional)\n Limits the number of returned elements. The sign determines the\n direction in which to search. If set to a negative integer, the function\n searches from last element to first element. Default: arr.length.\n\n options.returns: string (optional)\n If `values`, values are returned; if `indices`, indices are returned; if\n `*`, both indices and values are returned. Default: 'indices'.\n\n clbk: Function\n Function invoked for each array element. If the return value is truthy,\n the value is considered to have satisfied the test condition.\n\n Returns\n -------\n out: Array\n Array of indices, element values, or arrays of index-value pairs.\n\n Examples\n --------\n > var data = [ 30, 20, 50, 60, 10 ];\n > function condition( val ) { return val > 20; };\n > var vals = find( data, condition )\n [ 0, 2, 3 ]\n\n // Limit number of results:\n > data = [ 30, 20, 50, 60, 10 ];\n > var opts = { 'k': 2, 'returns': 'values' };\n > vals = find( data, opts, condition )\n [ 30, 50 ]\n\n // Return both indices and values as index-value pairs:\n > data = [ 30, 20, 50, 60, 10 ];\n > opts = { 'k': -2, 'returns': '*' };\n > vals = find( data, opts, condition )\n [ [ 3, 60 ], [ 2, 50 ] ]\n\n",
"flattenObject": "\nflattenObject( obj[, options] )\n Flattens an object.\n\n Parameters\n ----------\n obj: ObjectLike\n Object to flatten.\n\n options: Object (optional)\n Options.\n\n options.depth: integer (optional)\n Maximum depth to flatten.\n\n options.copy: boolean (optional)\n Boolean indicating whether to deep copy. Default: false.\n\n options.flattenArrays: boolean (optional)\n Boolean indicating whether to flatten arrays. Default: false.\n\n options.delimiter: string (optional)\n Key path delimiter. Default: '.'.\n\n Returns\n -------\n out: ObjectLike\n Flattened object.\n\n Examples\n --------\n > var obj = { 'a': { 'b': { 'c': 'd' } } };\n > var out = flattenObject( obj )\n { 'a.b.c': 'd' }\n\n // Set the `depth` option to flatten to a specified depth:\n > obj = { 'a': { 'b': { 'c': 'd' } } };\n > out = flattenObject( obj, { 'depth': 1 } )\n { 'a.b': { 'c': 'd' } }\n > var bool = ( obj.a.b === out[ 'a.b' ] )\n true\n\n // Set the `delimiter` option:\n > obj = { 'a': { 'b': { 'c': 'd' } } };\n > out = flattenObject( obj, { 'delimiter': '-|-' } )\n { 'a-|-b-|-c': 'd' }\n\n // Flatten arrays:\n > obj = { 'a': { 'b': [ 1, 2, 3 ] } };\n > out = flattenObject( obj, { 'flattenArrays': true } )\n { 'a.b.0': 1, 'a.b.1': 2, 'a.b.2': 3 }\n\n\nflattenObject.factory( options )\n Returns a function for flattening arrays having specified dimensions.\n\n The returned function does not validate that input arrays actually have the\n specified dimensions.\n\n Parameters\n ----------\n options: Object (optional)\n Options.\n\n options.depth: integer (optional)\n Maximum depth to flatten.\n\n options.copy: boolean (optional)\n Boolean indicating whether to deep copy. Default: false.\n\n options.flattenArrays: boolean (optional)\n Boolean indicating whether to flatten arrays. Default: false.\n\n options.delimiter: string (optional)\n Key path delimiter. Default: '.'.\n\n Returns\n -------\n fcn: Function\n Flatten function.\n\n Examples\n --------\n > var flatten = flattenObject.factory({\n ... 'depth': 2,\n ... 'copy': true,\n ... 'delimiter': '|'\n ... });\n > var obj = { 'a': { 'b': { 'c': 'd' } } };\n > var out = flatten( obj )\n { 'a|b': { 'c': 'd' } }\n\n See Also\n --------\n flattenArray\n",
760
+
"FLOAT16_CBRT_EPS": "\nFLOAT16_CBRT_EPS\n Cube root of half-precision floating-point epsilon.\n\n Examples\n --------\n > FLOAT16_CBRT_EPS\n 0.09921256574801247\n\n See Also\n --------\n FLOAT16_EPS, FLOAT16_SQRT_EPS, FLOAT32_CBRT_EPS, CBRT_EPS\n",
760
761
"FLOAT16_EPS": "\nFLOAT16_EPS\n Difference between one and the smallest value greater than one that can be\n represented as a half-precision floating-point number.\n\n Examples\n --------\n > FLOAT16_EPS\n 0.0009765625\n\n See Also\n --------\n FLOAT32_EPS, EPS\n",
761
762
"FLOAT16_EXPONENT_BIAS": "\nFLOAT16_EXPONENT_BIAS\n The bias of a half-precision floating-point number's exponent.\n\n Examples\n --------\n > FLOAT16_EXPONENT_BIAS\n 15\n\n See Also\n --------\n FLOAT32_EXPONENT_BIAS, FLOAT64_EXPONENT_BIAS\n",
762
763
"FLOAT16_MAX": "\nFLOAT16_MAX\n Maximum half-precision floating-point number.\n\n Examples\n --------\n > FLOAT16_MAX\n 65504.0\n\n See Also\n --------\n FLOAT32_MAX, FLOAT64_MAX\n",
"FLOAT16_SQRT_EPS": "\nFLOAT16_SQRT_EPS\n Square root of half-precision floating-point epsilon.\n\n Examples\n --------\n > FLOAT16_SQRT_EPS\n 0.03125\n\n See Also\n --------\n FLOAT16_EPS, FLOAT32_SQRT_EPS, SQRT_EPS\n",
772
773
"Float32Array": "\nFloat32Array()\n A typed array constructor which returns a typed array representing an array\n of single-precision floating-point numbers in the platform byte order.\n\n Returns\n -------\n out: Float32Array\n A typed array.\n\n Examples\n --------\n > var arr = new Float32Array()\n <Float32Array>\n\n\nFloat32Array( length )\n Returns a typed array having a specified length.\n\n Parameters\n ----------\n length: integer\n Typed array length.\n\n Returns\n -------\n out: Float32Array\n A typed array.\n\n Examples\n --------\n > var arr = new Float32Array( 5 )\n <Float32Array>[ 0.0, 0.0, 0.0, 0.0, 0.0 ]\n\n\nFloat32Array( typedarray )\n Creates a typed array from another typed array.\n\n Parameters\n ----------\n typedarray: TypedArray\n Typed array from which to generate another typed array.\n\n Returns\n -------\n out: Float32Array\n A typed array.\n\n Examples\n --------\n > var arr1 = new Float64Array( [ 0.5, 0.5, 0.5 ] );\n > var arr2 = new Float32Array( arr1 )\n <Float32Array>[ 0.5, 0.5, 0.5 ]\n\n\nFloat32Array( obj )\n Creates a typed array from an array-like object or iterable.\n\n Parameters\n ----------\n obj: Object\n Array-like object or iterable from which to generate a typed array.\n\n Returns\n -------\n out: Float32Array\n A typed array.\n\n Examples\n --------\n > var arr1 = [ 0.5, 0.5, 0.5 ];\n > var arr2 = new Float32Array( arr1 )\n <Float32Array>[ 0.5, 0.5, 0.5 ]\n\n\nFloat32Array( buffer[, byteOffset[, length]] )\n Returns a typed array view of an ArrayBuffer.\n\n Parameters\n ----------\n buffer: ArrayBuffer\n Underlying ArrayBuffer.\n\n byteOffset: integer (optional)\n Integer byte offset specifying the location of the first typed array\n element. Default: 0.\n\n length: integer (optional)\n View length. If not provided, the view spans from the byteOffset to\n the end of the underlying ArrayBuffer.\n\n Returns\n -------\n out: Float32Array\n A typed array.\n\n Examples\n --------\n > var buf = new ArrayBuffer( 16 );\n > var arr = new Float32Array( buf, 0, 4 )\n <Float32Array>[ 0.0, 0.0, 0.0, 0.0 ]\n\n\nFloat32Array.BYTES_PER_ELEMENT\n Number of bytes per view element.\n\n Examples\n --------\n > Float32Array.BYTES_PER_ELEMENT\n 4\n\n\nFloat32Array.name\n Typed array constructor name.\n\n Examples\n --------\n > Float32Array.name\n Float32Array\n\n\nFloat32Array.prototype.buffer\n Read-only property which returns the ArrayBuffer referenced by the typed\n array.\n\n Examples\n --------\n > var arr = new Float32Array( 5 );\n > arr.buffer\n <ArrayBuffer>\n\n\nFloat32Array.prototype.byteLength\n Read-only property which returns the length (in bytes) of the typed array.\n\n Examples\n --------\n > var arr = new Float32Array( 5 );\n > arr.byteLength\n 20\n\n\nFloat32Array.prototype.byteOffset\n Read-only property which returns the offset (in bytes) of the typed array\n from the start of its ArrayBuffer.\n\n Examples\n --------\n > var arr = new Float32Array( 5 );\n > arr.byteOffset\n 0\n\n\nFloat32Array.prototype.length\n Read-only property which returns the number of view elements.\n\n Examples\n --------\n > var arr = new Float32Array( 5 );\n > arr.length\n 5\n\n\nTODO: add methods\n\n\n See Also\n --------\n Float64Array, Int16Array, Int32Array, Int8Array, Uint16Array, Uint32Array, Uint8Array, Uint8ClampedArray\n",
774
+
"FLOAT32_CBRT_EPS": "\nFLOAT32_CBRT_EPS\n Cube root of single-precision floating-point epsilon.\n\n Examples\n --------\n > FLOAT32_CBRT_EPS\n 0.004921566601151848\n\n See Also\n --------\n FLOAT32_EPS, FLOAT32_SQRT_EPS, CBRT_EPS\n",
773
775
"FLOAT32_EPS": "\nFLOAT32_EPS\n Difference between one and the smallest value greater than one that can be\n represented as a single-precision floating-point number.\n\n Examples\n --------\n > FLOAT32_EPS\n 1.1920928955078125e-7\n\n See Also\n --------\n EPS\n",
774
776
"FLOAT32_EXPONENT_BIAS": "\nFLOAT32_EXPONENT_BIAS\n The bias of a single-precision floating-point number's exponent.\n\n Examples\n --------\n > FLOAT32_EXPONENT_BIAS\n 127\n\n See Also\n --------\n FLOAT16_EXPONENT_BIAS, FLOAT64_EXPONENT_BIAS\n",
775
777
"FLOAT32_MAX": "\nFLOAT32_MAX\n Maximum single-precision floating-point number.\n\n Examples\n --------\n > FLOAT32_MAX\n 3.4028234663852886e+38\n\n See Also\n --------\n FLOAT16_MAX, FLOAT64_MAX\n",
0 commit comments