proxsuite::nlp::ResultsTpl< _Scalar > Struct Template Reference

Results struct, holding the returned data from the solver. More...

#include <proxsuite-nlp/results.hpp>

Collaboration diagram for proxsuite::nlp::ResultsTpl< _Scalar >:

Public Types
using	Scalar = _Scalar
using	Problem = ProblemTpl<Scalar>
using	VecBool = Eigen::Matrix<bool, Eigen::Dynamic, 1>

Public Member Functions
	ResultsTpl (const Problem &prob)

Public Attributes
	Scalar
ConvergenceFlag	converged = SUCCESS
Scalar	merit
Scalar	value
VectorXs	x_opt
VectorXs	data_lams_opt
VectorOfRef	lams_opt
std::vector< VecBool >	active_set
	Current active set of the algorithm.
Scalar	dual_infeas = 0.
	Dual infeasibility error.
Scalar	prim_infeas = 0.
	Primal infeasibility error.
VectorXs	constraint_violations
	Violations for each constraint.
std::size_t	num_iters = 0
	Final solver parameters.
std::size_t	al_iters = 0
Scalar	mu
Scalar	rho

Friends
std::ostream &	operator<< (std::ostream &oss, const ResultsTpl< Scalar > &self)

Detailed Description

template<typename _Scalar>
struct proxsuite::nlp::ResultsTpl< _Scalar >

Results struct, holding the returned data from the solver.

This struct holds the current (and output) primal-dual point, the optimal proximal parameters \((\rho, \mu)\).

Definition at line 20 of file results.hpp.

Member Typedef Documentation

Scalar

template<typename _Scalar >

using proxsuite::nlp::ResultsTpl< _Scalar >::Scalar = _Scalar

Definition at line 21 of file results.hpp.

Problem

template<typename _Scalar >

using proxsuite::nlp::ResultsTpl< _Scalar >::Problem = ProblemTpl<Scalar>

Definition at line 23 of file results.hpp.

VecBool

template<typename _Scalar >

using proxsuite::nlp::ResultsTpl< _Scalar >::VecBool = Eigen::Matrix<bool, Eigen::Dynamic, 1>

Definition at line 24 of file results.hpp.

Constructor & Destructor Documentation

ResultsTpl()

template<typename _Scalar >

proxsuite::nlp::ResultsTpl< _Scalar >::ResultsTpl ( const Problem & prob )

inline

Definition at line 48 of file results.hpp.

Friends And Related Symbol Documentation

operator<<

template<typename _Scalar >

std::ostream & operator<< ( std::ostream & oss, const ResultsTpl< Scalar > & self )

friend

Definition at line 61 of file results.hpp.

Member Data Documentation

Scalar

template<typename _Scalar >

proxsuite::nlp::ResultsTpl< _Scalar >::Scalar

Definition at line 22 of file results.hpp.

converged

template<typename _Scalar >

ConvergenceFlag proxsuite::nlp::ResultsTpl< _Scalar >::converged = SUCCESS

Definition at line 26 of file results.hpp.

merit

template<typename _Scalar >

Scalar proxsuite::nlp::ResultsTpl< _Scalar >::merit

Definition at line 28 of file results.hpp.

value

template<typename _Scalar >

Scalar proxsuite::nlp::ResultsTpl< _Scalar >::value

Definition at line 29 of file results.hpp.

x_opt

template<typename _Scalar >

VectorXs proxsuite::nlp::ResultsTpl< _Scalar >::x_opt

Definition at line 30 of file results.hpp.

data_lams_opt

template<typename _Scalar >

VectorXs proxsuite::nlp::ResultsTpl< _Scalar >::data_lams_opt

Definition at line 31 of file results.hpp.

lams_opt

template<typename _Scalar >

VectorOfRef proxsuite::nlp::ResultsTpl< _Scalar >::lams_opt

Definition at line 32 of file results.hpp.

active_set

template<typename _Scalar >

std::vector<VecBool> proxsuite::nlp::ResultsTpl< _Scalar >::active_set

Current active set of the algorithm.

Definition at line 34 of file results.hpp.

dual_infeas

template<typename _Scalar >

Scalar proxsuite::nlp::ResultsTpl< _Scalar >::dual_infeas = 0.

Dual infeasibility error.

Definition at line 36 of file results.hpp.

prim_infeas

template<typename _Scalar >

Scalar proxsuite::nlp::ResultsTpl< _Scalar >::prim_infeas = 0.

Primal infeasibility error.

Definition at line 38 of file results.hpp.

constraint_violations

template<typename _Scalar >

VectorXs proxsuite::nlp::ResultsTpl< _Scalar >::constraint_violations

Violations for each constraint.

Definition at line 40 of file results.hpp.

num_iters

template<typename _Scalar >

std::size_t proxsuite::nlp::ResultsTpl< _Scalar >::num_iters = 0

Final solver parameters.

Definition at line 43 of file results.hpp.

al_iters

template<typename _Scalar >

std::size_t proxsuite::nlp::ResultsTpl< _Scalar >::al_iters = 0

Definition at line 44 of file results.hpp.

mu

template<typename _Scalar >

Scalar proxsuite::nlp::ResultsTpl< _Scalar >::mu

Definition at line 45 of file results.hpp.

rho

template<typename _Scalar >

Scalar proxsuite::nlp::ResultsTpl< _Scalar >::rho

Definition at line 46 of file results.hpp.

---

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

• include/proxsuite-nlp/fwd.hpp
• include/proxsuite-nlp/results.hpp