sopt::proximal::L1< SCALAR >::Diagnostic Struct Reference

How did calling L1 go? More...

#include <l1_proximal.h>

Inheritance diagram for sopt::proximal::L1< SCALAR >::Diagnostic:

Public Member Functions
	Diagnostic (t_uint niters=0, Real relative_variation=0, Real objective=0, bool good=false)

Public Attributes
t_uint	niters
	Number of iterations. More...
Real	relative_variation
	Relative variation of the objective function. More...
Real	objective
	Value of the objective function. More...
bool	good
	Wether convergence was achieved. More...

Detailed Description

template<typename SCALAR>
struct sopt::proximal::L1< SCALAR >::Diagnostic

How did calling L1 go?

Definition at line 190 of file l1_proximal.h.

Constructor & Destructor Documentation

Diagnostic()

template<typename SCALAR >

sopt::proximal::L1< SCALAR >::Diagnostic::Diagnostic ( t_uint  niters = 0, Real  relative_variation = 0, Real  objective = 0, bool  good = false  )

inline

Definition at line 199 of file l1_proximal.h.

        : niters(niters),
          relative_variation(relative_variation),
          objective(objective),
          good(good) {}

Member Data Documentation

good

template<typename SCALAR >

bool sopt::proximal::L1< SCALAR >::Diagnostic::good

Wether convergence was achieved.

Definition at line 198 of file l1_proximal.h.

niters

template<typename SCALAR >

t_uint sopt::proximal::L1< SCALAR >::Diagnostic::niters

Number of iterations.

Definition at line 192 of file l1_proximal.h.

objective

template<typename SCALAR >

Real sopt::proximal::L1< SCALAR >::Diagnostic::objective

Value of the objective function.

Definition at line 196 of file l1_proximal.h.

relative_variation

template<typename SCALAR >

Real sopt::proximal::L1< SCALAR >::Diagnostic::relative_variation

Relative variation of the objective function.

Definition at line 194 of file l1_proximal.h.

---

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

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