Auto-generated commit

code-blocks/data/data.csv

@@ -3693,6 +3693,7 @@ ndarrayDataBuffer,"var opts = { 'dtype': 'float64' };\nvar out = ndarrayDataBuff
 ndarrayDataType,"var opts = { 'dtype': 'float64' };\nvar dt = ndarrayDataType( ndzeros( [ 3, 3, 3 ], opts ) )\n"
 ndarrayDataTypes,"var out = ndarrayDataTypes()\nout = ndarrayDataTypes( 'floating_point' )\n"
 ndarrayDispatch,"var t = [ 'float64', 'float64', 'float32', 'float32' ];\nvar d = [ base.abs, base.absf ];\nvar f = ndarrayDispatch( base.ndarrayUnary, t, d, 2, 1, 1 );\nvar xbuf = new Float64Array( [ -1.0, -2.0, -3.0, -4.0 ] );\nvar x = ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );\nvar ybuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );\nvar y = ndarray( 'float64', ybuf, [ 4 ], [ 1 ], 0, 'row-major' );\nf( x, y );\nybuf\n"
+ndarrayFlags,"var out = ndarrayFlags( ndzeros( [ 3, 3, 3 ] ) )\n"
 ndarrayIndexModes,"var out = ndarrayIndexModes()\n"
 ndarrayMinDataType,"var dt = ndarrayMinDataType( 3.141592653589793 )\ndt = ndarrayMinDataType( 3 )\ndt = ndarrayMinDataType( -3 )\ndt = ndarrayMinDataType( '-3' )\n"
 ndarrayMostlySafeCasts,"var out = ndarrayMostlySafeCasts( 'float32' )\n"

help/data/data.csv

@@ -3693,6 +3693,7 @@ ndarrayDataBuffer,"\nndarrayDataBuffer( x )\n    Returns the underlying data buf
 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    When not provided a data type \"kind\", the function returns an array\n    containing the following data types:\n\n    - binary: binary.\n    - complex64: single-precision complex floating-point numbers.\n    - complex128: double-precision complex floating-point numbers.\n    - float32: single-precision floating-point numbers.\n    - float64: double-precision floating-point numbers.\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    - 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    - 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\n"
 ndarrayIndexModes,"\nndarrayIndexModes()\n    Returns a list of ndarray index modes.\n\n    The output array contains the following modes:\n\n    - throw: specifies that a function should throw an error when an index is\n    outside a restricted interval.\n    - normalize: specifies that a function should normalize negative indices and\n    throw an error when an index is outside a restricted interval.\n    - wrap: specifies that a function should wrap around an index using modulo\n    arithmetic.\n    - clamp: specifies that a function should set an index less than zero to\n    zero (minimum index) and set an index greater than a maximum index value to\n    the maximum possible index.\n\n    Returns\n    -------\n    out: Array<string>\n        List of ndarray index modes.\n\n    Examples\n    --------\n    > var out = ndarrayIndexModes()\n    [ 'throw', 'normalize', 'clamp', 'wrap' ]\n\n    See Also\n    --------\n    array, ndarray\n"
 ndarrayMinDataType,"\nndarrayMinDataType( value )\n    Returns the minimum ndarray 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        ndarray data type.\n\n    Examples\n    --------\n    > var dt = ndarrayMinDataType( 3.141592653589793 )\n    'float32'\n    > dt = ndarrayMinDataType( 3 )\n    'uint8'\n    > dt = ndarrayMinDataType( -3 )\n    'int8'\n    > dt = ndarrayMinDataType( '-3' )\n    'generic'\n\n    See Also\n    --------\n    ndarrayDataTypes, ndarrayPromotionRules, ndarraySafeCasts\n"

info/data/data.csv

@@ -3693,6 +3693,7 @@ ndarrayDataBuffer,"\nndarrayDataBuffer( x:ndarray )\n    Returns the underlying
 ndarrayDataType,"\nndarrayDataType( x:ndarray )\n    Returns the data type of a provided ndarray.\n"
 ndarrayDataTypes,"\nndarrayDataTypes( [kind:string] )\n    Returns a list of ndarray data types.\n"
 ndarrayDispatch,"\nndarrayDispatch( fcns:Function|ArrayLikeObject<Function>, \n  types:ArrayLikeObject, data:ArrayLikeObject|null, nargs:integer, nin:integer, \n  nout:integer )\n    Returns an ndarray function interface which performs multiple dispatch.\n"
+ndarrayFlags,"\nndarrayFlags( x:ndarray )\n    Returns the flags of a provided ndarray.\n"
 ndarrayIndexModes,"\nndarrayIndexModes()\n    Returns a list of ndarray index modes.\n"
 ndarrayMinDataType,"\nndarrayMinDataType( value:any )\n    Returns the minimum ndarray data type of the closest \"kind\" necessary for\n    storing a provided scalar value.\n"
 ndarrayMostlySafeCasts,"\nndarrayMostlySafeCasts( [dtype:any] )\n    Returns a list of ndarray data types to which a provided ndarray data type\n    can be safely cast and, for floating-point data types, can be downcast.\n"

signature/data/data.csv

@@ -3730,6 +3730,7 @@ ndarrayDataBuffer,"ndarrayDataBuffer( x )"
 ndarrayDataType,"ndarrayDataType( x )"
 ndarrayDataTypes,"ndarrayDataTypes( [kind] )"
 ndarrayDispatch,"ndarrayDispatch( fcns, types, data, nargs, nin, nout )"
+ndarrayFlags,"ndarrayFlags( x )"
 ndarrayIndexModes,"ndarrayIndexModes()"
 ndarrayMinDataType,"ndarrayMinDataType( value )"
 ndarrayMostlySafeCasts,"ndarrayMostlySafeCasts( [dtype] )"

typed-signature/data/data.csv

@@ -3730,6 +3730,7 @@ ndarrayDataBuffer,"ndarrayDataBuffer( x:ndarray )"
 ndarrayDataType,"ndarrayDataType( x:ndarray )"
 ndarrayDataTypes,"ndarrayDataTypes( [kind:string] )"
 ndarrayDispatch,"ndarrayDispatch( fcns:Function|ArrayLikeObject<Function>, types:ArrayLikeObject, data:ArrayLikeObject|null, nargs:integer, nin:integer, nout:integer )"
+ndarrayFlags,"ndarrayFlags( x:ndarray )"
 ndarrayIndexModes,"ndarrayIndexModes()"
 ndarrayMinDataType,"ndarrayMinDataType( value:any )"
 ndarrayMostlySafeCasts,"ndarrayMostlySafeCasts( [dtype:any] )"