Auto-generated commit

CHANGELOG.md

@@ -272,6 +272,7 @@ A total of 9 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`b184238`](https://github.com/stdlib-js/stdlib/commit/b184238b9400c26d444ba5e843002641702b58e5) - **docs:** update REPL namespace documentation [(#2583)](https://github.com/stdlib-js/stdlib/pull/2583) _(by stdlib-bot, Athan Reines)_
 -   [`f35fdd1`](https://github.com/stdlib-js/stdlib/commit/f35fdd13e3fea642378db323489aef31b0d3612a) - **docs:** update REPL namespace documentation [(#2581)](https://github.com/stdlib-js/stdlib/pull/2581) _(by stdlib-bot, Athan Reines)_
 -   [`8751c3d`](https://github.com/stdlib-js/stdlib/commit/8751c3d047ee41fa9b12901121180416484f5348) - **docs:** update REPL namespace documentation [(#2570)](https://github.com/stdlib-js/stdlib/pull/2570) _(by stdlib-bot, Athan Reines)_
 -   [`3efb708`](https://github.com/stdlib-js/stdlib/commit/3efb708f62e31603de837db5621522471046b27d) - **fix:** address duplicate token bug when syntax-highlighting [(#2542)](https://github.com/stdlib-js/stdlib/pull/2542) _(by Snehil Shah)_

help/data/data.csv

@@ -68,7 +68,7 @@ ArrayIndex.prototype.isCached,"\nArrayIndex.prototype.isCached\n    Read-only pr
 ArrayIndex.prototype.type,"\nArrayIndex.prototype.type\n    Read-only property returning the array index type.\n\n    Returns\n    -------\n    out: string\n        Array index type.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > idx.type\n    <string>"
 ArrayIndex.prototype.toString,"\nArrayIndex.prototype.toString()\n    Serializes an instance as a string.\n\n    Returns\n    -------\n    str: string\n        Serialized string.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > idx.toString()"
 ArrayIndex.prototype.toJSON,"\nArrayIndex.prototype.toJSON()\n    Serializes an instance as a JSON object.\n\n    Returns\n    -------\n    obj: Object\n        JSON object.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > idx.toJSON()\n    { 'type': 'ArrayIndex', 'data': [ 1, 2, 3, 4 ] }\n\n    See Also\n    --------\n    array2fancy"
-arrayMinDataType,"\narrayMinDataType( value )\n    Returns the minimum array data type of the closest \"kind\" necessary for\n    storing a provided scalar value.\n\n    The function does *not* provide precision guarantees for non-integer-valued\n    real numbers. In other words, the function returns the smallest possible\n    floating-point (i.e., inexact) data type for storing numbers having\n    decimals.\n\n    Parameters\n    ----------\n    value: any\n        Scalar value.\n\n    Returns\n    -------\n    dt: string\n        Array data type.\n\n    Examples\n    --------\n    > var dt = arrayMinDataType( 3.141592653589793 )\n    'float32'\n    > dt = arrayMinDataType( 3 )\n    'uint8'\n    > dt = arrayMinDataType( -3 )\n    'int8'\n    > dt = arrayMinDataType( '-3' )\n    'generic'\n\n    See Also\n    --------\n    arrayDataTypes, arrayPromotionRules, arraySafeCasts\n"
+arrayMinDataType,"\narrayMinDataType( value )\n    Returns the minimum array data type of the closest \"kind\" necessary for\n    storing a provided scalar value.\n\n    The function does *not* provide precision guarantees for non-integer-valued\n    numbers. In other words, the function returns the smallest possible\n    floating-point (i.e., inexact) data type for storing numbers having\n    decimals.\n\n    Parameters\n    ----------\n    value: any\n        Scalar value.\n\n    Returns\n    -------\n    dt: string\n        Array data type.\n\n    Examples\n    --------\n    > var dt = arrayMinDataType( 3.141592653589793 )\n    'float32'\n    > dt = arrayMinDataType( 3 )\n    'uint8'\n    > dt = arrayMinDataType( -3 )\n    'int8'\n    > dt = arrayMinDataType( '-3' )\n    'generic'\n\n    See Also\n    --------\n    arrayDataTypes, arrayPromotionRules, arraySafeCasts\n"
 arrayMostlySafeCasts,"\narrayMostlySafeCasts( [dtype] )\n    Returns a list of array data types to which a provided array data type can\n    be safely cast and, for floating-point data types, can be downcast.\n\n    If not provided an array data type, the function returns a casting table.\n\n    If provided an unrecognized array data type, the function returns `null`.\n\n    Parameters\n    ----------\n    dtype: any (optional)\n        Array data type value.\n\n    Returns\n    -------\n    out: Object|Array<string>|null\n        Array data types to which a data type can be cast.\n\n    Examples\n    --------\n    > var out = arrayMostlySafeCasts( 'float32' )\n    <Array>\n\n    See Also\n    --------\n    convertArray, convertArraySame, arrayDataTypes, arraySafeCasts, arraySameKindCasts, ndarrayMostlySafeCasts\n"
 arrayNextDataType,"\narrayNextDataType( [dtype] )\n    Returns the next larger array data type of the same kind.\n\n    If not provided a data type, the function returns a table.\n\n    If a data type does not have a next larger data type or the next larger type\n    is not supported, the function returns `-1`.\n\n    If provided an unrecognized data type, the function returns `null`.\n\n    Parameters\n    ----------\n    dtype: string (optional)\n        Array data type.\n\n    Returns\n    -------\n    out: Object|string|integer|null\n        Next larger type(s).\n\n    Examples\n    --------\n    > var out = arrayNextDataType( 'float32' )\n    'float64'\n\n    See Also\n    --------\n    arrayDataType, arrayDataTypes\n"
 arrayPromotionRules,"\narrayPromotionRules( [dtype1, dtype2] )\n    Returns the array data type with the smallest size and closest \"kind\" to\n    which array data types can be safely cast.\n\n    If not provided data types, the function returns a type promotion table.\n\n    If a data type to which data types can be safely cast does *not* exist (or\n    is not supported), the function returns `-1`.\n\n    If provided an unrecognized data type, the function returns `null`.\n\n    Parameters\n    ----------\n    dtype1: any (optional)\n        Array data type.\n\n    dtype2: any (optional)\n        Array data type.\n\n    Returns\n    -------\n    out: Object|string|integer|null\n        Promotion rule(s).\n\n    Examples\n    --------\n    > var out = arrayPromotionRules( 'float32', 'int32' )\n    'float64'\n\n    See Also\n    --------\n    arrayDataTypes, arraySafeCasts, ndarrayPromotionRules\n"
@@ -4087,7 +4087,7 @@ ndarray2array,"\nndarray2array( x )\n    Converts an ndarray to a generic array.
 ndarrayCastingModes,"\nndarrayCastingModes()\n    Returns a list of ndarray casting modes.\n\n    The output array contains the following modes:\n\n    - 'none': only allow casting between identical types.\n    - 'equiv': allow casting between identical and byte swapped types.\n    - 'safe': only allow \"safe\" casts.\n    - 'mostly-safe': allow \"safe\" casts and, for floating-point data types,\n      downcasts.\n    - 'same-kind': allow \"safe\" casts and casts within the same kind (e.g.,\n      between signed integers or between floats).\n    - 'unsafe': allow casting between all types (including between integers and\n      floats).\n\n    Returns\n    -------\n    out: Array<string>\n        List of ndarray casting modes.\n\n    Examples\n    --------\n    > var out = ndarrayCastingModes()\n    [ 'none', 'equiv', 'safe', 'mostly-safe', 'same-kind', 'unsafe' ]\n\n    See Also\n    --------\n    array, ndarray\n"
 ndarrayDataBuffer,"\nndarrayDataBuffer( x )\n    Returns the underlying data buffer of a provided ndarray.\n\n    Parameters\n    ----------\n    x: ndarray\n        Input ndarray.\n\n    Returns\n    -------\n    out: ArrayLikeObject\n        Underlying data buffer.\n\n    Examples\n    --------\n    > var opts = { 'dtype': 'float64' };\n    > var out = ndarrayDataBuffer( ndzeros( [ 3, 3, 3 ], opts ) )\n    <Float64Array>\n\n    See Also\n    --------\n    array, ndarray, ndarrayDataType\n"
 ndarrayDataType,"\nndarrayDataType( x )\n    Returns the data type of a provided ndarray.\n\n    Parameters\n    ----------\n    x: ndarray\n        Input ndarray.\n\n    Returns\n    -------\n    dt: string\n        Data type.\n\n    Examples\n    --------\n    > var opts = { 'dtype': 'float64' };\n    > var dt = ndarrayDataType( ndzeros( [ 3, 3, 3 ], opts ) )\n    'float64'\n\n    See Also\n    --------\n    array, ndarray, ndarrayDataTypes\n"
-ndarrayDataTypes,"\nndarrayDataTypes( [kind] )\n    Returns a list of ndarray data types.\n\n    The function supports the following data type \"kinds\":\n\n    - floating_point: floating-point data types.\n    - real_floating_point: real-valued floating-point data types.\n    - complex_floating_point: complex-valued floating-point data types.\n    - integer: integer data types.\n    - signed_integer: signed integer data types.\n    - unsigned_integer: unsigned integer data types.\n    - real: real-valued data types.\n    - numeric: numeric data types.\n    - typed: typed data types.\n    - all: all data types.\n\n    Parameters\n    ----------\n    kind: string (optional)\n        Data type kind.\n\n    Returns\n    -------\n    out: Array<string>\n        List of ndarray data types.\n\n    Examples\n    --------\n    > var out = ndarrayDataTypes()\n    <Array>\n    > out = ndarrayDataTypes( 'floating_point' )\n    <Array>\n\n    See Also\n    --------\n    arrayDataTypes, array, ndarray, typedarrayDataTypes\n"
+ndarrayDataTypes,"\nndarrayDataTypes( [kind] )\n    Returns a list of ndarray data types.\n\n    The function supports the following data type \"kinds\":\n\n    - floating_point: floating-point data types.\n    - real_floating_point: real-valued floating-point data types.\n    - complex_floating_point: complex-valued floating-point data types.\n    - boolean: boolean data types.\n    - integer: integer data types.\n    - signed_integer: signed integer data types.\n    - unsigned_integer: unsigned integer data types.\n    - real: real-valued data types.\n    - numeric: numeric data types.\n    - typed: typed data types.\n    - all: all data types.\n\n    Parameters\n    ----------\n    kind: string (optional)\n        Data type kind.\n\n    Returns\n    -------\n    out: Array<string>\n        List of ndarray data types.\n\n    Examples\n    --------\n    > var out = ndarrayDataTypes()\n    <Array>\n    > out = ndarrayDataTypes( 'floating_point' )\n    <Array>\n\n    See Also\n    --------\n    arrayDataTypes, array, ndarray, typedarrayDataTypes\n"
 ndarrayDispatch,"\nndarrayDispatch( fcns, types, data, nargs, nin, nout )\n    Returns an ndarray function interface which performs multiple dispatch.\n\n    An ndarray function interface has the following signature:\n\n      f( x, y, ... )\n\n    where\n\n    - x: ndarray.\n    - y: ndarray.\n    - ...: additional ndarrays.\n\n    The number of parameters is derived from `nargs`, the number of input\n    ndarrays is derived from `nin`, and the number of output ndarrays is derived\n    from `nout`.\n\n    Parameters\n    ----------\n    fcns: Function|ArrayLikeObject<Function>\n        List of ndarray functions. An ndarray function should have the following\n        signature:\n\n          f( arrays, data )\n\n        where\n\n        - arrays: array containing input and output ndarrays.\n        - data: ndarray function data (e.g., a callback).\n\n        For convenience, a single ndarray function may be provided which will be\n        invoked whenever the ndarray argument data types match a sequence of\n        types in `types`. Providing a single ndarray function is particularly\n        convenient for the case where, regardless of array data types,\n        traversing arrays remains the same, but the ndarray function `data`\n        differs (e.g., callbacks which differ based on the array data types).\n\n    types: ArrayLikeObject\n        One-dimensional list of ndarray argument data types.\n\n    data: ArrayLikeObject|null\n        ndarray function data (e.g., callbacks). If `null`, a returned ndarray\n        function interface does **not** provide a `data` argument to an invoked\n        ndarray function.\n\n    nargs: integer\n        Total number of ndarray function interface arguments.\n\n    nin: integer\n        Number of input ndarrays.\n\n    nout: integer\n        Number of output ndarrays.\n\n    Returns\n    -------\n    fcn: Function\n        ndarray function interface.\n\n    Examples\n    --------\n    // Define ndarray argument data types:\n    > var t = [ 'float64', 'float64', 'float32', 'float32' ];\n\n    // Define a list of ndarray function data (callbacks):\n    > var d = [ base.abs, base.absf ];\n\n    // Create an ndarray function interface for applying unary callbacks:\n    > var f = ndarrayDispatch( base.ndarrayUnary, t, d, 2, 1, 1 );\n\n    // Create an input ndarray:\n    > var xbuf = new Float64Array( [ -1.0, -2.0, -3.0, -4.0 ] );\n    > var x = ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );\n\n    // Create an output ndarray:\n    > var ybuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );\n    > var y = ndarray( 'float64', ybuf, [ 4 ], [ 1 ], 0, 'row-major' );\n\n    // Compute the element-wise absolute value:\n    > f( x, y );\n    > ybuf\n    <Float64Array>[ 1.0, 2.0, 3.0, 4.0 ]\n\n    See Also\n    --------\n    array, ndarray\n"
 ndarrayFlag,"\nndarrayFlag( x, name )\n    Returns a specified flag for a provided ndarray.\n\n    Parameters\n    ----------\n    x: ndarray\n        Input ndarray.\n\n    name: string|symbol\n        Flag name.\n\n    Returns\n    -------\n    out: any\n        Flag value.\n\n    Examples\n    --------\n    > var out = ndarrayFlag( ndzeros( [ 3, 3, 3 ] ), 'READONLY' )\n    <boolean>\n\n    See Also\n    --------\n    array, ndarray, ndarrayFlags\n"
 ndarrayFlags,"\nndarrayFlags( x )\n    Returns the flags of a provided ndarray.\n\n    Parameters\n    ----------\n    x: ndarray\n        Input ndarray.\n\n    Returns\n    -------\n    out: Object\n        Flags.\n\n    Examples\n    --------\n    > var out = ndarrayFlags( ndzeros( [ 3, 3, 3 ] ) )\n    {...}\n\n    See Also\n    --------\n    array, ndarray, ndarrayFlag\n"