Linear Algebra Types

The types module provides data structures and enums for linear algebra operations.

Enums

class hiten.algorithms.linalg.types._ProblemType[source]

Bases: Enum

Problem type for eigenvalue decomposition.

Parameters:

  • EIGENVALUE_DECOMPOSITION (int) – Eigenvalue decomposition problem.

  • STABILITY_INDICES (int) – Stability indices problem.

  • ALL (int) – All problems.

EIGENVALUE_DECOMPOSITION = 0
STABILITY_INDICES = 1
ALL = 2
class hiten.algorithms.linalg.types._SystemType[source]

Bases: Enum

System type for eigenvalue decomposition.

Parameters:

  • CONTINUOUS (int) – Continuous-time system.

  • DISCRETE (int) – Discrete-time system.

CONTINUOUS = 0
DISCRETE = 1
class hiten.algorithms.linalg.types._StabilityType[source]

Bases: Enum

Stability type for eigenvalue decomposition.

Parameters:

  • CENTER (int) – Center eigenvalue.

  • STABLE (int) – Stable eigenvalue.

  • UNSTABLE (int) – Unstable eigenvalue.

CENTER = 0
STABLE = 1
UNSTABLE = 2

Result Classes

class hiten.algorithms.linalg.types.EigenDecompositionResults[source]

Bases: object

Stable/unstable/center spectra and bases.

Parameters:

  • stable (np.ndarray) – Stable eigenvalues.

  • unstable (np.ndarray) – Unstable eigenvalues.

  • center (np.ndarray) – Center eigenvalues.

  • Ws (np.ndarray) – Stable eigenvectors.

  • Wu (np.ndarray) – Unstable eigenvectors.

  • Wc (np.ndarray) – Center eigenvectors.

  • nu (np.ndarray) – Floquet stability indices.

  • eigvals (np.ndarray) – Eigenvalues.

  • eigvecs (np.ndarray) – Eigenvectors.

stable: ndarray
unstable: ndarray
center: ndarray
Ws: ndarray
Wu: ndarray
Wc: ndarray
nu: ndarray
eigvals: ndarray
eigvecs: ndarray

Problem Classes

class hiten.algorithms.linalg.types._EigenDecompositionProblem[source]

Bases: object

Problem definition for classifying the eigen-structure of a matrix.

Parameters:

  • A (np.ndarray) – Matrix to decompose.

  • problem_type (_ProblemType) – Problem type for the eigenvalue decomposition.

  • system_type (_SystemType) – Classification mode: 0 for continuous-time (sign of real parts), 1 for discrete-time (modulus relative to unity).

  • delta (float) – Tolerance used in eigenvalue classification.

  • tol (float) – Tolerance used in stability index calculation.

A: ndarray
problem_type: _ProblemType
system_type: _SystemType
delta: float
tol: float
class hiten.algorithms.linalg.types._LibrationPointStabilityProblem[source]

Bases: _EigenDecompositionProblem

Problem definition for computing linear stability at a CR3BP position.

Parameters:
mu: float
position: ndarray