MathLib::details::EigenDirectLinearSolver< T_SOLVER > Class Template Reference

Detailed Description

template<class T_SOLVER>
class MathLib::details::EigenDirectLinearSolver< T_SOLVER >

Template class for Eigen direct linear solvers.

Definition at line 98 of file EigenLinearSolver.cpp.

Inheritance diagram for MathLib::details::EigenDirectLinearSolver< T_SOLVER >:

Collaboration diagram for MathLib::details::EigenDirectLinearSolver< T_SOLVER >:

Public Member Functions
bool	solveImpl (Vector const &b, Vector &x, EigenOption &opt) override
bool	computeImpl (Matrix &A, EigenOption &opt, MathLib::LinearSolverBehaviour const linear_solver_behaviour) override
Public Member Functions inherited from MathLib::EigenLinearSolverBase
virtual	~EigenLinearSolverBase ()=default
bool	solve (Vector &b, Vector &x, EigenOption &opt)
bool	compute (Matrix &A, EigenOption &opt, MathLib::LinearSolverBehaviour const linear_solver_behaviour)

Private Attributes
T_SOLVER	solver_

Additional Inherited Members
Public Types inherited from MathLib::EigenLinearSolverBase
using	Vector = EigenVector::RawVectorType
using	Matrix = EigenMatrix::RawMatrixType

Member Function Documentation

computeImpl()

template<class T_SOLVER >

bool MathLib::details::EigenDirectLinearSolver< T_SOLVER >::computeImpl ( Matrix & A, EigenOption & opt, MathLib::LinearSolverBehaviour const linear_solver_behaviour )

inlineoverridevirtual

Implements MathLib::EigenLinearSolverBase.

Definition at line 116 of file EigenLinearSolver.cpp.

    {
        INFO("-> compute with Eigen direct linear solver {:s}",
             EigenOption::getSolverName(opt.solver_type));
        if (!A.isCompressed())
        {
            A.makeCompressed();
        }
 
        solver_.compute(A);
        if (solver_.info() != Eigen::Success)
        {
            ERR("Failed during Eigen linear solver initialization");
            return false;
        }
 
        return true;
    }

References ERR(), MathLib::EigenOption::getSolverName(), INFO(), MathLib::details::EigenDirectLinearSolver< T_SOLVER >::solver_, and MathLib::EigenOption::solver_type.

solveImpl()

template<class T_SOLVER >

bool MathLib::details::EigenDirectLinearSolver< T_SOLVER >::solveImpl ( Vector const & b, Vector & x, EigenOption & opt )

inlineoverridevirtual

Implements MathLib::EigenLinearSolverBase.

Definition at line 101 of file EigenLinearSolver.cpp.

    {
        INFO("-> solve with Eigen direct linear solver {:s}",
             EigenOption::getSolverName(opt.solver_type));
 
        x = solver_.solve(b);
        if (solver_.info() != Eigen::Success || x.hasNaN())
        {
            ERR("Failed during Eigen linear solve");
            return false;
        }
 
        return true;
    }

References ERR(), MathLib::EigenOption::getSolverName(), INFO(), MathLib::details::EigenDirectLinearSolver< T_SOLVER >::solver_, and MathLib::EigenOption::solver_type.

Member Data Documentation

solver_

template<class T_SOLVER >

T_SOLVER MathLib::details::EigenDirectLinearSolver< T_SOLVER >::solver_

private

Definition at line 138 of file EigenLinearSolver.cpp.

Referenced by MathLib::details::EigenDirectLinearSolver< T_SOLVER >::computeImpl(), and MathLib::details::EigenDirectLinearSolver< T_SOLVER >::solveImpl().

---

The documentation for this class was generated from the following file:

• MathLib/LinAlg/Eigen/EigenLinearSolver.cpp