Utils

Utility functions.

Complex

fiesta.utils.complex_mult(complex_array: ndarray, factors: float | ndarray) ndarray

Complex array multiplication.

Parameters:
  • complex_array (array) – Complex array.

  • factors (float or array) – Factors to be multiplied by.

fiesta.utils.complex_div(complex_array: ndarray, factors: float | ndarray) ndarray

Complex array division.

Parameters:
  • complex_array (array) – Complex array.

  • factors (float/array) – Factors to be dividied by.

Lists

fiesta.utils.flatten_list(list_: list) list

Flattens input list

Parameters:

list (list) – Unflattened list.

Returns:

flat_list – Flattened list.

Return type:

list

Vectors

fiesta.utils.get_vector_magnitude_2D(x: ndarray, y: ndarray) ndarray

Returns the magnitude for vectors.

Parameters:
  • x (array) – X component.

  • y (array) – Y component.

Returns:

mag – Magnitude of the vector.

Return type:

array

fiesta.utils.get_vector_magnitude_3D(x: ndarray, y: ndarray, z: ndarray) ndarray

Returns the magnitude for vectors.

Parameters:
  • x (array) – X component.

  • y (array) – Y component.

  • z (array) – Z component.

Returns:

mag – Magnitude of the vector.

Return type:

array