@stdlib/repl-help/data/data.json

Return help text associated with a provided alias.

{"abs":"\nabs( x[, options] )\n    Computes the absolute value.\n\n    If provided a number, the function returns a number.\n\n    If provided an ndarray or array-like object, the function performs element-\n    wise computation.\n\n    If provided an array-like object, the function returns an array-like object\n    having the same length and data type as `x`.\n\n    If provided an ndarray, the function returns an ndarray having the same\n    shape and data type as `x`.\n\n    Parameters\n    ----------\n    x: ndarray|ArrayLikeObject|number\n        Input value.\n\n    options: Object (optional)\n        Options.\n\n    options.order: string (optional)\n        Output array order (either row-major (C-style) or column-major (Fortran-\n        style)). Only applicable when the input array is an ndarray. By default,\n        the output array order is inferred from the input array.\n\n    options.dtype: string (optional)\n        Output array data type. Only applicable when the input array is either\n        an ndarray or array-like object. By default, the output array data type\n        is inferred from the input array.\n\n    Returns\n    -------\n    y: ndarray|ArrayLikeObject|number\n        Results.\n\n    Examples\n    --------\n    // Provide a number:\n    > var y = abs( -1.0 )\n    1.0\n\n    // Provide an array-like object:\n    > var x = new Float64Array( [ -1.0, -2.0 ] );\n    > y = abs( x )\n    <Float64Array>[ 1.0, 2.0 ]\n\n    > x = [ -1.0, -2.0 ];\n    > y = abs( x )\n    [ 1.0, 2.0 ]\n\n    // Provide an ndarray:\n    > x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );\n    > y = abs( x )\n    <ndarray>\n    > y.get( 0, 1 )\n    2.0\n\n\nabs.assign( x, y )\n    Computes the absolute value and assigns results to a provided output array.\n\n    Parameters\n    ----------\n    x: ndarray|ArrayLikeObject\n        Input array.\n\n    y: ndarray|ArrayLikeObject\n        Output array. Must be the same data \"kind\" (i.e., ndarray or array-like\n        object) as the input array.\n\n    Returns\n    -------\n    y: ndarray|ArrayLikeObject\n        Output array.\n\n    Examples\n    --------\n    // Provide an array-like object:\n    > var x = new Float64Array( [ -1.0, -2.0 ] );\n    > var y = new Float64Array( x.length );\n    > var out = abs.assign( x, y )\n    <Float64Array>[ 1.0, 2.0 ]\n    > var bool = ( out === y )\n    true\n\n    > x = [ -1.0, -2.0 ];\n    > y = [ 0.0, 0.0 ];\n    > out = abs.assign( x, y )\n    [ 1.0, 2.0 ]\n    > bool = ( out === y )\n    true\n\n    // Provide an ndarray:\n    > x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );\n    > y = array( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] );\n    > out = abs.assign( x, y )\n    <ndarray>\n    > out.get( 0, 1 )\n    2.0\n    > bool = ( out === y )\n    true\n\n","abs.assign":"\nabs.assign( x, y )\n    Computes the absolute value and assigns results to a provided output array.\n\n    Parameters\n    ----------\n    x: ndarray|ArrayLikeObject\n        Input array.\n\n    y: ndarray|ArrayLikeObject\n        Output array. Must be the same data \"kind\" (i.e., ndarray or array-like\n        object) as the input array.\n\n    Returns\n    -------\n    y: ndarray|ArrayLikeObject\n        Output array.\n\n    Examples\n    --------\n    // Provide an array-like object:\n    > var x = new Float64Array( [ -1.0, -2.0 ] );\n    > var y = new Float64Array( x.length );\n    > var out = abs.assign( x, y )\n    <Float64Array>[ 1.0, 2.0 ]\n    > var bool = ( out === y )\n    true\n\n    > x = [ -1.0, -2.0 ];\n    > y = [ 0.0, 0.0 ];\n    > out = abs.assign( x, y )\n    [ 1.0, 2.0 ]\n    > bool = ( out === y )\n    true\n\n    // Provide an ndarray:\n    > x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );\n    > y = array( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] );\n    > out = abs.assign( x, y )\n    <ndarray>\n    > out.get( 0, 1 )\n    2.0\n    > bool = ( out === y )\n    true","acartesianPower":"\nacartesianPower( x, n )\n    Returns the Cartesian power.\n\n    If provided an empty array, the function returns an empty array.\n\n    If `n` is less than or equal to zero, the function returns an empty array.\n\n    Parameters\n    ----------\n    x: ArrayLikeObject\n        Input array.\n\n    n: integer\n        Power.\n\n    Returns\n    -------\n    out: Array<Array>\n        Cartesian product.\n\n    Examples\n    --------\n    > var x = [ 1, 2 ];\n    > var out = acartesianPower( x, 2 )\n    [ [ 1, 1 ], [ 1, 2 ], [ 2, 1 ], [ 2, 2 ] ]\n\n    See Also\n    --------\n    acartesianProduct, acartesianSquare\n","acartesianProduct":"\nacartesianProduct( x1, x2 )\n    Returns the Cartesian product.\n\n    If provided one or more empty arrays, the function returns an empty array.\n\n    Parameters\n    ----------\n    x1: ArrayLikeObject\n        First input array.\n\n    x2: ArrayLikeObject\n        Second input array.\n\n    Returns\n    -------\n    out: Array<Array>\n        Cartesian product.\n\n    Examples\n    --------\n    > var x1 = [ 1, 2 ];\n    > var x2 = [ 3, 4 ];\n    > var out = acartesianProduct( x1, x2 )\n    [ [ 1, 3 ], [ 1, 4 ], [ 2, 3 ], [ 2, 4 ] ]\n\n    See Also\n    --------\n    acartesianPower, acartesianSquare\n","acartesianSquare":"\nacartesianSquare( x )\n    Returns the Cartesian square.\n\n    If provided an empty array, the function returns an empty array.\n\n    Parameters\n    ----------\n    x: ArrayLikeObject\n        Input array.\n\n    Returns\n    -------\n    out: Array<Array>\n        Cartesian product.\n\n    Examples\n    --------\n    > var out = acartesianSquare( [ 1, 2 ] )\n    [ [ 1, 1 ], [ 1, 2 ], [ 2, 1 ], [ 2, 2 ] ]\n\n    See Also\n    --------\n    acartesianPower, acartesianProduct\n","acronym":"\nacronym( str[, options] )\n    Generates an acronym for a given string.\n\n    Parameters\n    ----------\n    str: string\n        Input string.\n\n    options: Object (optional)\n        Options.\n\n    options.stopwords: Array<string> (optional)\n        Array of custom stop words.\n\n    Returns\n    -------\n    out: string\n        Acronym for the given string.\n\n    Examples\n    --------\n    > var out = acronym( 'the quick brown fox' )\n    'QBF'\n    > out = acronym( 'Hard-boiled eggs' )\n    'HBE'\n","aempty":"\naempty( length[, dtype] )\n    Creates an uninitialized array having a specified length.\n\n    In browser environments, the function always returns zero-filled arrays.\n\n    If `dtype` is 'generic', the function always returns a zero-filled array.\n\n    In Node.js versions >=3.0.0, the underlying memory of returned typed arrays\n    is *not* initialized. Memory contents are unknown and may contain\n    *sensitive* data.\n\n    Parameters\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 = aempty( 2 )\n    <Float64Array>\n    > arr = aempty( 2, 'float32' )\n    <Float32Array>\n\n    See Also\n    --------\n    aemptyLike, afull, aones, azeros, ndempty\n","aemptyLike":"\naemptyLike( x[, dtype] )\n    Creates an uninitialized array having the same length and data type as a\n    provided input array.\n\n    In browser environments, the function always returns zero-filled arrays.\n\n    If `dtype` is 'generic', the function always returns a zero-filled array.\n\n    In Node.js versions >=3.0.0, the underlying memory of returned typed arrays\n    is *not* initialized. Memory contents are unknown and may contain\n    *sensitive* data.\n\n    Parameters\n    ----------\n    x: TypedArray|Array\n        Input array.\n\n    dtype: string (optional)\n        Data type. If not provided, the output array data type is inferred from\n        the input array.\n\n    Returns\n    -------\n    out: TypedArray|Array\n        Output array.\n\n    Examples\n    --------\n    > var x = new Float64Array( 2 );\n    > var arr = aemptyLike( x )\n    <Float64Array>\n    > arr = aemptyLike( x, 'float32' )\n    <Float32Array>\n\n    See Also\n    --------\n    aempty, afullLike, aonesLike, azerosLike, ndemptyLike\n","AFINN_96":"\nAFINN_96()\n    Returns a list of English words rated for valence.\n\n    The returned list contains 1468 English words (and phrases) rated for\n    valence. Negative words have a negative valence [-5,0). Positive words have\n    a positive valence (0,5]. Neutral words have a valence of 0.\n\n    A few notes:\n\n    - The list is an earlier version of AFINN-111.\n    - The list includes misspelled words. Their presence is intentional, as such\n      misspellings frequently occur in social media content.\n    - All words are lowercase.\n    - Some \"words\" are phrases; e.g., \"cashing in\", \"cool stuff\".\n    - Words may contain apostrophes; e.g., \"can't stand\".\n    - Words may contain dashes; e.g., \"cover-up\", \"made-up\".\n\n    Returns\n    -------\n    out: Array<Array>\n        List of English words and their valence.\n\n    Examples\n    --------\n    > var list = AFINN_96()\n    [ [ 'abandon', -2 ], [ 'abandons', -2 ], [ 'abandoned', -2 ], ... ]\n\n    References\n    ----------\n    - Nielsen, Finn Årup. 2011. \"A new ANEW: Evaluation of a word list for\n    sentiment analysis in microblogs.\" In *Proceedings of the ESWC2011 Workshop\n    on 'Making Sense of Microposts': Big Things Come in Small Packages.*,\n    718:93–98. CEUR Workshop Proceedings. <http://ceur-ws.org/Vol-718/paper_16.\n    pdf>.\n\n    * If you use the list for publication or third party consumption, please\n    cite the listed reference.\n\n    See Also\n    --------\n    AFINN_111\n","AFINN_111":"\nAFINN_111()\n    Returns a list of English words rated for valence.\n\n    The returned list contains 2477 English words (and phrases) rated for\n    valence. Negative words have a negative valence [-5,0). Positive words have\n    a positive valence (0,5]. Neutral words have a valence of 0.\n\n    A few notes:\n\n    - The list includes misspelled words. Their presence is intentional, as such\n      misspellings frequently occur in social media content.\n    - All words are lowercase.\n    - Words may contain numbers; e.g., \"n00b\".\n    - Some \"words\" are phrases; e.g., \"cool stuff\", \"not good\".\n    - Words may contain apostrophes; e.g., \"can't stand\".\n    - Words may contain diaeresis; e.g., \"naïve\".\n    - Words may contain dashes; e.g., \"self-deluded\", \"self-confident\".\n\n    Returns\n    -------\n    out: Array<Array>\n        List of English words and their valence.\n\n    Examples\n    --------\n    > var list = AFINN_111()\n    [ [ 'abandon', -2 ], [ 'abandoned', -2 ], [ 'abandons', -2 ], ... ]\n\n    References\n    ----------\n    - Nielsen, Finn Årup. 2011. \"A new ANEW: Evaluation of a word list for\n    sentiment analysis in microblogs.\" In *Proceedings of the ESWC2011 Workshop\n    on 'Making Sense of Microposts': Big Things Come in Small Packages.*,\n    718:93–98. CEUR Workshop Proceedings. <http://ceur-ws.org/Vol-718/paper_16.\n    pdf>.\n\n    * If you use the list for publication or third party consumption, please\n    cite the listed reference.\n\n    See Also\n    --------\n    AFINN_96\n","afull":"\nafull( length, value[, dtype] )\n    Returns a filled array having a specified length.\n\n    Parameters\n    ----------\n    length: integer\n        Array length.\n\n    value: any\n        Fill value.\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 = afull( 2, 1.0 )\n    <Float64Array>[ 1.0, 1.0 ]\n    > arr = afull( 2, 1.0, 'float32' )\n    <Float32Array>[ 1.0, 1.0 ]\n\n    See Also\n    --------\n    afullLike, aones, azeros\n","afullLike":"\nafullLike( x[, dtype] )\n    Returns a filled array having the same length and data type as a provided\n    input array.\n\n    Parameters\n    ----------\n    x: TypedArray|Array\n        Input array.\n\n    dtype: string (optional)\n        Data type. If not provided, the output array data type is inferred from\n        the input array.\n\n    Returns\n    -------\n    out: TypedArray|Array\n        Output array.\n\n    Examples\n    --------\n    > var x = new Float64Array( 2 );\n    > var y = afullLike( x, 1.0 )\n    <Float64Array>[ 1.0, 1.0 ]\n    > y = afullLike( x, 1.0, 'float32' )\n    <Float32Array>[ 1.0, 1.0 ]\n\n    See Also\n    --------\n    afull, aonesLike, azerosLike\n","alias2pkg":"\nalias2pkg( alias )\n    Returns the package name associated with a provided alias.\n\n    Parameters\n    ----------\n    alias: string\n        Alias.\n\n    Returns\n    -------\n    out: string|null\n        Package name.\n\n    Examples\n    --------\n    > var v = alias2pkg( 'base.sin' )\n    '@stdlib/math/base/special/sin'\n\n    See Also\n    --------\n    alias2related, aliases, pkg2alias\n","alias2related":"\nalias2related( alias )\n    Returns aliases related to a specified alias.\n\n    Parameters\n    ----------\n    alias: string\n        Alias.\n\n    Returns\n    -------\n    out: Array|null\n        Related aliases.\n\n    Examples\n    --------\n    > var v = alias2related( 'base.sin' )\n    [...]\n\n    See Also\n    --------\n    alias2pkg, aliases, pkg2related\n","alias2standalone":"\nalias2standalone( alias )\n    Returns the standalone package name associated with a provided alias.\n\n    Parameters\n    ----------\n    alias: string\n        Alias.\n\n    Returns\n    -------\n    out: string|null\n        Standalone package name.\n\n    Examples\n    --------\n    > var v = alias2standalone( 'base.sin' )\n    '@stdlib/math-base-special-sin'\n\n    See Also\n    --------\n    alias2pkg, alias2related, aliases, pkg2alias, pkg2standalone\n","aliases":"\naliases( [namespace] )\n    Returns a list of standard library aliases.\n\n    Parameters\n    ----------\n    namespace: string (optional)\n        Namespace filter.\n\n    Returns\n    -------\n    out: Array\n        List of aliases.\n\n    Examples\n    --------\n    > var o = aliases()\n    [...]\n    > o = aliases( '@stdlib/math/base/special' )\n    [...]\n\n    See Also\n    --------\n    alias2pkg, alias2related, pkg2alias\n","allocUnsafe":"\nallocUnsafe( size )\n    Allocates a buffer having a specified number of bytes.\n\n    The underlying memory of returned buffers is not initialized. Memory\n    contents are unknown and may contain sensitive data.\n\n    When the size is less than half a buffer pool size, memory is allocated from\n    the buffer pool for faster allocation of Buffer instances.\n\n    Parameters\n    ----------\n    size: integer\n        Number of bytes to allocate.\n\n    Returns\n    -------\n    out: Buffer\n        Buffer instance.\n\n    Examples\n    --------\n    > var buf = allocUnsafe( 100 )\n    <Buffer>\n\n    See Also\n    --------\n    Buffer, array2buffer, arraybuffer2buffer, copyBuffer, string2buffer\n","amskfilter":"\namskfilter( x, mask )\n    Returns a new array by applying a mask to a provided input array.\n\n    If a mask array element is truthy, the corresponding element in `x` is\n    included in the output array; otherwise, the corresponding element in `x` is\n    \"masked\" and thus excluded from the output array.\n\n    Parameters\n    ----------\n    x: Array|TypedArray|Object\n        Input array.\n\n    mask: Array|TypedArray|Object\n        Mask array.\n\n    Returns\n    -------\n    out: Array|TypedArray|Object\n        Output array.\n\n    Examples\n    --------\n    > var x = [ 1, 2, 3, 4 ];\n    > var y = amskfilter( x, [ 0, 1, 0, 1 ] )\n    [ 2, 4 ]\n\n    See Also\n    --------\n    amskreject\n","amskput":"\namskput( x, mask, values[, options] )\n    Replaces elements of an array with provided values according to a provided\n    mask array.\n\n    In broadcasting modes, the function supports broadcasting a values array\n    containing a single element against the number of falsy values in the mask\n    array.\n\n    In repeat mode, the function supports recycling elements in a values array\n    to satisfy the number of falsy values in the mask array.\n\n    The function mutates the input array.\n\n    Parameters\n    ----------\n    x: ArrayLikeObject\n        Input array.\n\n    mask: ArrayLikeObject\n        Mask array. If a mask array element is falsy, the corresponding element\n        in `x` is *replaced*; otherwise, the corresponding element in `x` is\n        \"masked\" and thus left unchanged.\n\n    values: ArrayLikeObject\n        Values to set.\n\n    options: Object (optional)\n        Function options.\n\n    options.mode: string (optional)\n        String specifying behavior when the number of values to set does not\n        equal the number of falsy mask values. The function supports the\n        following modes:\n\n        - 'strict': specifies that the function must raise an exception when the\n        number of values does not *exactly* equal the number of falsy mask\n        values.\n        - 'non_strict': specifies that the function must raise an exception when\n        the function is provided insufficient values to satisfy the mask array.\n        - 'strict_broadcast': specifies that the function must broadcast a\n        single-element values array and otherwise raise an exception when the\n        number of values does not **exactly** equal the number of falsy mask\n        values.\n        - 'broadcast': specifies that the function must broadcast a single-\n        element values array and otherwise raise an exception when the function\n        is provided insufficient values to satisfy the mask array.\n        - 'repeat': specifies that the function must reuse provided values when\n        replacing elements in `x` in order to satisfy the mask array.\n\n        Default: 'repeat'.\n\n    Returns\n    -------\n    out: ArrayLikeObject\n        Input array.\n\n    Examples\n    --------\n    > var x = [ 1, 2, 3, 4 ];\n    > var out = amskput( x, [ 1, 0, 1, 0 ], [ 20, 40 ] )\n    [ 1, 20, 3, 40 ]\n    > var bool = ( out === x )\n    true\n\n    See Also\n    --------\n    aplace, aput, atake\n","amskreject":"\namskreject( x, mask )\n    Returns a new array by applying a mask to a provided input array.\n\n    If a mask array element is falsy, the corresponding element in `x` is\n    included in the output array; otherwise, the corresponding element in `x` is\n    \"masked\" and thus excluded from the output array.\n\n    Parameters\n    ----------\n    x: Array|TypedArray|Object\n        Input array.\n\n    mask: Array|TypedArray|Object\n        Mask array.\n\n    Returns\n    -------\n    out: Array|TypedArray|Object\n        Output array.\n\n    Examples\n    --------\n    > var x = [ 1, 2, 3, 4 ];\n    > var y = amskreject( x, [ 0, 1, 0, 1 ] )\n    [ 1, 3 ]\n\n    See Also\n    --------\n    amskfilter\n","anans":"\nanans( length[, dtype] )\n    Returns an array filled with NaNs and having a specified length.\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    - generic: generic JavaScript values\n\n    The default array data type is `float64`.\n\n    Parameters\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 = anans( 2 )\n    <Float64Array>[ NaN, NaN ]\n    > arr = anans( 2, 'float32' )\n    <Float32Array>[ NaN, NaN ]\n\n    See Also\n    --------\n    afull, anansLike, aones, azeros\n","anansLike":"\nanansLike( x[, dtype] )\n    Returns an array filled with NaNs and having the same length and data type\n    as a provided input 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    - generic: generic JavaScript values\n\n    Parameters\n    ----------\n    x: TypedArray|Array\n        Input array.\n\n    dtype: string (optional)\n        Data type. If not provided, the output array data type is inferred from\n        the input array.\n\n    Returns\n    -------\n    out: TypedArray|Array\n        Output array.\n\n    Examples\n    --------\n    > var x = new Float64Array( 2 );\n    > var y = anansLike( x )\n    <Float64Array>[ NaN, NaN ]\n    > y = anansLike( x, 'float32' )\n    <Float32Array>[ NaN, NaN ]\n\n    See Also\n    --------\n    afullLike, anans, aonesLike, azerosLike\n","anova1":"\nanova1( x, factor[, options] )\n    Performs a one-way analysis of variance.\n\n    Parameters\n    ----------\n    x: Array<number>\n        Measured values.\n\n    factor: Array\n        Array of treatments.\n\n    options: Object (optional)\n        Options.\n\n    options.alpha: number (optional)\n        Number in the interval `[0,1]` giving the significance level of the\n        hypothesis test. Default: `0.05`.\n\n    Returns\n    -------\n    out: Object\n        Test result object.\n\n    out.alpha: number\n        Significance level.\n\n    out.rejected: boolean\n        Test decision.\n\n    out.pValue: number\n        p-value of the test.\n\n    out.statistic: number\n        Value of test statistic.\n\n    out.method: string\n        Name of test.\n\n    out.means: Object\n        Group means alongside sample sizes and standard errors.\n\n    out.treatment: Object\n        Treatment results.\n\n    out.treatment.df: number\n        Treatment degrees of freedom.\n\n    out.treatment.ss: number\n        Treatment sum of squares.\n\n    out.treatment.ms: number\n        Treatment mean sum of squares.\n\n    out.error: Object\n        Error results.\n\n    out.error.df: number\n        Error degrees of freedom.\n\n    out.error.ss: number\n        Error sum of squares.\n\n    out.error.ms: number\n        Error mean sum of squares.\n\n    out.print: Function\n        Function to print formatted output.\n\n    Examples\n    --------\n    > var x = [1, 3, 5, 2, 4, 6, 8, 7, 10, 11, 12, 15];\n    > var f = [\n    ... 'control', 'treatA', 'treatB', 'treatC', 'control',\n    ... 'treatA', 'treatB', 'treatC', 'control', 'treatA', 'treatB', 'treatC'\n    ... ];\n    > var out = anova1( x, f )\n    {...}\n\n","ANSCOMBES_QUARTET":"\nANSCOMBES_QUARTET()\n    Returns Anscombe's quartet.\n\n    Anscombe's quartet is a set of 4 datasets which all have nearly identical\n    simple statistical properties but vary considerably when graphed. Anscombe\n    created the datasets to demonstrate why graphical data exploration should\n    precede statistical data analysis and to show the effect of outliers on\n    statistical properties.\n\n    Returns\n    -------\n    out: Array<Array>\n        Anscombe's quartet.\n\n    Examples\n    --------\n    > var d = ANSCOMBES_QUARTET()\n    [[[10,8.04],...],[[10,9.14],...],[[10,7.46],...],[[8,6.58],...]]\n\n    References\n    ----------\n    - Anscombe, Francis J. 1973. \"Graphs in Statistical Analysis.\" *The American\n    Statistician* 27 (1). [American Statistical Association, Taylor & Francis,\n    Ltd.]: 17–21. <http://www.jstor.org/stable/2682899>.\n\n","any":"\nany( collection )\n    Tests whether at least one element in a collection is truthy.\n\n    The function immediately returns upon encountering a truthy value.\n\n    If provided an empty collection, the function returns `false`.\n\n    Parameters\n    ----------\n    collection: Array|TypedArray|Object\n        Input collection over which to iterate. If provided an object, the\n        object must be array-like (excluding strings and functions).\n\n    Returns\n    -------\n    bool: boolean\n        The function returns `true` if an element is truthy; otherwise, the\n        function returns `false`.\n\n    Examples\n    --------\n    > var arr = [ 0, 0, 0, 0, 1 ];\n    > var bool = any( arr )\n    true\n\n    See Also\n    --------\n    anyBy, every, forEach, none, some\n","anyBy":"\nanyBy( collection, predicate[, thisArg ] )\n    Tests whether at least one element in a collection passes a test implemented\n    by a predicate function.\n\n    The predicate function is provided three arguments:\n\n    - `value`: collection value\n    - `index`: collection index\n    - `collection`: the input collection\n\n    The function immediately returns upon encountering a truthy return value.\n\n    If provided an empty collection, the function returns `false`.\n\n    Parameters\n    ----------\n    collection: Array|TypedArray|Object\n        Input collection over which to iterate. If provided an object, the\n        object must be array-like (excluding strings and functions).\n\n    predicate: Function\n        The test function.\n\n    thisArg: any (optional)\n        Execution context.\n\n    Returns\n    -------\n    bool: boolean\n        The function returns `true` if the predicate function returns `true` for\n        any element; otherwise, the function returns `false`.\n\n    Examples\n    --------\n    > function negative( v ) { return ( v < 0 ); };\n    > var arr = [ 1, 2, 3, 4, -1 ];\n    > var bool = anyBy( arr, negative )\n    true\n\n    See Also\n    --------\n    anyByAsync, anyByRight, everyBy, forEach, noneBy, someBy\n","anyByAsync":"\nanyByAsync( collection, [options,] predicate, done )\n    Tests whether at least one element in a collection passes a test implemented\n    by a predicate function.\n\n    When invoked, the predicate function is provided a maximum of four\n    arguments:\n\n    - `value`: collection value\n    - `index`: collection index\n    - `collection`: the input collection\n    - `next`: a callback to be invoked after processing a collection `value`\n\n    The actual number of provided arguments depends on function length. If the\n    predicate function accepts two arguments, the predicate function is\n    provided:\n\n    - `value`\n    - `next`\n\n    If the predicate function accepts three arguments, the predicate function is\n    provided:\n\n    - `value`\n    - `index`\n    - `next`\n\n    For every other predicate function signature, the predicate function is\n    provided all four arguments.\n\n    The `next` callback takes two arguments:\n\n    - `error`: error argument\n    - `result`: test result\n\n    If a provided function calls the `next` callback with a truthy `error`\n    argument, the function suspends execution and immediately calls the `done`\n    callback for subsequent `error` handling.\n\n    The function immediately returns upon encountering a non-falsy `result`\n    value and calls the `done` callback with `null` as the first argument and\n    `true` as the second argument.\n\n    If all elements fail, the function calls the `done` callback with `null`\n    as the first argument and `false` as the second argument.\n\n    Execution is *not* guaranteed to be asynchronous. To guarantee asynchrony,\n    wrap the `done` callback in a function which either executes at the end of\n    the current stack (e.g., `nextTick`) or during a subsequent turn of the\n    event loop (e.g., `setImmediate`, `setTimeout`).\n\n    The function does not support dynamic collection resizing.\n\n    The function does not skip `undefined` elements.\n\n    Parameters\n    ----------\n    collection: Array|TypedArray|Object\n        Input collection over which to iterate. If provided an object, the\n        object must be array-like (excluding strings and functions).\n\n    options: Object (optional)\n        Function options.\n\n    options.limit: integer (optional)\n        Maximum number of pending invocations. Default: Infinity.\n\n    options.series: boolean (optional)\n        Boolean indicating whether to process each collection element\n        sequentially. Default: false.\n\n    options.thisArg: any (optional)\n        Execution context.\n\n    predicate: Function\n        The test function to invoke for each element in a collection.\n\n    done: Function\n        A callback invoked either upon processing all collection elements or\n        upon encountering an error.\n\n    Examples\n    --------\n    // Basic usage:\n    > function predicate( value, next ) {\n    ...     setTimeout( onTimeout, value );\n    ...     function onTimeout() {\n    ...         console.log( value );\n    ...         next( null, false );\n    ...     }\n    ... };\n    > function done( error, bool ) {\n    ...     if ( error ) {\n    ...         throw error;\n    ...     }\n    ...     console.log( bool );\n    ... };\n    > var arr = [ 3000, 2500, 1000 ];\n    > anyByAsync( arr, predicate, done )\n    1000\n    2500\n    3000\n    false\n\n    // Limit number of concurrent invocations:\n    > function predicate( value, next ) {\n    ...     setTimeout( onTimeout, value );\n    ...     function onTimeout() {\n    ...         console.log( value );\n    ...         next( null, false );\n    ...     }\n    ... };\n    > function done( error, bool ) {\n    ...     if ( error ) {\n    ...         throw error;\n    ...     }\n    ...     console.log( bool );\n    ... };\n    > var opts = { 'limit': 2 };\n    > var arr = [ 3000, 2500, 1000 ];\n    > anyByAsync( arr, opts, predicate, done )\n    2500\n    3000\n    1000\n    false\n\n    // Process sequentially:\n    > function predicate( value, next ) {\n    ...     setTimeout( onTimeout, value );\n    ...     function onTimeout() {\n    ...         console.log( value );\n    ...         next( null, false );\n    ...     }\n    ... };\n    > function done( error, bool ) {\n    ...     if ( error ) {\n    ...         throw error;\n    ...     }\n    ...     console.log( bool );\n    ... };\n    > var opts = { 'series': true };\n    > var arr = [ 3000, 2500, 1000 ];\n    > anyByAsync( arr, opts, predicate, done )\n    3000\n    2500\n    1000\n    false\n\n\nanyByAsync.factory( [options,] predicate )\n    Returns a function which tests whether at least one element in a collection\n    passes a test implemented by a predicate function.\n\n    Parameters\n    ----------\n    options: Object (optional)\n        Function options.\n\n    options.limit: integer (optional)\n        Maximum number of pending invocations. Default: Infinity.\n\n    options.series: boolean (optional)\n        Boolean indicating whether to process each collection element\n        sequentially. Default: false.\n\n    options.thisArg: any (optional)\n        Execution context.\n\n    predicate: Function\n        The test function to invoke for each element in a collection.\n\n    Returns\n    -------\n    out: Function\n        A function which tests each element in a collection.\n\n    Examples\n    --------\n    > function predicate( value, next ) {\n    ...     setTimeout( onTimeout, value );\n    ...     function onTimeout() {\n    ...         console.log( value );\n    ...         next( null, false );\n    ...     }\n    ... };\n    > var opts = { 'series': true };\n    > var f = anyByAsync.factory( opts, predicate );\n    > function done( error, bool ) {\n    ...     if ( error ) {\n    ...         throw error;\n    ...     }\n    ...     console.log( bool );\n    ... };\n    > var arr = [ 3000, 2500, 1000 ];\n    > f( arr, done )\n    3000\n    2500\n    1000\n    false\n    > arr = [ 2000, 1500, 1000 ];\n    > f( arr, done )\n    2000\n    1500\n    1000\n    false\n\n    See Also\n    --------\n    anyBy, anyByRightAsync, everyByAsync, forEachAsync, noneByAsync, someByAsync\n","anyByAsync.factory":"\nanyByAsync.factory( [options,] predicate )\n    Returns a function which tests whether at least one element in a collection\n    passes a test implemented by a predicate function.\n\n    Parameters\n    ----------\n    options: Object (optional)\n        Function options.\n\n    options.limit: integer (optional)\n        Maximum number of pending invocations. Default: Infinity.\n\n    options.series: boolean (optional)\n        Boolean indicating whether to process each collection element\n        sequentially. Default: false.\n\n    options.thisArg: any (optional)\n        Execution context.\n\n    predicate: Function\n        The test function to invoke for each element in a collection.\n\n    Returns\n    -------\n    out: Function\n        A function which tests each element in a collection.\n\n    Examples\n    --------\n    > function predicate( value, next ) {\n    ...     setTimeout( onTimeout, value );\n    ...     function onTimeout() {\n    ...         console.log( value );\n    ...         next( null, false );\n    ...     }\n    ... };\n    > var opts = { 'series': true };\n    > var f = anyByAsync.factory( opts, predicate );\n    > function done( error, bool ) {\n    ...     if ( error ) {\n    ...         throw error;\n    ...     }\n    ...     console.log( bool );\n    ... };\n    > var arr = [ 3000, 2500, 1000 ];\n    > f( arr, done )\n    3000\n    2500\n    1000\n    false\n    > arr = [ 2000, 1500, 1000 ];\n    > f( arr, done )\n    2000\n    1500\n    1000\n    false\n\n    See Also\n    --------\n    anyBy, anyByRightAsync, everyByAsync, forEachAsync, noneByAsync, someByAsync","anyByRight":"\nanyByRight( collection, predicate[, thisArg ] )\n    Tests whether at least one element in a collection passes a test implemented\n    by a predicate function, iterating from right to left.\n\n    The predicate function is provided three arguments:\n\n    - `value`: collection value\n    - `index`: collection index\n    - `collection`: the input collection\n\n    The function immediately returns upon encountering a truthy return value.\n\n    If provided an empty collection, the function returns `false`.\n\n    Parameters\n    ----------\n    collection: Array|TypedArray|Object\n        Input collection over which to iterate. If provided an object, the\n        object must be array-like (excluding strings and functions).\n\n    predicate: Function\n        The test function.\n\n    thisArg: any (optional)\n        Execution context.\n\n    Returns\n    -------\n    bool: boolean\n        The function returns `true` if the predicate function returns `true` for\n        any element; otherwise, the function returns `false`.\n\n    Examples\n    --------\n    > function negative( v ) { return ( v < 0 ); };\n    > var arr = [ -1, 1, 2, 3, 4 ];\n    > var bool = anyByRight( arr, negative )\n    true\n\n    See Also\n    --------\n    anyBy, anyByRightAsync, everyByRight, forEachRight, noneByRight, someByRight\n","anyByRightAsync":"\nanyByRightAsync( collection, [options,] predicate, done )\n    Tests whether at least one element in a collection passes a test implemented\n    by a predicate function, iterating from right to left.\n\n    When invoked, the predicate function is provided a maximum of four\n    arguments:\n\n    - `value`: collection value\n    - `index`: collection index\n    - `collection`: the input collection\n    - `next`: a callback to be invoked after processing a collection `value`\n\n    The actual number of provided arguments depends on function length. If the\n    predicate function accepts two arguments, the predicate function is\n    provided:\n\n    - `value`\n    - `next`\n\n    If the predicate function accepts three arguments, the predicate function is\n    provided:\n\n    - `value`\n    - `index`\n    - `next`\n\n    For every other predicate function signature, the predicate function is\n    provided all four arguments.\n\n    The `next` callback takes two arguments:\n\n    - `error`: error argument\n    - `result`: test result\n\n    If a provided function calls the `next` callback with a truthy `error`\n    argument, the function suspends execution and immediately calls the `done`\n    callback for subsequent `error` handling.\n\n    The function immediately returns upon encountering a non-falsy `result`\n    value and calls the `done` callback with `null` as the first argument and\n    `true` as the second argument.\n\n    If all elements fail, the function calls the `done` callback with `null`\n    as the first argument and `false` as the second argument.\n\n    Execution is *not* guaranteed to be asynchronous. To guarantee asynchrony,\n    wrap the `done` callback in a function which either executes at the end of\n    the current stack (e.g., `nextTick`) or during a subsequent turn of the\n    event loop (e.g., `setImmediate`, `setTimeout`).\n\n    The function does not support dynamic collection resizing.\n\n    The function does not skip `undefined` elements.\n\n    Parameters\n    ----------\n    collection: Array|TypedArray|Object\n        Input collection over which to iterate. If provided an object, the\n        object must be array-like (excluding strings and functions).\n\n    options: Object (optional)\n        Function options.\n\n    options.limit: integer (optional)\n        Maximum number of pending invocations. Default: Infinity.\n\n    options.series: boolean (optional)\n        Boolean indicating whether to process each collection element\n        sequentially. Default: false.\n\n    options.thisArg: any (optional)\n        Execution context.\n\n    predicate: Function\n        The test function to invoke for each element in a collection.\n\n    done: Function\n        A callback invoked either upon processing all collection elements or\n        upon encountering an error.\n\n    Examples\n    --------\n    // Basic usage:\n    > function predicate( value, next ) {\n    ...     setTimeout( onTimeout, value );\n    ...     function onTimeout() {\n    ...         console.log( value );\n    ...         next( null, false );\n    ...     }\n    ... };\n    > function done( error, bool ) {\n    ...     if ( error ) {\n    ...         throw error;\n    ...     }\n    ...     console.log( bool );\n    ... };\n    > var arr = [ 1000, 2500, 3000 ];\n    > anyByRightAsync( arr, predicate, done )\n    1000\n    2500\n    3000\n    false\n\n    // Limit number of concurrent invocations:\n    > function predicate( value, next ) {\n    ...     setTimeout( onTimeout, value );\n    ...     function onTimeout() {\n    ...         console.log( value );\n    ...         next( null, false );\n    ...     }\n    ... };\n    > function done( error, bool ) {\n    ...     if ( error ) {\n    ...         throw error;\n    ...     }\n    ...     console.log( bool );\n    ... };\n    > var opts = { 'limit': 2 };\n    > var arr = [ 1000, 2500, 3000 ];\n    > anyByRightAsync( arr, opts, predicate, done )\n    2500\n    3000\n    1000\n    false\n\n    // Process sequentially:\n    > function predicate( value, next ) {\n    ...     setTimeout( onTimeout, value );\n    ...     function onTimeout() {\n    ...         console.log( value );\n    ...         next( null, false );\n    ...     }\n    ... };\n    > function done( error, bool ) {\n    ...     if ( error ) {\n    ...         throw error;\n    ...     }\n    ...     console.log( bool );\n    ... };\n    > var opts = { 'series': true };\n    > var arr = [ 1000, 2500, 3000 ];\n    > anyByRightAsync( arr, opts, predicate, done )\n    3000\n    2500\n    1000\n    false\n\n\nanyByRightAsync.factory( [options,] predicate )\n    Returns a function which tests whether at least one element in a collection\n    passes a test implemented by a predicate function, iterating from right to\n    left.\n\n    Parameters\n    ----------\n    options: Object (optional)\n        Function options.\n\n    options.limit: integer (optional)\n        Maximum number of pending invocations. Default: Infinity.\n\n    options.series: boolean (optional)\n        Boolean indicating whether to process each collection element\n        sequentially. Default: false.\n\n    options.thisArg: any (optional)\n        Execution context.\n\n    predicate: Function\n        The test function to invoke for each element in a collection.\n\n    Returns\n    -------\n    out: Function\n        A function which tests each element in a collection.\n\n    Examples\n    --------\n    > function predicate( value, next ) {\n    ...     setTimeout( onTimeout, value );\n    ...     function onTimeout() {\n    ...         console.log( value );\n    ...         next( null, false );\n    ...     }\n    ... };\n    > var opts = { 'series': true };\n    > var f = anyByRightAsync.factory( opts, predicate );\n    > function done( error, bool ) {\n    ...     if ( error ) {\n    ...         throw error;\n    ...     }\n    ...     console.log( bool );\n    ... };\n    > var arr = [ 1000, 2500, 3000 ];\n    > f( arr, done )\n    3000\n    2500\n    1000\n    false\n    > arr = [ 1000, 1500, 2000 ];\n    > f( arr, done )\n    2000\n    1500\n    1000\n    false\n\n    See Also\n    --------\n    anyByAsync, anyByRight, everyByRightAsync, forEachRightAsync, noneByRightAsync, someByRightAsync\n","anyByRightAsync.factory":"\nanyByRightAsync.factory( [options,] predicate )\n    Returns a function which tests whether at least one element in a collection\n    passes a test implemented by a predicate function, iterating from right to\n    left.\n\n    Parameters\n    ----------\n    options: Object (optional)\n        Function options.\n\n    options.limit: integer (optional)\n        Maximum number of pending invocations. Default: Infinity.\n\n    options.series: boolean (optional)\n        Boolean indicating whether to process each collection element\n        sequentially. Default: false.\n\n    options.thisArg: any (optional)\n        Execution context.\n\n    predicate: Function\n        The test function to invoke for each element in a collection.\n\n    Returns\n    -------\n    out: Function\n        A function which tests each element in a collection.\n\n    Examples\n    --------\n    > function predicate( value, next ) {\n    ...     setTimeout( onTimeout, value );\n    ...     function onTimeout() {\n    ...         console.log( value );\n    ...         next( null, false );\n    ...     }\n    ... };\n    > var opts = { 'series': true };\n    > var f = anyByRightAsync.factory( opts, predicate );\n    > function done( error, bool ) {\n    ...     if ( error ) {\n    ...         throw error;\n    ...     }\n    ...     console.log( bool );\n    ... };\n    > var arr = [ 1000, 2500, 3000 ];\n    > f( arr, done )\n    3000\n    2500\n    1000\n    false\n    > arr = [ 1000, 1500, 2000 ];\n    > f( arr, done )\n    2000\n    1500\n    1000\n    false\n\n    See Also\n    --------\n    anyByAsync, anyByRight, everyByRightAsync, forEachRightAsync, noneByRightAsync, someByRightAsync","anyInBy":"anyInBy( object, predicate[, thisArg ] )\n    Tests whether at least one value in an object passes a test implemented by\n    a predicate function.\n\n    The predicate function is provided three arguments:\n\n    - `value`: the value of the current property being processed in the object\n    - `key`: the key of the current property being processed in the object\n    - `object`: the input object\n\n    The function immediately returns upon encountering a truthy return value.\n\n    If provided an empty object, the function returns `false`.\n\n    Parameters\n    ----------\n    object: Object\n        Input object over which to iterate. It must be non-null.\n\n    predicate: Function\n        The test function.\n\n    thisArg: any (optional)\n        Execution context.\n\n    Returns\n    -------\n    bool: boolean\n        The function returns `true` if the predicate function returns `true` for\n        any value; otherwise, it returns `false`.\n\n    Examples\n    --------\n    > function isNegative(value) { return value < 0 }\n    > var obj = { a: 1, b: -2, c: 3, d: 4 }\n    > var result = anyInBy(obj, isNegative)\n    true\n\n    See Also\n    --------\n    anyBy, anyOwnBy, everyInBy, someInBy","anyOwnBy":"anyOwnBy( object, predicate[, thisArg ] )\n    Tests whether at least one own property of an object passes a \n    test implemented by a predicate function.\n\n    The predicate function is provided three arguments:\n\n    - `value`: property value\n    - `index`: property key\n    - `object`: the input object\n\n    The function immediately returns upon encountering a truthy return\n    value.\n\n    If provided an empty object, the function returns `false`.\n\n    Parameters\n    ----------\n    object: Object\n        Input object.\n\n    predicate: Function\n        Test function.\n\n    thisArg: any (optional)\n        Execution context.\n\n    Returns\n    -------\n    bool: boolean\n        The function returns `true` if the predicate function returns a truthy\n        value for one own property; otherwise, the function returns `false`.\n\n    Examples\n    --------\n    > function positive( v ) { return ( v > 0 ); };\n    > var obj = { 'a': -1, 'b': 2, 'c': -3 };\n    > var bool = anyOwnBy( obj, positive )\n    true\n\n    See Also\n    --------\n    anyBy, anyInBy, everyOwnBy, someOwnBy\n","aones":"\naones( length[, dtype] )\n    Returns an array filled with ones and having a specified length.\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    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 = aones( 2 )\n    <Float64Array>[ 1.0, 1.0 ]\n    > arr = aones( 2, 'float32' )\n    <Float32Array>[ 1.0, 1.0 ]\n\n    See Also\n    --------\n    afull, anans, aonesLike, azeros\n","aonesLike":"\naonesLike( x[, dtype] )\n    Returns an array filled with ones and having the same length and data type\n    as a provided input 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    Parameters\n    ----------\n    x: TypedArray|Array\n        Input array.\n\n    dtype: string (optional)\n        Data type. If not provided, the output array data type is inferred from\n        the input array.\n\n    Returns\n    -------\n    out: TypedArray|Array\n        Output array.\n\n    Examples\n    --------\n    > var x = new Float64Array( 2 );\n    > var y = aonesLike( x )\n    <Float64Array>[ 1.0, 1.0 ]\n    > y = aonesLike( x, 'float32' )\n    <Float32Array>[ 1.0, 1.0 ]\n\n    See Also\n    --------\n    afullLike, anansLike, aones, azerosLike\n","aoneTo":"\naoneTo( n[, dtype] )\n    Generates a linearly spaced numeric array whose elements increment by 1\n    starting from one.\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    If `n` is equal to zero, the function returns an empty array.\n\n    Parameters\n    ----------\n    n: integer\n        Number of elements.\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 = aoneTo( 2 )\n    <Float64Array>[ 1.0, 2.0 ]\n    > arr = aoneTo( 2, 'float32' )\n    <Float32Array>[ 1.0, 2.0 ]\n\n    See Also\n    --------\n    afull, aones, aoneToLike, azeroTo\n","aoneToLike":"\naoneToLike( x[, dtype] )\n    Generates a linearly spaced numeric array whose elements increment by 1\n    starting from one and having the same length and data type as a provided\n    input 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 num