docs: update REPL namespace documentation

PR-URL: #3938

Co-authored-by: Philipp Burckhardt <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>
Signed-off-by: stdlib-bot <[email protected]>

Author: stdlib-bot

lib/node_modules/@stdlib/repl/code-blocks/data/data.csv

@@ -59,7 +59,7 @@ arrayCtors,"var ctor = arrayCtors( 'float64' )\nctor = arrayCtors( 'float' )\n"
 arrayDataType,"var arr = new Float64Array( 10 );\nvar dt = arrayDataType( arr )\ndt = arrayDataType( 'beep' )\n"
 arrayDataTypes,"var out = arrayDataTypes()\nout = arrayDataTypes( 'floating_point' )\nout = arrayDataTypes( 'floating_point_and_generic' )\n"
 ArrayIndex,"var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n"
-ArrayIndex.free,"var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n// ...\nArrayIndex.free( idx.id )\n"
+ArrayIndex.free,"var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\nArrayIndex.free( idx.id )\n"
 ArrayIndex.get,"var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\nArrayIndex.get( idx.id )\n"
 ArrayIndex.prototype.data,"var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\nidx.data\n"
 ArrayIndex.prototype.dtype,"var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\nidx.dtype\n"

lib/node_modules/@stdlib/repl/code-blocks/data/data.json

@@ -58,15 +58,15 @@ arraybuffer2buffer,"\narraybuffer2buffer( buf[, byteOffset[, length]] )\n    All
 arrayCtors,"\narrayCtors( dtype )\n    Returns an array constructor.\n\n    The function returns constructors for the following data types:\n\n    - float32: single-precision floating-point numbers.\n    - float64: double-precision floating-point numbers.\n    - complex64: single-precision complex floating-point numbers.\n    - complex128: double-precision complex floating-point numbers.\n    - bool: boolean values.\n    - generic: values of any type.\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        Constructor.\n\n    Examples\n    --------\n    > var ctor = arrayCtors( 'float64' )\n    <Function>\n    > ctor = arrayCtors( 'float' )\n    null\n\n    See Also\n    --------\n    typedarrayCtors\n"
 arrayDataType,"\narrayDataType( array )\n    Returns the data type of an array.\n\n    If provided an argument having an unknown or unsupported type, the function\n    returns `null`.\n\n    Parameters\n    ----------\n    array: any\n        Input value.\n\n    Returns\n    -------\n    out: string|null\n        Data type.\n\n    Examples\n    --------\n    > var arr = new Float64Array( 10 );\n    > var dt = arrayDataType( arr )\n    'float64'\n    > dt = arrayDataType( 'beep' )\n    null\n\n    See Also\n    --------\n    arrayDataTypes\n"
 arrayDataTypes,"\narrayDataTypes( [kind] )\n    Returns a list of array data types.\n\n    When not provided a data type \"kind\", the function returns an array\n    containing the following data types:\n\n    - float32: single-precision floating-point numbers.\n    - float64: double-precision floating-point numbers.\n    - complex64: single-precision complex floating-point numbers.\n    - complex128: double-precision complex floating-point numbers.\n    - bool: boolean values.\n    - generic: values of any type.\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    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    Additionally, the function supports extending the \"kinds\" listed above by\n    appending a '_and_generic' suffix to the kind name (e.g., real_and_generic).\n\n    Parameters\n    ----------\n    kind: string (optional)\n        Data type kind.\n\n    Returns\n    -------\n    out: Array<string>\n        List of array data types.\n\n    Examples\n    --------\n    > var out = arrayDataTypes()\n    [...]\n    > out = arrayDataTypes( 'floating_point' )\n    [...]\n    > out = arrayDataTypes( 'floating_point_and_generic' )\n    [...]\n\n    See Also\n    --------\n    typedarrayDataTypes, ndarrayDataTypes\n"
