Structure containing all the settings paramters for the proximal algorithms. More...
#include <fwd.hpp>
Public Types | |
| typedef _Scalar | Scalar |
Public Member Functions | |
| ProximalSettingsTpl () | |
| Default constructor. More... | |
| ProximalSettingsTpl (const Scalar absolute_accuracy, const Scalar relative_accuracy, const Scalar mu, const int max_iter) | |
| Constructor with all the setting parameters. More... | |
| ProximalSettingsTpl (const Scalar accuracy, const Scalar mu, const int max_iter) | |
| Constructor with all the setting parameters. More... | |
Public Attributes | |
| Scalar | absolute_accuracy |
| Absolute proximal accuracy. More... | |
| Scalar | absolute_residual |
| Absolute residual. More... | |
| int | iter |
| Total number of iterations of the algorithm when it has converged or reached the maximal number of allowed iterations. More... | |
| int | max_iter |
| Maximal number of iterations. More... | |
| Scalar | mu |
| Regularization parameter of the Proximal algorithms. More... | |
| Scalar | relative_accuracy |
| Relative proximal accuracy between two iterates. More... | |
| Scalar | relative_residual |
| Relatice residual between two iterates. More... | |
Structure containing all the settings paramters for the proximal algorithms.
| _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 13 of file algorithm/fwd.hpp.
| typedef _Scalar pinocchio::ProximalSettingsTpl< _Scalar >::Scalar |
Definition at line 26 of file algorithm/proximal.hpp.
|
inline |
Default constructor.
Definition at line 29 of file algorithm/proximal.hpp.
|
inline |
Constructor with all the setting parameters.
Definition at line 43 of file algorithm/proximal.hpp.
|
inline |
Constructor with all the setting parameters.
Definition at line 62 of file algorithm/proximal.hpp.
| Scalar pinocchio::ProximalSettingsTpl< _Scalar >::absolute_accuracy |
Absolute proximal accuracy.
Definition at line 89 of file algorithm/proximal.hpp.
| Scalar pinocchio::ProximalSettingsTpl< _Scalar >::absolute_residual |
Absolute residual.
Definition at line 103 of file algorithm/proximal.hpp.
| int pinocchio::ProximalSettingsTpl< _Scalar >::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 algorithm/proximal.hpp.
| int pinocchio::ProximalSettingsTpl< _Scalar >::max_iter |
Maximal number of iterations.
Definition at line 98 of file algorithm/proximal.hpp.
| Scalar pinocchio::ProximalSettingsTpl< _Scalar >::mu |
Regularization parameter of the Proximal algorithms.
Definition at line 95 of file algorithm/proximal.hpp.
| Scalar pinocchio::ProximalSettingsTpl< _Scalar >::relative_accuracy |
Relative proximal accuracy between two iterates.
Definition at line 92 of file algorithm/proximal.hpp.
| Scalar pinocchio::ProximalSettingsTpl< _Scalar >::relative_residual |
Relatice residual between two iterates.
Definition at line 106 of file algorithm/proximal.hpp.