SOPT
Sparse OPTimisation
Public Member Functions | List of all members
sopt::algorithm::TVPrimalDual< SCALAR >::Diagnostic Struct Reference

Values indicating how the algorithm ran. More...

#include <tv_primal_dual.h>

+ Inheritance diagram for sopt::algorithm::TVPrimalDual< SCALAR >::Diagnostic:
+ Collaboration diagram for sopt::algorithm::TVPrimalDual< SCALAR >::Diagnostic:

Public Member Functions

 Diagnostic (t_uint niters=0u, bool good=false)
 
 Diagnostic (t_uint niters, bool good, t_Vector &&residual)
 
- Public Member Functions inherited from sopt::algorithm::PrimalDual< SCALAR >::Diagnostic
 Diagnostic (t_uint niters=0u, bool good=false)
 
 Diagnostic (t_uint niters, bool good, t_Vector &&residual)
 

Additional Inherited Members

- Public Attributes inherited from sopt::algorithm::PrimalDual< SCALAR >::Diagnostic
t_uint niters
 Number of iterations. More...
 
bool good
 Wether convergence was achieved. More...
 
t_Vector residual
 the residual from the last iteration More...
 

Detailed Description

template<typename SCALAR>
struct sopt::algorithm::TVPrimalDual< SCALAR >::Diagnostic

Values indicating how the algorithm ran.

Definition at line 36 of file tv_primal_dual.h.

Constructor & Destructor Documentation

◆ Diagnostic() [1/2]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::Diagnostic::Diagnostic ( t_uint  niters = 0u,
bool  good = false 
)
inline

Definition at line 37 of file tv_primal_dual.h.

37 : PD::Diagnostic(niters, good) {}
t_uint niters
Number of iterations.
Definition: primal_dual.h:48
bool good
Wether convergence was achieved.
Definition: primal_dual.h:50

◆ Diagnostic() [2/2]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::Diagnostic::Diagnostic ( t_uint  niters,
bool  good,
t_Vector &&  residual 
)
inline

Definition at line 38 of file tv_primal_dual.h.

39  : PD::Diagnostic(niters, good, std::move(residual)) {}
t_Vector residual
the residual from the last iteration
Definition: primal_dual.h:52

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