Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update REPL namespace documentation #2476

Merged
merged 1 commit into from
Jun 29, 2024
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 @@ -2863,7 +2863,7 @@ fastmath.powint,"\nfastmath.powint( x, y )\n Evaluates the exponential functi
fastmath.sqrtUint32,"\nfastmath.sqrtUint32( x )\n Returns an approximate square root of an unsigned 32-bit integer `x`.\n\n Prefer hardware `sqrt` over a software implementation.\n\n When using a software `sqrt`, this function provides a performance boost\n when an application requires only approximate computations for integer\n arguments.\n\n For applications requiring high-precision, this function is never suitable.\n\n Parameters\n ----------\n x: uinteger\n Input value.\n\n Returns\n -------\n out: uinteger\n Integer square root.\n\n Examples\n --------\n > var v = fastmath.sqrtUint32( 9 >>> 0 )\n 3\n > v = fastmath.sqrtUint32( 2 >>> 0 )\n 1\n > v = fastmath.sqrtUint32( 3 >>> 0 )\n 1\n > v = fastmath.sqrtUint32( 0 >>> 0 )\n 0\n\n See Also\n --------\n base.sqrt\n"
FEMALE_FIRST_NAMES_EN,"\nFEMALE_FIRST_NAMES_EN()\n Returns a list of common female first names in English speaking countries.\n\n Returns\n -------\n out: Array<string>\n List of common female first names.\n\n Examples\n --------\n > var list = FEMALE_FIRST_NAMES_EN()\n [ 'Aaren', 'Aarika', 'Abagael', 'Abagail', ... ]\n\n References\n ----------\n - Ward, Grady. 2002. \"Moby Word II.\" <http://www.gutenberg.org/files/3201/\n 3201.txt>.\n\n See Also\n --------\n MALE_FIRST_NAMES_EN\n"
FIFO,"\nFIFO()\n First-in-first-out (FIFO) queue constructor.\n\n Returns\n -------\n queue: Object\n First-in-first-out queue.\n\n queue.clear: Function\n Clears the queue.\n\n queue.first: Function\n Returns the \"oldest\" queue value (i.e., the value which is \"first-out\").\n If the queue is empty, the returned value is `undefined`.\n\n queue.iterator: Function\n Returns an iterator for iterating over a queue. If an environment\n supports Symbol.iterator, the returned iterator is iterable. Note that,\n in order to prevent confusion arising from queue mutation during\n iteration, a returned iterator **always** iterates over a queue\n \"snapshot\", which is defined as the list of queue elements at the time\n of the method's invocation.\n\n queue.last: Function\n Returns the \"newest\" queue value (i.e., the value which is \"last-out\").\n If the queue is empty, the returned value is `undefined`.\n\n queue.length: integer\n Queue length.\n\n queue.pop: Function\n Removes and returns the current \"first-out\" value from the queue. If the\n queue is empty, the returned value is `undefined`.\n\n queue.push: Function\n Adds a value to the queue.\n\n queue.toArray: Function\n Returns an array of queue values.\n\n queue.toJSON: Function\n Serializes a queue as JSON.\n\n Examples\n --------\n > var q = FIFO();\n > q.push( 'foo' ).push( 'bar' );\n > q.length\n 2\n > q.pop()\n 'foo'\n > q.length\n 1\n > q.pop()\n 'bar'\n > q.length\n 0\n\n See Also\n --------\n Stack\n"
filledarray,"\nfilledarray( [dtype] )\n Creates a filled 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 - complex128: double-precision complex floating-point numbers\n - complex64: single-precision complex floating-point numbers\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 - generic: generic JavaScript values\n\n The default 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|Array\n Output array.\n\n Examples\n --------\n > var arr = filledarray()\n <Float64Array>\n > arr = filledarray( 'float32' )\n <Float32Array>\n\n\nfilledarray( value, length[, dtype] )\n Returns a filled array having a specified length.\n\n Parameters\n ----------\n value: any\n Fill value.\n\n length: integer\n Array length.\n\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray|Array\n Output array.\n\n Examples\n --------\n > var arr = filledarray( 1.0, 5 )\n <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]\n > arr = filledarray( 1, 5, 'int32' )\n <Int32Array>[ 1, 1, 1, 1, 1 ]\n\n\nfilledarray( value, array[, dtype] )\n Creates a filled array from another array (or array-like object).\n\n Parameters\n ----------\n value: any\n Fill value.\n\n array: ArrayLikeObject\n Array from which to generate another array.\n\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray|Array\n Output array.\n\n Examples\n --------\n > var arr1 = filledarray( 2.0, [ 0.5, 0.5, 0.5 ] )\n <Float64Array>[ 2.0, 2.0, 2.0 ]\n > var arr2 = filledarray( 1.0, arr1, 'float32' )\n <Float32Array>[ 1.0, 1.0, 1.0 ]\n\n\nfilledarray( value, iterable[, dtype] )\n Creates a filled array from an iterable.\n\n Parameters\n ----------\n value: any\n Fill value.\n\n iterable: Iterable\n Iterable from which to generate an array.\n\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray|Array\n Output array.\n\n Examples\n --------\n > var arr1 = iterConstant( 3.0, {'iter': 3} );\n > var arr2 = filledarray( 1.0, arr1, 'float32' )\n <Float32Array>[ 1.0, 1.0, 1.0 ]\n\n\nfilledarray( value, buffer[, byteOffset[, length]][, dtype] )\n Returns a filled typed array view of an ArrayBuffer.\n\n The 'generic' array data type is *not* supported.\n\n Parameters\n ----------\n value: any\n Fill value.\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 = filledarray( 1.0, buf, 0, 4, 'float32' )\n <Float32Array>[ 1.0, 1.0, 1.0, 1.0 ]\n\n See Also\n --------\n filledarrayBy, typedarray\n"
filledarray,"\nfilledarray( [dtype] )\n Creates a filled array.\n\n Parameters\n ----------\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray|Array\n Output array.\n\n Examples\n --------\n > var arr = filledarray()\n <Float64Array>\n > arr = filledarray( 'float32' )\n <Float32Array>\n\n\nfilledarray( value, length[, dtype] )\n Returns a filled array having a specified length.\n\n Parameters\n ----------\n value: any\n Fill value.\n\n length: integer\n Array length.\n\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray|Array\n Output array.\n\n Examples\n --------\n > var arr = filledarray( 1.0, 5 )\n <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]\n > arr = filledarray( 1, 5, 'int32' )\n <Int32Array>[ 1, 1, 1, 1, 1 ]\n\n\nfilledarray( value, array[, dtype] )\n Creates a filled array from another array (or array-like object).\n\n Parameters\n ----------\n value: any\n Fill value.\n\n array: ArrayLikeObject\n Array from which to generate another array.\n\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray|Array\n Output array.\n\n Examples\n --------\n > var arr1 = filledarray( 2.0, [ 0.5, 0.5, 0.5 ] )\n <Float64Array>[ 2.0, 2.0, 2.0 ]\n > var arr2 = filledarray( 1.0, arr1, 'float32' )\n <Float32Array>[ 1.0, 1.0, 1.0 ]\n\n\nfilledarray( value, iterable[, dtype] )\n Creates a filled array from an iterable.\n\n Parameters\n ----------\n value: any\n Fill value.\n\n iterable: Iterable\n Iterable from which to generate an array.\n\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n Returns\n -------\n out: TypedArray|Array\n Output array.\n\n Examples\n --------\n > var arr1 = iterConstant( 3.0, {'iter': 3} );\n > var arr2 = filledarray( 1.0, arr1, 'float32' )\n <Float32Array>[ 1.0, 1.0, 1.0 ]\n\n\nfilledarray( value, buffer[, byteOffset[, length]][, dtype] )\n Returns a filled typed array view of an ArrayBuffer.\n\n The 'generic' array data type is *not* supported.\n\n Parameters\n ----------\n value: any\n Fill value.\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 = filledarray( 1.0, buf, 0, 4, 'float32' )\n <Float32Array>[ 1.0, 1.0, 1.0, 1.0 ]\n\n See Also\n --------\n filledarrayBy, typedarray\n"
filledarrayBy,"\nfilledarrayBy( [dtype] )\n Creates a filled 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 - complex128: double-precision complex floating-point numbers\n - complex64: single-precision complex floating-point numbers\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 - generic: generic JavaScript values\n\n The default 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|Array\n Output array.\n\n Examples\n --------\n > var arr = filledarrayBy()\n <Float64Array>\n > arr = filledarrayBy( 'float32' )\n <Float32Array>\n\n\nfilledarrayBy( length[, dtype], clbk[, thisArg] )\n Returns a filled array according to a provided callback function and having\n a specified length.\n\n Parameters\n ----------\n length: integer\n Array length.\n\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n clbk: Function\n Callback function.\n\n thisArg: any (optional)\n Callback execution context.\n\n Returns\n -------\n out: TypedArray|Array\n Output array.\n\n Examples\n --------\n > function clbk() { return 1.0; };\n > var arr = filledarrayBy( 5, clbk )\n <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]\n > arr = filledarrayBy( 5, 'int32', clbk )\n <Int32Array>[ 1, 1, 1, 1, 1 ]\n\n\nfilledarrayBy( array[, dtype], clbk[, thisArg] )\n Creates a filled array from another array (or array-like object) according\n to a provided callback function.\n\n Parameters\n ----------\n array: ArrayLikeObject\n Array from which to generate another array.\n\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n clbk: Function\n Callback function.\n\n thisArg: any (optional)\n Callback execution context.\n\n Returns\n -------\n out: TypedArray|Array\n Output array.\n\n Examples\n --------\n > var arr1 = filledarrayBy( [ 0.5, 0.5, 0.5 ], constantFunction( 2.0 ) )\n <Float64Array>[ 2.0, 2.0, 2.0 ]\n > var arr2 = filledarrayBy( arr1, 'float32', constantFunction( 1.0 ) )\n <Float32Array>[ 1.0, 1.0, 1.0 ]\n\n\nfilledarrayBy( iterable[, dtype], clbk[, thisArg] )\n Creates a filled array from an iterable according to a provided callback\n function.\n\n Parameters\n ----------\n iterable: Iterable\n Iterable from which to generate an array.\n\n dtype: string (optional)\n Data type. Default: 'float64'.\n\n clbk: Function\n Callback function.\n\n thisArg: any (optional)\n Callback execution context.\n\n Returns\n -------\n out: TypedArray|Array\n Output array.\n\n Examples\n --------\n > var arr1 = iterConstant( 3.0, {'iter': 3} );\n > var arr2 = filledarrayBy( arr1, 'float32', constantFunction( 1.0 ) )\n <Float32Array>[ 1.0, 1.0, 1.0 ]\n\n\nfilledarrayBy( buffer[, byteOffset[, length]][, dtype], clbk[, thisArg] )\n Returns a filled typed array view of an ArrayBuffer according to a provided\n callback function.\n\n The 'generic' array data type is *not* supported.\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 clbk: Function\n Callback function.\n\n thisArg: any (optional)\n Callback execution context.\n\n Returns\n -------\n out: TypedArray\n A typed array.\n\n Examples\n --------\n > var buf = new ArrayBuffer( 16 );\n > var arr = filledarrayBy( buf, 0, 4, 'float32', constantFunction( 1.0 ) )\n <Float32Array>[ 1.0, 1.0, 1.0, 1.0 ]\n\n See Also\n --------\n filledarray, typedarray\n"
filterArguments,"\nfilterArguments( fcn, predicate[, thisArg] )\n Returns a function that applies arguments to a provided function according\n to a predicate function.\n\n Only those arguments in which the predicate function returns a truthy value\n are applied to a provided function.\n\n The predicate function is provided the following arguments:\n\n - value: argument value.\n - index: argument index.\n\n Parameters\n ----------\n fcn: Function\n Input function.\n\n predicate: Function\n Predicate function.\n\n thisArg: any (optional)\n Input function context.\n\n Returns\n -------\n out: Function\n Function wrapper.\n\n Examples\n --------\n > function foo( a, b ) { return [ a, b ]; };\n > function predicate( v ) { return ( v !== 2 ); };\n > var bar = filterArguments( foo, predicate );\n > var out = bar( 1, 2, 3 )\n [ 1, 3 ]\n\n See Also\n --------\n maskArguments, rejectArguments, reorderArguments, reverseArguments\n"
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"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.json

Large diffs are not rendered by default.

Loading