-ArrayIndex,"\nArrayIndex( x[, options] )\n    Wraps a provided array as an array index object.\n\n    Array index instances have no explicit functionality; however, they are used\n    by \"fancy\" arrays for element retrieval and assignment.\n\n    By default, an instance is invalidated and removed from an internal cache\n    immediately after a consumer resolves the underlying data associated with an\n    instance using the `get` static method. Immediate invalidation and cache\n    removal ensures that references to the underlying array are not the source\n    of memory leaks.\n\n    Because instances leverage an internal cache implementing the Singleton\n    pattern, one must be sure to use the same constructor as consumers. If one\n    uses a different constructor, the consumer will *not* be able to resolve the\n    original wrapped array, as the consumer will attempt to resolve an instance\n    in the wrong internal cache.\n\n    Because non-persisted instances are freed after first use, in order to avoid\n    holding onto memory and to allow garbage collection, one should avoid\n    scenarios in which an instance is never used.\n\n    Parameters\n    ----------\n    x: Array|TypedArray|Object\n        Input array.\n\n    options: Object (optional)\n        Function options.\n\n    options.persist: boolean (optional)\n        Boolean indicating whether to continue persisting an index object after\n        first usage. Default: false.\n\n    Returns\n    -------\n    out: ArrayIndex\n        ArrayIndex instance.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n\n\nArrayIndex.free( id )\n    Frees the instance associated with a provided identifier.\n\n    Parameters\n    ----------\n    id: string\n        Instance identifier.\n\n    Returns\n    -------\n    out: boolean\n        Boolean indicating whether an instance was successfully freed.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > // ...\n    > ArrayIndex.free( idx.id )\n\n\nArrayIndex.get( id )\n    Returns the array associated with the instance having a provided identifier.\n\n    Parameters\n    ----------\n    id: string\n        Instance identifier.\n\n    Returns\n    -------\n    out: Object\n        Object containing array data.\n\n    out.data: Array|TypedArray|Object\n        The underlying array associated with the provided identifier.\n\n    out.type: string\n        The type of array index.\n\n    out.dtype: string\n        The data type of the underlying array.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > ArrayIndex.get( idx.id )\n    {...}\n\n\nArrayIndex.prototype.data\n    Read-only property returning the underlying index array.\n\n    Returns\n    -------\n    out: Array|TypedArray|Object\n        Array data type.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > idx.data\n    [ 1, 2, 3, 4 ]\n\n\nArrayIndex.prototype.dtype\n    Read-only property returning the underlying data type of the index array.\n\n    Returns\n    -------\n    out: string\n        Array data type.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > idx.dtype\n    'generic'\n\n\nArrayIndex.prototype.id\n    Read-only property returning the unique identifier associated with an\n    instance.\n\n    Returns\n    -------\n    out: string\n        String identifier.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > idx.id\n    <string>\n\n\nArrayIndex.prototype.isCached\n    Read-only property returning a boolean indicating whether an array index is\n    actively cached.\n\n    Returns\n    -------\n    out: boolean\n        Boolean indicating whether an array index is actively cached.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > idx.isCached\n    true\n\n\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>\n\n\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()\n\n\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\n"
-ArrayIndex.free,"\nArrayIndex.free( id )\n    Frees the instance associated with a provided identifier.\n\n    Parameters\n    ----------\n    id: string\n        Instance identifier.\n\n    Returns\n    -------\n    out: boolean\n        Boolean indicating whether an instance was successfully freed.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > // ...\n    > ArrayIndex.free( idx.id )"
+ArrayIndex,"\nArrayIndex( x[, options] )\n    Wraps a provided array as an array index object.\n\n    Array index instances have no explicit functionality; however, they are used\n    by \"fancy\" arrays for element retrieval and assignment.\n\n    By default, an instance is invalidated and removed from an internal cache\n    immediately after a consumer resolves the underlying data associated with an\n    instance using the `get` static method. Immediate invalidation and cache\n    removal ensures that references to the underlying array are not the source\n    of memory leaks.\n\n    Because instances leverage an internal cache implementing the Singleton\n    pattern, one must be sure to use the same constructor as consumers. If one\n    uses a different constructor, the consumer will *not* be able to resolve the\n    original wrapped array, as the consumer will attempt to resolve an instance\n    in the wrong internal cache.\n\n    Because non-persisted instances are freed after first use, in order to avoid\n    holding onto memory and to allow garbage collection, one should avoid\n    scenarios in which an instance is never used.\n\n    Parameters\n    ----------\n    x: Array|TypedArray|Object\n        Input array.\n\n    options: Object (optional)\n        Function options.\n\n    options.persist: boolean (optional)\n        Boolean indicating whether to continue persisting an index object after\n        first usage. Default: false.\n\n    Returns\n    -------\n    out: ArrayIndex\n        ArrayIndex instance.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n\n\nArrayIndex.free( id )\n    Frees the instance associated with a provided identifier.\n\n    Parameters\n    ----------\n    id: string\n        Instance identifier.\n\n    Returns\n    -------\n    out: boolean\n        Boolean indicating whether an instance was successfully freed.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > ArrayIndex.free( idx.id )\n    <boolean>\n\n\nArrayIndex.get( id )\n    Returns the array associated with the instance having a provided identifier.\n\n    Parameters\n    ----------\n    id: string\n        Instance identifier.\n\n    Returns\n    -------\n    out: Object\n        Object containing array data.\n\n    out.data: Array|TypedArray|Object\n        The underlying array associated with the provided identifier.\n\n    out.type: string\n        The type of array index.\n\n    out.dtype: string\n        The data type of the underlying array.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > ArrayIndex.get( idx.id )\n    {...}\n\n\nArrayIndex.prototype.data\n    Read-only property returning the underlying index array.\n\n    Returns\n    -------\n    out: Array|TypedArray|Object\n        Array data.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > idx.data\n    [ 1, 2, 3, 4 ]\n\n\nArrayIndex.prototype.dtype\n    Read-only property returning the underlying data type of the index array.\n\n    Returns\n    -------\n    out: string\n        Array data type.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > idx.dtype\n    'generic'\n\n\nArrayIndex.prototype.id\n    Read-only property returning the unique identifier associated with an\n    instance.\n\n    Returns\n    -------\n    out: string\n        String identifier.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > idx.id\n    <string>\n\n\nArrayIndex.prototype.isCached\n    Read-only property returning a boolean indicating whether an array index is\n    actively cached.\n\n    Returns\n    -------\n    out: boolean\n        Boolean indicating whether an array index is actively cached.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > idx.isCached\n    true\n\n\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>\n\n\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()\n    <string>\n\n\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\n"
+ArrayIndex.free,"\nArrayIndex.free( id )\n    Frees the instance associated with a provided identifier.\n\n    Parameters\n    ----------\n    id: string\n        Instance identifier.\n\n    Returns\n    -------\n    out: boolean\n        Boolean indicating whether an instance was successfully freed.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > ArrayIndex.free( idx.id )\n    <boolean>"
 ArrayIndex.get,"\nArrayIndex.get( id )\n    Returns the array associated with the instance having a provided identifier.\n\n    Parameters\n    ----------\n    id: string\n        Instance identifier.\n\n    Returns\n    -------\n    out: Object\n        Object containing array data.\n\n    out.data: Array|TypedArray|Object\n        The underlying array associated with the provided identifier.\n\n    out.type: string\n        The type of array index.\n\n    out.dtype: string\n        The data type of the underlying array.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > ArrayIndex.get( idx.id )\n    {...}"
