proxsuite::nlp::helpers::history_callback< Scalar > Struct Template Reference

Store the history of results. More...

#include <proxsuite-nlp/helpers/history-callback.hpp>

Inheritance diagram for proxsuite::nlp::helpers::history_callback< Scalar >:

Collaboration diagram for proxsuite::nlp::helpers::history_callback< Scalar >:

Public Member Functions
	history_callback (bool store_pd_vars=true, bool store_values=true, bool store_residuals=true)
void	call (const WorkspaceTpl< Scalar > &workspace, const ResultsTpl< Scalar > &results)
Public Member Functions inherited from proxsuite::nlp::helpers::base_callback< Scalar >
virtual	~base_callback ()=default

Public Attributes
	Scalar
struct {
std::vector< VectorXs >   xs
std::vector< VectorXs >   lams
std::vector< VectorOfRef >   lams_view
std::vector< Scalar >   values
std::vector< Scalar >   prim_infeas
std::vector< Scalar >   dual_infeas
std::vector< VectorXs >   ls_alphas
std::vector< VectorXs >   ls_values
std::vector< Scalar >   alphas
	Linesearch step-lengths. More...
std::vector< Scalar >   dmerit_dir
}	storage

Protected Attributes
const bool	store_primal_dual_vars_
const bool	store_values_
const bool	store_residuals_

Detailed Description

template<typename Scalar>
struct proxsuite::nlp::helpers::history_callback< Scalar >

Store the history of results.

Definition at line 15 of file history-callback.hpp.

Constructor & Destructor Documentation

history_callback()

template<typename Scalar >

proxsuite::nlp::helpers::history_callback< Scalar >::history_callback ( bool store_pd_vars = true, bool store_values = true, bool store_residuals = true )

inline

Definition at line 16 of file history-callback.hpp.

Member Function Documentation

call()

template<typename Scalar >

void proxsuite::nlp::helpers::history_callback< Scalar >::call ( const WorkspaceTpl< Scalar > & workspace, const ResultsTpl< Scalar > & results )

inlinevirtual

Implements proxsuite::nlp::helpers::base_callback< Scalar >.

Definition at line 37 of file history-callback.hpp.

Member Data Documentation

Scalar

template<typename Scalar >

proxsuite::nlp::helpers::history_callback< Scalar >::Scalar

Definition at line 21 of file history-callback.hpp.

xs

template<typename Scalar >

std::vector<VectorXs> proxsuite::nlp::helpers::history_callback< Scalar >::xs

Definition at line 24 of file history-callback.hpp.

lams

template<typename Scalar >

std::vector<VectorXs> proxsuite::nlp::helpers::history_callback< Scalar >::lams

Definition at line 25 of file history-callback.hpp.

lams_view

template<typename Scalar >

std::vector<VectorOfRef> proxsuite::nlp::helpers::history_callback< Scalar >::lams_view

Definition at line 26 of file history-callback.hpp.

values

template<typename Scalar >

std::vector<Scalar> proxsuite::nlp::helpers::history_callback< Scalar >::values

Definition at line 27 of file history-callback.hpp.

prim_infeas

template<typename Scalar >

std::vector<Scalar> proxsuite::nlp::helpers::history_callback< Scalar >::prim_infeas

Definition at line 28 of file history-callback.hpp.

dual_infeas

template<typename Scalar >

std::vector<Scalar> proxsuite::nlp::helpers::history_callback< Scalar >::dual_infeas

Definition at line 29 of file history-callback.hpp.

ls_alphas

template<typename Scalar >

std::vector<VectorXs> proxsuite::nlp::helpers::history_callback< Scalar >::ls_alphas

Definition at line 30 of file history-callback.hpp.

ls_values

template<typename Scalar >

std::vector<VectorXs> proxsuite::nlp::helpers::history_callback< Scalar >::ls_values

Definition at line 31 of file history-callback.hpp.

alphas

template<typename Scalar >

std::vector<Scalar> proxsuite::nlp::helpers::history_callback< Scalar >::alphas

Linesearch step-lengths.

Definition at line 33 of file history-callback.hpp.

dmerit_dir

template<typename Scalar >

std::vector<Scalar> proxsuite::nlp::helpers::history_callback< Scalar >::dmerit_dir

Definition at line 34 of file history-callback.hpp.

[struct]

struct { ... } proxsuite::nlp::helpers::history_callback< Scalar >::storage

store_primal_dual_vars_

template<typename Scalar >

const bool proxsuite::nlp::helpers::history_callback< Scalar >::store_primal_dual_vars_

protected

Definition at line 60 of file history-callback.hpp.

store_values_

template<typename Scalar >

const bool proxsuite::nlp::helpers::history_callback< Scalar >::store_values_

protected

Definition at line 61 of file history-callback.hpp.

store_residuals_

template<typename Scalar >

const bool proxsuite::nlp::helpers::history_callback< Scalar >::store_residuals_

protected

Definition at line 62 of file history-callback.hpp.

---

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

• include/proxsuite-nlp/helpers/history-callback.hpp