ug::Norm2Estimator< TVector > Class Template Reference

Evaluate using (algebraic) L2 norm. More...

#include <time_extrapolation.h>

Inheritance diagram for ug::Norm2Estimator< TVector >:

Public Member Functions
	Norm2Estimator ()
	Norm2Estimator (int delta, int offset)
	Norm2Estimator (int stride)
void	set_offset (int offset)
void	set_stride (int delta)
bool	update (SmartPtr< TVector > vUpdate, number alpha2, SmartPtr< TVector > vFine, SmartPtr< TVector > vCoarse)
	compute update vUpdate = vFine + alpha * (vFine- vCoarse) AND estimate error | alpha * (vFine- vCoarse)| More...
Public Member Functions inherited from ug::ISubDiagErrorEst< TVector >
virtual std::string	config_string () const
number	get_current_estimate ()
	get estimate More...
	ISubDiagErrorEst ()
void	reset_estimate ()
virtual	~ISubDiagErrorEst ()

Protected Types
typedef ISubDiagErrorEst< TVector >	base_type

Protected Attributes
int	m_offset
int	m_stride
Protected Attributes inherited from ug::ISubDiagErrorEst< TVector >
number	m_est

Detailed Description

template<class TVector>
class ug::Norm2Estimator< TVector >

Evaluate using (algebraic) L2 norm.

Member Typedef Documentation

base_type

template<class TVector >

typedef ISubDiagErrorEst<TVector> ug::Norm2Estimator< TVector >::base_type

protected

Constructor & Destructor Documentation

Norm2Estimator() [1/3]

template<class TVector >

ug::Norm2Estimator< TVector >::Norm2Estimator ( )

inline

Norm2Estimator() [2/3]

template<class TVector >

ug::Norm2Estimator< TVector >::Norm2Estimator ( int  stride )

inline

Norm2Estimator() [3/3]

template<class TVector >

ug::Norm2Estimator< TVector >::Norm2Estimator ( int  delta, int  offset  )

inline

Member Function Documentation

set_offset()

template<class TVector >

void ug::Norm2Estimator< TVector >::set_offset ( int  offset )

inline

References ug::Norm2Estimator< TVector >::m_offset.

set_stride()

template<class TVector >

void ug::Norm2Estimator< TVector >::set_stride ( int  delta )

inline

References ug::Norm2Estimator< TVector >::m_stride.

update()

template<class TVector >

bool ug::Norm2Estimator< TVector >::update ( SmartPtr< TVector >  vUpdate, number  alpha2, SmartPtr< TVector >  vFine, SmartPtr< TVector >  vCoarse  )

inlinevirtual

compute update vUpdate = vFine + alpha * (vFine- vCoarse) AND estimate error | alpha * (vFine- vCoarse)|

Implements ug::ISubDiagErrorEst< TVector >.

References ug::ISubDiagErrorEst< TVector >::m_est, ug::Norm2Estimator< TVector >::m_offset, ug::Norm2Estimator< TVector >::m_stride, PCL_DT_DOUBLE, PCL_RO_SUM, and ug::tools::VecScaleAddWithNorm2().

Member Data Documentation

m_offset

template<class TVector >

int ug::Norm2Estimator< TVector >::m_offset

protected

Referenced by ug::Norm2Estimator< TVector >::set_offset(), and ug::Norm2Estimator< TVector >::update().

m_stride

template<class TVector >

int ug::Norm2Estimator< TVector >::m_stride

protected

Referenced by ug::Norm2Estimator< TVector >::set_stride(), and ug::Norm2Estimator< TVector >::update().

---

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

• /home/runner/work/docs/docs/ug4/plugins/Limex/time_disc/time_extrapolation.h