pymatsolver.solvers.Base#
- class pymatsolver.solvers.Base(A, is_symmetric=None, is_positive_definite=False, is_hermitian=None, check_accuracy=False, check_rtol=1e-06, check_atol=0, **kwargs)[source]#
Base class for all solvers used in the pymatsolver package.
- Parameters:
- A
Matrix to solve with.
- is_symmetricbool,
optional Whether the matrix is symmetric. By default, it will perform some simple tests to check for symmetry, and default to
Falseif those fail.- is_positive_definitebool,
optional Whether the matrix is positive definite.
- is_hermitianbool,
optional Whether the matrix is hermitian. By default, it will perform some simple tests to check, and default to
Falseif those fail.- check_accuracybool,
optional Whether to check the accuracy of the solution.
- check_rtol
float,optional The relative tolerance to check against for accuracy.
- check_atol
float,optional The absolute tolerance to check against for accuracy.
- **kwargs
Extra keyword arguments. If there are any left here a warning will be raised.
- Attributes:
AThe matrix to solve with.
TThe transposed solve operator
check_accuracyWhether the check the accuracy after a solve.
check_atolThe absolute tolerance used to check the solve operation.
check_rtolThe relative tolerance used to check the solve operation.
dtypeThe data type of the matrix.
is_hermitianWhether the matrix is hermitian.
is_positive_definiteWhether the matrix is positive definite.
is_realWhether the matrix is real.
is_symmetricWhether the matrix is symmetric.
shapeThe input matrix dimensions.
Methods
conj()Return the complex conjugate version of this solver.
Return the complex conjugate version of this solver.
solve(rhs)Solves the system of equations for the given right hand side.
Return the transposed solve operator.
clean
get_attributes