sopt::algorithm::ProximalADMM< SCALAR >::Diagnostic Struct Reference

Values indicating how the algorithm ran. More...

#include <padmm.h>

Inheritance diagram for sopt::algorithm::ProximalADMM< SCALAR >::Diagnostic:

Public Member Functions
	Diagnostic (t_uint niters=0u, bool good=false)
	Diagnostic (t_uint niters, bool good, t_Vector &&residual)

Public Attributes
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::ProximalADMM< SCALAR >::Diagnostic

Values indicating how the algorithm ran.

Definition at line 37 of file padmm.h.

Constructor & Destructor Documentation

Diagnostic() [1/2]

template<typename SCALAR >

sopt::algorithm::ProximalADMM< SCALAR >::Diagnostic::Diagnostic ( t_uint  niters = 0u, bool  good = false  )

inline

Definition at line 45 of file padmm.h.

        : niters(niters), good(good), residual(t_Vector::Zero(0)) {}

Diagnostic() [2/2]

template<typename SCALAR >

sopt::algorithm::ProximalADMM< SCALAR >::Diagnostic::Diagnostic ( t_uint  niters, bool  good, t_Vector &&  residual  )

inline

Definition at line 47 of file padmm.h.

        : niters(niters), good(good), residual(std::move(residual)) {}

Member Data Documentation

good

template<typename SCALAR >

bool sopt::algorithm::ProximalADMM< SCALAR >::Diagnostic::good

Wether convergence was achieved.

Definition at line 41 of file padmm.h.

niters

template<typename SCALAR >

t_uint sopt::algorithm::ProximalADMM< SCALAR >::Diagnostic::niters

Number of iterations.

Definition at line 39 of file padmm.h.

residual

template<typename SCALAR >

t_Vector sopt::algorithm::ProximalADMM< SCALAR >::Diagnostic::residual

the residual from the last iteration

Definition at line 43 of file padmm.h.

Referenced by sopt::algorithm::ImagingProximalADMM< SCALAR >::operator()(), and sopt::algorithm::ProximalADMM< SCALAR >::operator()().

---

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

• /home/runner/work/sopt/sopt/cpp/sopt/padmm.h