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

Values indicating how the algorithm ran. More...

#include <imaging_padmm.h>

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

Public Member Functions

 Diagnostic (t_uint niters=0u, bool good=false, typename proximal::L1< Scalar >::Diagnostic const &l1diag=typename proximal::L1< Scalar >::Diagnostic())
 
 Diagnostic (t_uint niters, bool good, typename proximal::L1< Scalar >::Diagnostic const &l1diag, t_Vector &&residual)
 
- Public Member Functions inherited from sopt::algorithm::ProximalADMM< SCALAR >::Diagnostic
 Diagnostic (t_uint niters=0u, bool good=false)
 
 Diagnostic (t_uint niters, bool good, t_Vector &&residual)
 

Public Attributes

proximal::L1< Scalar >::Diagnostic l1_diagnostic
 Diagnostic from calling L1 proximal. More...
 
- Public Attributes inherited from sopt::algorithm::ProximalADMM< 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::ImagingProximalADMM< SCALAR >::Diagnostic

Values indicating how the algorithm ran.

Definition at line 34 of file imaging_padmm.h.

Constructor & Destructor Documentation

◆ Diagnostic() [1/2]

template<typename SCALAR >
sopt::algorithm::ImagingProximalADMM< SCALAR >::Diagnostic::Diagnostic ( t_uint  niters = 0u,
bool  good = false,
typename proximal::L1< Scalar >::Diagnostic const &  l1diag = typename proximal::L1<Scalar>::Diagnostic() 
)
inline

Definition at line 37 of file imaging_padmm.h.

40  : PADMM::Diagnostic(niters, good), l1_diagnostic(l1diag) {}
proximal::L1< Scalar >::Diagnostic l1_diagnostic
Diagnostic from calling L1 proximal.
Definition: imaging_padmm.h:36
bool good
Wether convergence was achieved.
Definition: padmm.h:41
t_uint niters
Number of iterations.
Definition: padmm.h:39

◆ Diagnostic() [2/2]

template<typename SCALAR >
sopt::algorithm::ImagingProximalADMM< SCALAR >::Diagnostic::Diagnostic ( t_uint  niters,
bool  good,
typename proximal::L1< Scalar >::Diagnostic const &  l1diag,
t_Vector &&  residual 
)
inline

Definition at line 41 of file imaging_padmm.h.

43  : PADMM::Diagnostic(niters, good, std::move(residual)), l1_diagnostic(l1diag) {}
t_Vector residual
the residual from the last iteration
Definition: padmm.h:43

Member Data Documentation

◆ l1_diagnostic

template<typename SCALAR >
proximal::L1<Scalar>::Diagnostic sopt::algorithm::ImagingProximalADMM< SCALAR >::Diagnostic::l1_diagnostic

Diagnostic from calling L1 proximal.

Definition at line 36 of file imaging_padmm.h.


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