External module "array/promotion-rules/docs/types/index.d"

Export assignment promotionRules

• promotionRules(dtype1: DataType, dtype2: DataType): PromotionRule
• promotionRules(dtype1: string, dtype2: string): null
• promotionRules(): Table

• Returns the array data type with the smallest size and closest "kind" to which array data types can be safely cast.

  Parameters

  • dtype1: DataType

    array data type

  • dtype2: DataType

    array data type

  Returns PromotionRule

  promotion rule

  Example

  var dt = promotionRules( 'float32', 'uint32' );
  // returns 'float64'

  Example

  var dt = promotionRules( 'float32', 'foo' );
  // returns null

• Returns the array data type with the smallest size and closest "kind" to which array data types can be safely cast.

  Parameters

  • dtype1: string

    array data type

  • dtype2: string

    array data type

  Returns null

  promotion rule

  Example

  var dt = promotionRules( 'float32', 'foo' );
  // returns null

  Example

  var dt = promotionRules( 'bar', 'float32' );
  // returns null

  Example

  var dt = promotionRules( 'bar', 'foo' );
  // returns null

• Returns a type promotion table displaying array data types with the smallest size and closest "kind" to which array data types can be safely cast.

  Returns Table

  promotion rule table

  Example

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