Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "array/next-dtype/docs/types/index.d"

Index

Interfaces

Functions

Functions

Export assignment nextDataType

  • nextDataType(dtype: "float64"): number
  • nextDataType(dtype: "float32"): "float64"
  • nextDataType(dtype: "int32"): number
  • nextDataType(dtype: "int16"): "int32"
  • nextDataType(dtype: "int8"): "int16"
  • nextDataType(dtype: "uint32"): number
  • nextDataType(dtype: "uint16"): "uint32"
  • nextDataType(dtype: "uint8"): "uint16"
  • nextDataType(dtype: "uint8c"): "uint16"
  • nextDataType(dtype: "generic"): number
  • nextDataType(dtype: "complex128"): number
  • nextDataType(dtype: "complex64"): "complex128"
  • nextDataType(dtype: DataType): DataType | number
  • nextDataType(dtype: string): null
  • nextDataType(dtype?: DataType): Table
  • Returns the next larger array data type of the same kind.

    Notes

    • If a data type does not have a next larger data type or the next larger type is not supported, the function returns -1.

    Parameters

    • dtype: "float64"

      array data type

    Returns number

    next larger data type

    Example

    var dt = nextDataType( 'float64' );
    // returns -1
  • Returns the next larger array data type of the same kind.

    Notes

    • If a data type does not have a next larger data type or the next larger type is not supported, the function returns -1.

    Parameters

    • dtype: "float32"

      array data type

    Returns "float64"

    next larger data type

    Example

    var dt = nextDataType( 'float32' );
    // returns 'float64'
  • Returns the next larger array data type of the same kind.

    Notes

    • If a data type does not have a next larger data type or the next larger type is not supported, the function returns -1.

    Parameters

    • dtype: "int32"

      array data type

    Returns number

    next larger data type

    Example

    var dt = nextDataType( 'int32' );
    // returns -1
  • Returns the next larger array data type of the same kind.

    Notes

    • If a data type does not have a next larger data type or the next larger type is not supported, the function returns -1.

    Parameters

    • dtype: "int16"

      array data type

    Returns "int32"

    next larger data type

    Example

    var dt = nextDataType( 'int16' );
    // returns 'int32'
  • Returns the next larger array data type of the same kind.

    Notes

    • If a data type does not have a next larger data type or the next larger type is not supported, the function returns -1.

    Parameters

    • dtype: "int8"

      array data type

    Returns "int16"

    next larger data type

    Example

    var dt = nextDataType( 'int8' );
    // returns 'int16'
  • Returns the next larger array data type of the same kind.

    Notes

    • If a data type does not have a next larger data type or the next larger type is not supported, the function returns -1.

    Parameters

    • dtype: "uint32"

      array data type

    Returns number

    next larger data type

    Example

    var dt = nextDataType( 'uint32' );
    // returns -1
  • Returns the next larger array data type of the same kind.

    Notes

    • If a data type does not have a next larger data type or the next larger type is not supported, the function returns -1.

    Parameters

    • dtype: "uint16"

      array data type

    Returns "uint32"

    next larger data type

    Example

    var dt = nextDataType( 'uint16' );
    // returns 'uint32'
  • Returns the next larger array data type of the same kind.

    Notes

    • If a data type does not have a next larger data type or the next larger type is not supported, the function returns -1.

    Parameters

    • dtype: "uint8"

      array data type

    Returns "uint16"

    next larger data type

    Example

    var dt = nextDataType( 'uint8' );
    // returns 'uint16'
  • Returns the next larger array data type of the same kind.

    Notes

    • If a data type does not have a next larger data type or the next larger type is not supported, the function returns -1.

    Parameters

    • dtype: "uint8c"

      array data type

    Returns "uint16"

    next larger data type

    Example

    var dt = nextDataType( 'uint8c' );
    // returns 'uint16'
  • Returns the next larger array data type of the same kind.

    Notes

    • If a data type does not have a next larger data type or the next larger type is not supported, the function returns -1.

    Parameters

    • dtype: "generic"

      array data type

    Returns number

    next larger data type

    Example

    var dt = nextDataType( 'generic' );
    // returns -1
  • Returns the next larger array data type of the same kind.

    Notes

    • If a data type does not have a next larger data type or the next larger type is not supported, the function returns -1.

    Parameters

    • dtype: "complex128"

      array data type

    Returns number

    next larger data type

    Example

    var dt = nextDataType( 'complex128' );
    // returns -1
  • Returns the next larger array data type of the same kind.

    Notes

    • If a data type does not have a next larger data type or the next larger type is not supported, the function returns -1.

    Parameters

    • dtype: "complex64"

      array data type

    Returns "complex128"

    next larger data type

    Example

    var dt = nextDataType( 'complex64' );
    // returns 'complex128'
  • Returns the next larger array data type of the same kind.

    Notes

    • If a data type does not have a next larger data type or the next larger type is not supported, the function returns -1.

    Parameters

    Returns DataType | number

    next larger data type

    Example

    var dt = nextDataType( 'complex64' );
    // returns 'complex128'
  • Returns the next larger array data type of the same kind.

    Notes

    • If provided an unrecognized data type, the function returns null.

    Parameters

    • dtype: string

      array data type

    Returns null

    next larger data type

    Example

    var dt = nextDataType( 'float' );
    // returns null
  • Returns the next larger array data type of the same kind.

    Notes

    • If not provided a data type, the function returns a table.
    • If a data type does not have a next larger data type or the next larger type is not supported, the function returns -1.
    • If provided an unrecognized data type, the function returns null.

    Parameters

    • Optional dtype: DataType

      array data type

    Returns Table

    next larger data type(s) or null

    Example

    var table = nextDataType();
    // returns {...}

    Example

    var dt = nextDataType( 'float32' );
    // returns 'float64'