KASKADE 7 development version: Kaskade::CG_Detail::Regularization< X, Xstar, Derived > Struct Template Reference

KASKADE 7 development version

#include <cgImplementation.hh>

Detailed Description

template<class X, class Xstar, class Derived>
struct Kaskade::CG_Detail::Regularization< X, Xstar, Derived >

Definition at line 32 of file cgImplementation.hh.

Public Types
typedef ScalarTraits< typenameGetScalar< X >::type >::Real	Real

Public Member Functions
	Regularization (double eps_, int verbose_)

void	initializeRegularization ()

void	regularize (double &qAq, double qPq)

void	updateRegularization (double qAq, double qPq)

void	adjustResidual (Xstar &r, double alpha, Xstar const &Pq)

Public Attributes
Real	theta = 0

Real	eps = 1e-16

int	verbose = 0

Member Typedef Documentation

◆ Real

template<class X , class Xstar , class Derived >

typedef ScalarTraits<typenameGetScalar<X>::type>::Real Kaskade::CG_Detail::Regularization< X, Xstar, Derived >::Real

Definition at line 34 of file cgImplementation.hh.

Constructor & Destructor Documentation

◆ Regularization()

template<class X , class Xstar , class Derived >

Kaskade::CG_Detail::Regularization< X, Xstar, Derived >::Regularization	(	double	eps_,
		int	verbose_
	)

inline

Definition at line 36 of file cgImplementation.hh.

Member Function Documentation

◆ adjustResidual()

template<class X , class Xstar , class Derived >

void Kaskade::CG_Detail::Regularization< X, Xstar, Derived >::adjustResidual	(	Xstar &	r,
		double	alpha,
		Xstar const &	Pq
	)

inline

Definition at line 58 of file cgImplementation.hh.

◆ initializeRegularization()

template<class X , class Xstar , class Derived >

void Kaskade::CG_Detail::Regularization< X, Xstar, Derived >::initializeRegularization ( )

inline

Definition at line 39 of file cgImplementation.hh.

◆ regularize()

template<class X , class Xstar , class Derived >

void Kaskade::CG_Detail::Regularization< X, Xstar, Derived >::regularize	(	double &	qAq,
		double	qPq
	)

inline

Definition at line 44 of file cgImplementation.hh.

◆ updateRegularization()

template<class X , class Xstar , class Derived >

void Kaskade::CG_Detail::Regularization< X, Xstar, Derived >::updateRegularization	(	double	qAq,
		double	qPq
	)

inline

Definition at line 49 of file cgImplementation.hh.

Member Data Documentation

◆ eps

template<class X , class Xstar , class Derived >

Real Kaskade::CG_Detail::Regularization< X, Xstar, Derived >::eps = 1e-16

Definition at line 63 of file cgImplementation.hh.

Referenced by Kaskade::CG_Detail::Regularization< X, Xstar, Derived >::updateRegularization().

◆ theta

template<class X , class Xstar , class Derived >

Real Kaskade::CG_Detail::Regularization< X, Xstar, Derived >::theta = 0

Definition at line 63 of file cgImplementation.hh.

Referenced by Kaskade::CG_Detail::Regularization< X, Xstar, Derived >::adjustResidual(), Kaskade::CG_Detail::Regularization< X, Xstar, Derived >::initializeRegularization(), Kaskade::CG_Detail::Regularization< X, Xstar, Derived >::regularize(), and Kaskade::CG_Detail::Regularization< X, Xstar, Derived >::updateRegularization().

◆ verbose

template<class X , class Xstar , class Derived >

int Kaskade::CG_Detail::Regularization< X, Xstar, Derived >::verbose = 0

Definition at line 64 of file cgImplementation.hh.

Referenced by Kaskade::CG_Detail::Regularization< X, Xstar, Derived >::updateRegularization().

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

cgImplementation.hh