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

promotionRules

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

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

  Parameters

  • dtype1: DataType

    data type

  • dtype2: DataType

    data type

  Returns PromotionRule

  promotion rule

  Example

  var dt = promotionRules( 'complex128', 'complex64' );
  // returns 'complex128'

  Example

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

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

  Parameters

  • dtype1: string

    data type

  • dtype2: string

    data type

  Returns null

  promotion rule

  Example

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

  Example

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

  Example

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

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

  Returns Table

  promotion rule table

  Example

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