-ArrayIndex.prototype.data,"\nArrayIndex.prototype.data\n    Read-only property returning the underlying index array.\n\n    Returns\n    -------\n    out: Array|TypedArray|Object\n        Array data type.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > idx.data\n    [ 1, 2, 3, 4 ]"
+ArrayIndex.prototype.data,"\nArrayIndex.prototype.data\n    Read-only property returning the underlying index array.\n\n    Returns\n    -------\n    out: Array|TypedArray|Object\n        Array data.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > idx.data\n    [ 1, 2, 3, 4 ]"
 ArrayIndex.prototype.dtype,"\nArrayIndex.prototype.dtype\n    Read-only property returning the underlying data type of the index array.\n\n    Returns\n    -------\n    out: string\n        Array data type.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > idx.dtype\n    'generic'"
 ArrayIndex.prototype.id,"\nArrayIndex.prototype.id\n    Read-only property returning the unique identifier associated with an\n    instance.\n\n    Returns\n    -------\n    out: string\n        String identifier.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > idx.id\n    <string>"
 ArrayIndex.prototype.isCached,"\nArrayIndex.prototype.isCached\n    Read-only property returning a boolean indicating whether an array index is\n    actively cached.\n\n    Returns\n    -------\n    out: boolean\n        Boolean indicating whether an array index is actively cached.\n\n    Examples\n    --------\n    > var idx = new ArrayIndex( [ 1, 2, 3, 4 ] );\n    > idx.isCached\n    true"
 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.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()\n    <string>"
 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    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"