ProximalSettingsTpl< _Scalar > Struct Template Reference

Structure containing all the settings parameters for the proximal algorithms. More...

#include <pinocchio/algorithm/proximal.hpp>

Public Types
typedef _Scalar	Scalar

Public Member Functions
	ProximalSettingsTpl ()
	Default constructor.
	ProximalSettingsTpl (const Scalar absolute_accuracy, const Scalar relative_accuracy, const Scalar mu, const int max_iter)
	Constructor with all the setting parameters.
	ProximalSettingsTpl (const Scalar accuracy, const Scalar mu, const int max_iter)
	Constructor with all the setting parameters.

Public Attributes
Scalar	absolute_accuracy
	Absolute proximal accuracy.
Scalar	absolute_residual
	Absolute residual.
int	iter
	Total number of iterations of the algorithm when it has converged or reached the maximal number of allowed iterations.
int	max_iter
	Maximal number of iterations.
Scalar	mu
	Regularization parameter of the proximal algorithm.
Scalar	relative_accuracy
	Relative proximal accuracy between two iterates.
Scalar	relative_residual
	Relatice residual between two iterates.

Detailed Description

template<typename _Scalar>
struct pinocchio::ProximalSettingsTpl< _Scalar >

Structure containing all the settings parameters for the proximal algorithms.

 

Template Parameters

_Scalar

Scalar type of the for the regularization and the accuracy parameter.

It contains the accuracy, the maximal number of iterations and the regularization factor common to all proximal algorithms.

Definition at line 24 of file proximal.hpp.

Member Typedef Documentation

Scalar

template<typename _Scalar >

typedef _Scalar Scalar

Definition at line 26 of file proximal.hpp.

Constructor & Destructor Documentation

ProximalSettingsTpl() [1/3]

template<typename _Scalar >

ProximalSettingsTpl ( )

inline

Default constructor.

Definition at line 29 of file proximal.hpp.

ProximalSettingsTpl() [2/3]

template<typename _Scalar >

ProximalSettingsTpl ( const Scalar  accuracy, const Scalar  mu, const int  max_iter  )

inline

Constructor with all the setting parameters.

Definition at line 43 of file proximal.hpp.

ProximalSettingsTpl() [3/3]

template<typename _Scalar >

ProximalSettingsTpl ( const Scalar  absolute_accuracy, const Scalar  relative_accuracy, const Scalar  mu, const int  max_iter  )

inline

Constructor with all the setting parameters.

Definition at line 62 of file proximal.hpp.

Member Data Documentation

absolute_accuracy

template<typename _Scalar >

Scalar absolute_accuracy

Absolute proximal accuracy.

Definition at line 89 of file proximal.hpp.

absolute_residual

template<typename _Scalar >

Scalar absolute_residual

Absolute residual.

Definition at line 103 of file proximal.hpp.

iter

template<typename _Scalar >

int iter

Total number of iterations of the algorithm when it has converged or reached the maximal number of allowed iterations.

Definition at line 110 of file proximal.hpp.

max_iter

template<typename _Scalar >

int max_iter

Maximal number of iterations.

Definition at line 98 of file proximal.hpp.

mu

template<typename _Scalar >

Scalar mu

Regularization parameter of the proximal algorithm.

Definition at line 95 of file proximal.hpp.

relative_accuracy

template<typename _Scalar >

Scalar relative_accuracy

Relative proximal accuracy between two iterates.

Definition at line 92 of file proximal.hpp.

relative_residual

template<typename _Scalar >

Scalar relative_residual

Relatice residual between two iterates.

Definition at line 106 of file proximal.hpp.

---

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

• include/pinocchio/algorithm/fwd.hpp
• include/pinocchio/algorithm/proximal.hpp