Auto-generated commit

data/data.csv

@@ -3696,6 +3696,7 @@ ndarrayPromotionRules,"\nndarrayPromotionRules( [dtype1, dtype2] )\n    Returns
 ndarraySafeCasts,"\nndarraySafeCasts( [dtype] )\n    Returns a list of ndarray data types to which a provided ndarray data type\n    can be safely cast.\n\n    If not provided an ndarray data type, the function returns a casting table.\n\n    If provided an unrecognized ndarray data type, the function returns `null`.\n\n    Parameters\n    ----------\n    dtype: any (optional)\n        ndarray data type value.\n\n    Returns\n    -------\n    out: Object|Array<string>|null\n        ndarray data types to which a data type can be safely cast.\n\n    Examples\n    --------\n    > var out = ndarraySafeCasts( 'float32' )\n    <Array>\n\n    See Also\n    --------\n    ndarrayCastingModes, ndarrayDataTypes, ndarraySameKindCasts\n"
 ndarraySameKindCasts,"\nndarraySameKindCasts( [dtype] )\n    Returns a list of ndarray data types to which a provided ndarray data type\n    can be safely cast or cast within the same \"kind\".\n\n    If not provided an ndarray data type, the function returns a casting table.\n\n    If provided an unrecognized ndarray data type, the function returns `null`.\n\n    Parameters\n    ----------\n    dtype: any (optional)\n        ndarray data type value.\n\n    Returns\n    -------\n    out: Object|Array<string>|null\n        ndarray data types to which a data type can be safely cast or cast\n        within the same \"kind\".\n\n    Examples\n    --------\n    > var out = ndarraySameKindCasts( 'float32' )\n    <Array>\n\n    See Also\n    --------\n    ndarrayCastingModes, ndarrayDataTypes, ndarraySafeCasts\n"
 ndarrayShape,"\nndarrayShape( x )\n    Returns the shape of a provided ndarray.\n\n    Parameters\n    ----------\n    x: ndarray\n        Input ndarray.\n\n    Returns\n    -------\n    out: Array<integer>\n        Shape.\n\n    Examples\n    --------\n    > var out = ndarrayShape( ndzeros( [ 3, 3, 3 ] ) )\n    [ 3, 3, 3 ]\n\n    See Also\n    --------\n    array, ndarray, ndarrayOffset, ndarrayStrides\n"
