Auto-generated commit

help/data/data.csv

@@ -2341,6 +2341,7 @@ binomialTest,"\nbinomialTest( x[, n][, options] )\n    Computes an exact test fo
 Boolean,"\nBoolean( value )\n    Returns a boolean.\n\n    When invoked without `new`,\n\n    - if provided `false`, `null`, `undefined`, `-0`, `0`, `NaN`, or an empty\n      string, the function returns `false`.\n    - if provided any other value, including an empty object, an empty array,\n      the string `'false'`, or a `Boolean` object (including a `Boolean` object\n      whose value is `false`), the function returns `true`.\n\n    When invoked with `new`, the constructor returns a `Boolean` object, which\n    is an object wrapper for a primitive boolean value. The value of the\n    returned `Boolean` object follows the same conversion semantics as when the\n    constructor is invoked without `new`.\n\n    Parameters\n    ----------\n    value: any\n        Input value.\n\n    Returns\n    -------\n    out: boolean|Boolean\n        Boolean primitive or object.\n\n    Examples\n    --------\n    > var b = new Boolean( null )\n    <Boolean>\n    > b = Boolean( null )\n    false\n    > b = Boolean( [] )\n    true\n\nBoolean.prototype.toString()\n    Returns a string representing the `Boolean` object.\n\n    Returns\n    -------\n    out: string\n        String representation.\n\n    Examples\n    --------\n    > var b = new Boolean( true )\n    <Boolean>\n    > b.toString()\n    'true'\n\nBoolean.prototype.valueOf()\n    Returns the primitive value of a `Boolean` object.\n\n    Returns\n    -------\n    out: boolean\n        Boolean primitive.\n\n    Examples\n    --------\n    > var b = new Boolean( true )\n    <Boolean>\n    > b.valueOf()\n    true\n\n"
 Boolean.prototype.toString,"\nBoolean.prototype.toString()\n    Returns a string representing the `Boolean` object.\n\n    Returns\n    -------\n    out: string\n        String representation.\n\n    Examples\n    --------\n    > var b = new Boolean( true )\n    <Boolean>\n    > b.toString()\n    'true'"
 Boolean.prototype.valueOf,"\nBoolean.prototype.valueOf()\n    Returns the primitive value of a `Boolean` object.\n\n    Returns\n    -------\n    out: boolean\n        Boolean primitive.\n\n    Examples\n    --------\n    > var b = new Boolean( true )\n    <Boolean>\n    > b.valueOf()\n    true"
+broadcastArray,"\nbroadcastArray( x, shape )\n    Broadcasts an ndarray to a specified shape.\n\n    The returned array is a read-only view on the input array data buffer. The\n    view is typically *not* contiguous. As more than one element of a returned\n    view may refer to the same memory location, writing to the input array may\n    affect multiple elements. If you need to write to the input array, copy the\n    input array before broadcasting.\n\n    The function throws an error if a provided ndarray is incompatible with a\n    provided shape.\n\n    The function always returns a new ndarray instance even if the input ndarray\n    shape and the desired shape are the same.\n\n    Parameters\n    ----------\n    x: ndarray\n        Input array.\n\n    shape: ArrayLikeObject\n        Desired shape.\n\n    Returns\n    -------\n    out: ndarray\n        Broadcasted array.\n\n    Examples\n    --------\n    > var x = array( [ [ 1, 2 ], [ 3, 4 ] ] )\n    <ndarray>\n    > var sh = x.shape\n    [ 2, 2 ]\n    > var y = broadcastArray( x, [ 3, 2, 2 ] )\n    <ndarray>\n    > sh = y.shape\n    [ 3, 2, 2 ]\n    > var v = y.get( 0, 0, 0 )\n    1\n    > v = y.get( 0, 0, 1 )\n    2\n    > v = y.get( 0, 1, 0 )\n    3\n    > v = y.get( 0, 1, 1 )\n    4\n    > v = y.get( 1, 0, 0 )\n    1\n    > v = y.get( 1, 1, 0 )\n    3\n    > v = y.get( 2, 0, 0 )\n    1\n    > v = y.get( 2, 1, 1 )\n    4\n\n    See Also\n    --------\n    array, ndarray\n"
 Buffer,"\nBuffer\n    Buffer constructor.\n\n\nBuffer( size )\n    Allocates a buffer having a specified number of bytes.\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 b = new Buffer( 4 )\n    <Buffer>\n\n\nBuffer( buffer )\n    Copies buffer data to a new Buffer instance.\n\n    Parameters\n    ----------\n    buffer: Buffer\n        Buffer to copy from.\n\n    Returns\n    -------\n    out: Buffer\n        Buffer instance.\n\n    Examples\n    --------\n    > var b1 = new Buffer( [ 1, 2, 3, 4 ] );\n    > var b2 = new Buffer( b1 )\n    <Buffer>[ 1, 2, 3, 4 ]\n\n\nBuffer( array )\n    Allocates a buffer using an array of octets.\n\n    Parameters\n    ----------\n    array: Array\n        Array of octets.\n\n    Returns\n    -------\n    out: Buffer\n        Buffer instance.\n\n    Examples\n    --------\n    > var b = new Buffer( [ 1, 2, 3, 4 ] )\n    <Buffer>[ 1, 2, 3, 4 ]\n\n\nBuffer( str[, encoding] )\n    Allocates a buffer containing a provided string.\n\n    Parameters\n    ----------\n    str: string\n        Input string.\n\n    encoding: string (optional)\n        Character encoding. Default: 'utf8'.\n\n    Returns\n    -------\n    out: Buffer\n        Buffer instance.\n\n    Examples\n    --------\n    > var b = new Buffer( 'beep boop' )\n    <Buffer>\n\n\nTODO: add methods and properties\n\n\n    See Also\n    --------\n    ArrayBuffer\n"
 buffer2json,"\nbuffer2json( buffer )\n    Returns a JSON representation of a buffer.\n\n    Parameters\n    ----------\n    buffer: Buffer\n        Buffer to serialize.\n\n    Returns\n    -------\n    out: Object\n        JSON representation.\n\n    out.type: string\n        Value type. The assigned value is always \"Buffer\".\n\n    out.data: Array\n        Buffer data.\n\n    Examples\n    --------\n    > var buf = new allocUnsafe( 2 );\n    > buf[ 0 ] = 1;\n    > buf[ 1 ] = 2;\n    > var json = buffer2json( buf )\n    { 'type': 'Buffer', 'data': [ 1, 2 ] }\n\n    See Also\n    --------\n    typedarray2json, reviveBuffer\n"
 BYTE_ORDER,"\nBYTE_ORDER\n    Platform byte order.\n\n    Possible values:\n\n    - 'little-endian'\n    - 'big-endian'\n    - 'mixed-endian'\n    - 'unknown'\n\n    Examples\n    --------\n    > BYTE_ORDER\n    <string>\n\n    See Also\n    --------\n    IS_BIG_ENDIAN, IS_LITTLE_ENDIAN\n"