Linear Algebra Interfaces
The interfaces module provides adapters for converting domain objects to linear algebra problems.
Interface Classes
- class hiten.algorithms.linalg.interfaces._EigenDecompositionInterface[source]
Bases:
_HitenBaseInterface[_EigenDecompositionConfig,_EigenDecompositionProblem,EigenDecompositionResults,EigenDecompositionResults]Adapter producing eigen-decomposition problems from matrices.
- create_problem(*, domain_obj, config)[source]
Create a eigen-decomposition problem.
- Parameters:
domain_obj (np.ndarray) – Matrix to decompose.
config (
_EigenDecompositionConfig) – Configuration for the eigenvalue decomposition.
- Returns:
Eigen decomposition problem.
- Return type:
- to_backend_inputs(problem)[source]
Convert a eigen-decomposition problem to backend inputs.
- Parameters:
problem (
_EigenDecompositionProblem) – The eigen-decomposition problem.- Returns:
The backend inputs.
- Return type:
- to_results(outputs, *, problem, domain_payload=None)[source]
Convert backend outputs to eigen-decomposition results.
- Parameters:
outputs (
EigenDecompositionResults) – The backend outputs.problem (
_EigenDecompositionProblem) – The eigen-decomposition problem.domain_payload (Any, optional) – The domain payload.
- Returns:
The eigen-decomposition results.
- Return type:
- class hiten.algorithms.linalg.interfaces._LibrationPointInterface[source]
Bases:
_HitenBaseInterface[_EigenDecompositionConfig,_EigenDecompositionProblem,EigenDecompositionResults,EigenDecompositionResults]- create_problem(*, domain_obj, config)[source]
Create a eigen-decomposition problem.
- Parameters:
domain_obj (
LibrationPoint) – The domain object.config (
_EigenDecompositionConfig) – Configuration for the eigenvalue decomposition.
- Returns:
Eigen decomposition problem.
- Return type:
- to_backend_inputs(problem)[source]
Convert a eigen-decomposition problem to backend inputs.
- Parameters:
problem (
_EigenDecompositionProblem) – The eigen-decomposition problem.- Returns:
The backend inputs.
- Return type:
- to_results(outputs, *, problem, domain_payload=None)[source]
Convert backend outputs to eigen-decomposition results.
- Parameters:
outputs (
EigenDecompositionResults) – The backend outputs.problem (
_EigenDecompositionProblem) – The eigen-decomposition problem.domain_payload (Any, optional) – The domain payload.
- Returns:
The eigen-decomposition results.
- Return type: