Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -5348,7 +5348,7 @@ readJSON.sync,"\nreadJSON.sync( file[, options] )\n Synchronously reads a fil
readWASM,"\nreadWASM( file[, options], clbk )\n Asynchronously reads a file as WebAssembly.\n\n The function returns file contents as a Uint8Array.\n\n Parameters\n ----------\n file: string|Buffer|integer\n Filename or file descriptor.\n\n options: Object (optional)\n Options.\n\n options.flag: string (optional)\n Flag. Default: 'r'.\n\n clbk: Function\n Callback to invoke upon reading file contents.\n\n Examples\n --------\n > function onRead( error, data ) {\n ... if ( error ) {\n ... console.error( error.message );\n ... } else {\n ... console.log( data );\n ... }\n ... };\n > readWASM( './beep/boop.wasm', onRead );\n\n\nreadWASM.sync( file[, options] )\n Synchronously reads a file as WebAssembly.\n\n Parameters\n ----------\n file: string|Buffer|integer\n Filename or file descriptor.\n\n options: Object (optional)\n Options.\n\n options.flag: string (optional)\n Flag. Default: 'r'.\n\n Returns\n -------\n out: Error|Uint8Array\n File contents.\n\n Examples\n --------\n > var out = readWASM.sync( './beep/boop.wasm' );\n\n See Also\n --------\n readFile\n"
readWASM.sync,"\nreadWASM.sync( file[, options] )\n Synchronously reads a file as WebAssembly.\n\n Parameters\n ----------\n file: string|Buffer|integer\n Filename or file descriptor.\n\n options: Object (optional)\n Options.\n\n options.flag: string (optional)\n Flag. Default: 'r'.\n\n Returns\n -------\n out: Error|Uint8Array\n File contents.\n\n Examples\n --------\n > var out = readWASM.sync( './beep/boop.wasm' );\n\n See Also\n --------\n readFile"
real,"\nreal( z )\n Returns the real component of a double-precision complex floating-point\n number.\n\n Parameters\n ----------\n z: Complex128\n Complex number.\n\n Returns\n -------\n re: number\n Real component.\n\n Examples\n --------\n > var z = new Complex128( 5.0, 3.0 );\n > var re = real( z )\n 5.0\n\n See Also\n --------\n imag, reim\n"
realarray,"\nrealarray( [dtype] )\n Creates a typed array.\n\n The function supports the following data types:\n\n - float64: double-precision floating-point numbers (IEEE 754).\n - float32: single-precision floating-point numbers (IEEE 754).\n - int32: 32-bit two's complement signed integers.\n - uint32: 32-bit unsigned integers.\n - int16: 16-bit two's complement signed integers.\n - uint16: 16-bit unsigned integers.\n - int8: 8-bit two's complement signed integers.\n - uint8: 8-bit unsigned integers.\n - uint8c: 8-bit unsigned integers clamped to 0-255.\n\n The default typed array data type is `float64`.\n\n Parameters\n ----------\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray\n A typed array.\n\n Examples\n --------\n > var arr = realarray()\n <Float64Array>\n > arr = realarray( 'float32' )\n <Float32Array>\n\n\nrealarray( length[, dtype] )\n Returns a typed array having a specified length.\n\n Parameters\n ----------\n length: integer\n Typed array length.\n\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray\n A typed array.\n\n Examples\n --------\n > var arr = realarray( 5 )\n <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0 ]\n > arr = realarray( 5, 'int32' )\n <Int32Array>[ 0, 0, 0, 0, 0 ]\n\n\nrealarray( typedarray[, dtype] )\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 dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray\n A typed array.\n\n Examples\n --------\n > var arr1 = realarray( [ 0.5, 0.5, 0.5 ] );\n > var arr2 = realarray( arr1, 'float32' )\n <Float32Array>[ 0.5, 0.5, 0.5 ]\n\n\nrealarray( obj[, dtype] )\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 dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray\n A typed array.\n\n Examples\n --------\n > var arr1 = [ 0.5, 0.5, 0.5 ];\n > var arr2 = realarray( arr1, 'float32' )\n <Float32Array>[ 0.5, 0.5, 0.5 ]\n\n\nrealarray( buffer[, byteOffset[, length]][, dtype] )\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 dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray\n A typed array.\n\n Examples\n --------\n > var buf = new ArrayBuffer( 16 );\n > var arr = realarray( buf, 0, 4, 'float32' )\n <Float32Array>[ 0.0, 0.0, 0.0, 0.0 ]\n\n See Also\n --------\n Float64Array, Float32Array, Int32Array, Uint32Array, Int16Array, Uint16Array, Int8Array, Uint8Array, Uint8ClampedArray\n"
realarray,"\nrealarray( [dtype] )\n Creates a typed array.\n\n The function supports the following data types:\n\n - float64: double-precision floating-point numbers (IEEE 754).\n - float32: single-precision floating-point numbers (IEEE 754).\n - float16: half-precision floating-point numbers (IEEE 754).\n - int32: 32-bit two's complement signed integers.\n - uint32: 32-bit unsigned integers.\n - int16: 16-bit two's complement signed integers.\n - uint16: 16-bit unsigned integers.\n - int8: 8-bit two's complement signed integers.\n - uint8: 8-bit unsigned integers.\n - uint8c: 8-bit unsigned integers clamped to 0-255.\n\n The default typed array data type is `float64`.\n\n Parameters\n ----------\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray\n A typed array.\n\n Examples\n --------\n > var arr = realarray()\n <Float64Array>\n > arr = realarray( 'float32' )\n <Float32Array>\n\n\nrealarray( length[, dtype] )\n Returns a typed array having a specified length.\n\n Parameters\n ----------\n length: integer\n Typed array length.\n\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray\n A typed array.\n\n Examples\n --------\n > var arr = realarray( 5 )\n <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0 ]\n > arr = realarray( 5, 'int32' )\n <Int32Array>[ 0, 0, 0, 0, 0 ]\n\n\nrealarray( typedarray[, dtype] )\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 dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray\n A typed array.\n\n Examples\n --------\n > var arr1 = realarray( [ 0.5, 0.5, 0.5 ] );\n > var arr2 = realarray( arr1, 'float32' )\n <Float32Array>[ 0.5, 0.5, 0.5 ]\n\n\nrealarray( obj[, dtype] )\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 dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray\n A typed array.\n\n Examples\n --------\n > var arr1 = [ 0.5, 0.5, 0.5 ];\n > var arr2 = realarray( arr1, 'float32' )\n <Float32Array>[ 0.5, 0.5, 0.5 ]\n\n\nrealarray( buffer[, byteOffset[, length]][, dtype] )\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 dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray\n A typed array.\n\n Examples\n --------\n > var buf = new ArrayBuffer( 16 );\n > var arr = realarray( buf, 0, 4, 'float32' )\n <Float32Array>[ 0.0, 0.0, 0.0, 0.0 ]\n\n See Also\n --------\n Float64Array, Float32Array, Int32Array, Uint32Array, Int16Array, Uint16Array, Int8Array, Uint8Array, Uint8ClampedArray\n"
realarrayCtors,"\nrealarrayCtors( dtype )\n Returns a typed array constructor.\n\n The function returns constructors for the following data types:\n\n - float16: half-precision floating-point numbers.\n - float32: single-precision floating-point numbers.\n - float64: double-precision floating-point numbers.\n - int16: signed 16-bit integers.\n - int32: signed 32-bit integers.\n - int8: signed 8-bit integers.\n - uint16: unsigned 16-bit integers.\n - uint32: unsigned 32-bit integers.\n - uint8: unsigned 8-bit integers.\n - uint8c: unsigned clamped 8-bit integers.\n\n Parameters\n ----------\n dtype: string\n Data type.\n\n Returns\n -------\n out: Function|null\n Typed array constructor.\n\n Examples\n --------\n > var ctor = realarrayCtors( 'float64' )\n <Function>\n > ctor = realarrayCtors( 'float' )\n null\n\n See Also\n --------\n arrayCtors, complexarrayCtors\n"
realarrayDataTypes,"\nrealarrayDataTypes()\n Returns a list of typed array real-valued data types.\n\n Returns\n -------\n out: Array<string>\n List of typed array data types.\n\n Examples\n --------\n > var out = realarrayDataTypes()\n <Array>\n\n See Also\n --------\n arrayDataTypes, complexarrayDataTypes\n"
realf,"\nrealf( z )\n Returns the real component of a single-precision complex floating-point\n number.\n\n Parameters\n ----------\n z: Complex64\n Complex number.\n\n Returns\n -------\n re: number\n Real component.\n\n Examples\n --------\n > var z = new Complex64( 5.0, 3.0 );\n > var re = realf( z )\n 5.0\n\n See Also\n --------\n imagf, real, reimf\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.json

Large diffs are not rendered by default.