proxsuite::nlp::linalg::ldlt_base< Scalar > Struct Template Reference

Base interface for LDLT solvers. More...

#include <proxsuite-nlp/linalg/ldlt-base.hpp>

Public Types
using	DView

Public Member Functions
virtual ldlt_base &	compute (const ConstMatrixRef &mat)=0
bool	solveInPlace (MatrixRef) const
virtual DView	vectorD () const =0
virtual const MatrixXs &	matrixLDLT () const
virtual MatrixXs	reconstructedMatrix () const =0
Eigen::ComputationInfo	info () const
SignMatrix	sign () const
virtual	~ldlt_base ()=0

Static Public Member Functions
template<typename Mat >
static DView	diag_view_impl (Mat &&mat)

Public Attributes
	Scalar

Protected Attributes
Eigen::ComputationInfo	m_info
SignMatrix	m_sign = SignMatrix::ZeroSign

Detailed Description

template<typename Scalar>
struct proxsuite::nlp::linalg::ldlt_base< Scalar >

Base interface for LDLT solvers.

Definition at line 24 of file ldlt-base.hpp.

Member Typedef Documentation

DView

template<typename Scalar >

using proxsuite::nlp::linalg::ldlt_base< Scalar >::DView

Initial value:

 Eigen::Map<const VectorXs, Eigen::Unaligned,
                           Eigen::InnerStride<Eigen::Dynamic>>

Definition at line 26 of file ldlt-base.hpp.

Constructor & Destructor Documentation

~ldlt_base()

template<typename Scalar >

proxsuite::nlp::linalg::ldlt_base< Scalar >::~ldlt_base ( )

pure virtual

Definition at line 52 of file ldlt-base.hpp.

Member Function Documentation

diag_view_impl()

template<typename Scalar >

template<typename Mat >

static DView proxsuite::nlp::linalg::ldlt_base< Scalar >::diag_view_impl ( Mat && mat )

inlinestatic

Definition at line 29 of file ldlt-base.hpp.

compute()

template<typename Scalar >

virtual ldlt_base & proxsuite::nlp::linalg::ldlt_base< Scalar >::compute ( const ConstMatrixRef & mat )

pure virtual

Implemented in proxsuite::nlp::linalg::BlockLDLT< _Scalar >, proxsuite::nlp::linalg::DenseLDLT< _Scalar >, and proxsuite::nlp::linalg::ProxSuiteLDLTWrapper< _Scalar >.

solveInPlace()

template<typename Scalar >

bool proxsuite::nlp::linalg::ldlt_base< Scalar >::solveInPlace ( MatrixRef ) const

inline

Definition at line 35 of file ldlt-base.hpp.

vectorD()

template<typename Scalar >

virtual DView proxsuite::nlp::linalg::ldlt_base< Scalar >::vectorD ( ) const

pure virtual

Implemented in proxsuite::nlp::linalg::BlockLDLT< _Scalar >, proxsuite::nlp::linalg::DenseLDLT< _Scalar >, and proxsuite::nlp::linalg::ProxSuiteLDLTWrapper< _Scalar >.

matrixLDLT()

template<typename Scalar >

virtual const MatrixXs & proxsuite::nlp::linalg::ldlt_base< Scalar >::matrixLDLT ( ) const

inlinevirtual

Reimplemented in proxsuite::nlp::linalg::BlockLDLT< _Scalar >, and proxsuite::nlp::linalg::DenseLDLT< _Scalar >.

Definition at line 39 of file ldlt-base.hpp.

reconstructedMatrix()

template<typename Scalar >

virtual MatrixXs proxsuite::nlp::linalg::ldlt_base< Scalar >::reconstructedMatrix ( ) const

pure virtual

Implemented in proxsuite::nlp::linalg::BlockLDLT< _Scalar >, proxsuite::nlp::linalg::DenseLDLT< _Scalar >, and proxsuite::nlp::linalg::ProxSuiteLDLTWrapper< _Scalar >.

info()

template<typename Scalar >

Eigen::ComputationInfo proxsuite::nlp::linalg::ldlt_base< Scalar >::info ( ) const

inline

Definition at line 43 of file ldlt-base.hpp.

sign()

template<typename Scalar >

SignMatrix proxsuite::nlp::linalg::ldlt_base< Scalar >::sign ( ) const

inline

Definition at line 44 of file ldlt-base.hpp.

Member Data Documentation

Scalar

template<typename Scalar >

proxsuite::nlp::linalg::ldlt_base< Scalar >::Scalar

Definition at line 25 of file ldlt-base.hpp.

m_info

template<typename Scalar >

Eigen::ComputationInfo proxsuite::nlp::linalg::ldlt_base< Scalar >::m_info

protected

Definition at line 48 of file ldlt-base.hpp.

m_sign

template<typename Scalar >

SignMatrix proxsuite::nlp::linalg::ldlt_base< Scalar >::m_sign = SignMatrix::ZeroSign

protected

Definition at line 49 of file ldlt-base.hpp.

---

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

• include/proxsuite-nlp/linalg/ldlt-base.hpp