SciEx.Types (sci_ex v0.2.0)

Common SciEx types used in several modules.

Summary

Types

complex_array()

An array (1D through 6D) of complex values.

complex_number()

Scalar value representing a complex number

complex_value()

Values that can be used in operations with complex arrays and complex scalars.

float_array()

An array (1D through 6D) of floating point values.

float_value()

Values that can used in operations with floating point arrays in operations such as addition, subtraction, multiplication and division.

numeric_value()

Either complex or floating point values.

Types

complex_array()

@type complex_array() ::
  Complex64.Array1.t()
  | Complex64.Array2.t()
  | Complex64.Array3.t()
  | Complex64.Array4.t()
  | Complex64.Array5.t()
  | Complex64.Array6.t()
  | Complex32.Array1.t()
  | Complex32.Array2.t()
  | Complex32.Array3.t()
  | Complex32.Array4.t()
  | Complex32.Array5.t()
  | Complex32.Array6.t()

An array (1D through 6D) of complex values.

complex_number()

@type complex_number() :: Complex32.t() | Complex64.t()

Scalar value representing a complex number

complex_value()

@type complex_value() :: complex_number() | complex_array()

Values that can be used in operations with complex arrays and complex scalars.

float_array()

@type float_array() ::
  SciEx.Float64.Array1.t()
  | SciEx.Float64.Array2.t()
  | SciEx.Float64.Array3.t()
  | SciEx.Float64.Array4.t()
  | SciEx.Float64.Array5.t()
  | SciEx.Float64.Array6.t()
  | SciEx.Float32.Array1.t()
  | SciEx.Float32.Array2.t()
  | SciEx.Float32.Array3.t()
  | SciEx.Float32.Array4.t()
  | SciEx.Float32.Array5.t()
  | SciEx.Float32.Array6.t()

An array (1D through 6D) of floating point values.

float_value()

@type float_value() :: number() | float_array()

Values that can used in operations with floating point arrays in operations such as addition, subtraction, multiplication and division.

numeric_value()

@type numeric_value() :: float_value() | complex_value()

Either complex or floating point values.