+ndarrayStride,"\nndarrayStride( x, dim )\n    Returns the stride along a specified dimension for a provided ndarray.\n\n    A \"stride\" is the linear distance (i.e., number of elements) between\n    adjacent elements along a specified dimension.\n\n    Parameters\n    ----------\n    x: ndarray\n        Input ndarray.\n\n    dim: integer\n        Dimension index. If less than zero, the index is resolved relative to\n        the last dimension, with the last dimension corresponding to the value\n        `-1`.\n\n    Returns\n    -------\n    out: integer\n        Stride.\n\n    Examples\n    --------\n    > var out = ndarrayStride( ndzeros( [ 3, 3, 3 ] ), 0 )\n    9\n\n    See Also\n    --------\n    array, ndarray, ndarrayOffset, ndarrayOrder, ndarrayShape, ndarrayStrides\n"
 ndarrayStrides,"\nndarrayStrides( x )\n    Returns the strides of a provided ndarray.\n\n    Parameters\n    ----------\n    x: ndarray\n        Input ndarray.\n\n    Returns\n    -------\n    out: Array<integer>\n        Strides.\n\n    Examples\n    --------\n    > var out = ndarrayStrides( ndzeros( [ 3, 3, 3 ] ) )\n    [ 9, 3, 1 ]\n\n    See Also\n    --------\n    array, ndarray, ndarrayOffset, ndarrayOrder, ndarrayShape\n"
 ndempty,"\nndempty( shape[, options] )\n    Returns an uninitialized ndarray having a specified shape and data type.\n\n    In browser environments, the function always returns zero-filled ndarrays.\n\n    If `dtype` is 'generic', the function always returns a zero-filled ndarray.\n\n    For returned ndarrays whose underlying memory is *not* initialized, memory\n    contents are unknown and may contain *sensitive* data.\n\n    Parameters\n    ----------\n    shape: ArrayLikeObject<integer>|integer\n        Array shape.\n\n    options: Object (optional)\n        Options.\n\n    options.dtype: string (optional)\n        Underlying data type. Default: 'float64'.\n\n    options.order: string (optional)\n        Specifies whether an array is row-major (C-style) or column-major\n        (Fortran-style). Default: 'row-major'.\n\n    options.mode: string (optional)\n        Specifies how to handle indices which exceed array dimensions. If equal\n        to 'throw', an ndarray instance throws an error when an index exceeds\n        array dimensions. If equal to 'normalize', an ndarray instance\n        normalizes negative indices and throws an error when an index exceeds\n        array dimensions. If equal to 'wrap', an ndarray instance wraps around\n        indices exceeding array dimensions using modulo arithmetic. If equal to\n        'clamp', an ndarray instance sets an index exceeding array dimensions\n        to either `0` (minimum index) or the maximum index. Default: 'throw'.\n\n    options.submode: Array<string> (optional)\n        Specifies how to handle subscripts which exceed array dimensions. If a\n        mode for a corresponding dimension is equal to 'throw', an ndarray\n        instance throws an error when a subscript exceeds array dimensions. If\n        equal to 'normalize', an ndarray instance normalizes negative\n        subscripts and throws an error when a subscript exceeds array\n        dimensions. If equal to 'wrap', an ndarray instance wraps around\n        subscripts exceeding array dimensions using modulo arithmetic. If equal\n        to 'clamp', an ndarray instance sets a subscript exceeding array\n        dimensions to either `0` (minimum index) or the maximum index. If the\n        number of modes is fewer than the number of dimensions, the function\n        recycles modes using modulo arithmetic. Default: [ options.mode ].\n\n    Returns\n    -------\n    out: ndarray\n        Output array.\n\n    Examples\n    --------\n    > var arr = ndempty( [ 2, 2 ] )\n    <ndarray>\n    > var sh = arr.shape\n    [ 2, 2 ]\n    > var dt = arr.dtype\n    'float64'\n\n    See Also\n    --------\n    ndemptyLike, ndzeros\n"
 ndemptyLike,"\nndemptyLike( x[, options] )\n    Returns an uninitialized ndarray having the same shape and data type as a\n    provided input ndarray.\n\n    The function infers the following attributes from the input array:\n\n    - shape: array shape.\n    - dtype: underlying array data type.\n    - order: whether the array order is row-major (C-style) or column-major\n      (Fortran-style).\n\n    In browser environments, the function always returns zero-filled ndarrays.\n\n    If `dtype` is 'generic', the function always returns a zero-filled ndarray.\n\n    For returned ndarrays whose underlying memory is *not* initialized, memory\n    contents are unknown and may contain *sensitive* data.\n\n    Parameters\n    ----------\n    x: ndarray\n        Input array.\n\n    options: Object (optional)\n        Options.\n\n    options.shape: ArrayLikeObject<integer>|integer (optional)\n        Array shape. Overrides the input array's inferred shape.\n\n    options.dtype: string (optional)\n        Array data type. Overrides the input array's inferred data type.\n\n    options.order: string (optional)\n        Array order (either 'row-major' (C-style) or 'column-major' (Fortran-\n        style)). Overrides the input array's inferred order.\n\n    options.mode: string (optional)\n        Specifies how to handle indices which exceed array dimensions. If equal\n        to 'throw', an ndarray instance throws an error when an index exceeds\n        array dimensions. If equal to 'normalize', an ndarray instance\n        normalizes negative indices and throws an error when an index exceeds\n        array dimensions. If equal to 'wrap', an ndarray instance wraps around\n        indices exceeding array dimensions using modulo arithmetic. If equal to\n        'clamp', an ndarray instance sets an index exceeding array dimensions\n        to either `0` (minimum index) or the maximum index. Default: 'throw'.\n\n    options.submode: Array<string> (optional)\n        Specifies how to handle subscripts which exceed array dimensions. If a\n        mode for a corresponding dimension is equal to 'throw', an ndarray\n        instance throws an error when a subscript exceeds array dimensions. If\n        equal to 'normalize', an ndarray instance normalizes negative\n        subscripts and throws an error when a subscript exceeds array\n        dimensions. If equal to 'wrap', an ndarray instance wraps around\n        subscripts exceeding array dimensions using modulo arithmetic. If equal\n        to 'clamp', an ndarray instance sets a subscript exceeding array\n        dimensions to either `0` (minimum index) or the maximum index. If the\n        number of modes is fewer than the number of dimensions, the function\n        recycles modes using modulo arithmetic. Default: [ options.mode ].\n\n    Returns\n    -------\n    out: ndarray\n        Output array.\n\n    Examples\n    --------\n    > var x = base.ndzeros( 'float64', [ 2, 2 ], 'row-major' )\n    <ndarray>\n    > var sh = x.shape\n    [ 2, 2 ]\n    > var dt = x.dtype\n    'float64'\n    > var y = ndemptyLike( x )\n    <ndarray>\n    > sh = y.shape\n    [ 2, 2 ]\n    > dt = y.dtype\n    'float64'\n\n    See Also\n    --------\n    ndempty, ndzerosLike\n"