aligator::HistoryCallbackTpl< Scalar > Struct Template Reference

Store the history of results. More...

#include <aligator/helpers/history-callback.hpp>

Inheritance diagram for aligator::HistoryCallbackTpl< Scalar >:

Collaboration diagram for aligator::HistoryCallbackTpl< Scalar >:

Public Types
using	Workspace = WorkspaceBaseTpl<Scalar>
using	Results = ResultsBaseTpl<Scalar>
Public Types inherited from aligator::CallbackBaseTpl< Scalar >
using	Workspace = WorkspaceBaseTpl<Scalar>
using	Results = ResultsBaseTpl<Scalar>

Public Member Functions
	HistoryCallbackTpl (bool store_pd_vars=false, bool store_values=true, bool store_residuals=true)
	ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
void	call (const Workspace &, const Results &results)
Public Member Functions inherited from aligator::CallbackBaseTpl< Scalar >
virtual	~CallbackBaseTpl ()=default

Public Attributes
std::vector< std::vector< VectorXs > >	xs
std::vector< std::vector< VectorXs > >	us
std::vector< std::vector< VectorXs > >	lams
std::vector< Scalar >	values
std::vector< Scalar >	merit_values
std::vector< Scalar >	prim_infeas
std::vector< Scalar >	dual_infeas
std::vector< Scalar >	inner_crits
std::vector< std::size_t >	al_index
std::vector< Scalar >	prim_tols
std::vector< Scalar >	dual_tols
bool	store_primal_dual_vars_
bool	store_values_
bool	store_residuals_

Detailed Description

template<typename Scalar>
struct aligator::HistoryCallbackTpl< Scalar >

Store the history of results.

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

Member Typedef Documentation

Workspace

template<typename Scalar >

using aligator::HistoryCallbackTpl< Scalar >::Workspace = WorkspaceBaseTpl<Scalar>

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

Results

template<typename Scalar >

using aligator::HistoryCallbackTpl< Scalar >::Results = ResultsBaseTpl<Scalar>

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

Constructor & Destructor Documentation

HistoryCallbackTpl()

template<typename Scalar >

aligator::HistoryCallbackTpl< Scalar >::HistoryCallbackTpl ( bool store_pd_vars = false, bool store_values = true, bool store_residuals = true )

inline

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

Member Function Documentation

ALIGATOR_DYNAMIC_TYPEDEFS()

template<typename Scalar >

aligator::HistoryCallbackTpl< Scalar >::ALIGATOR_DYNAMIC_TYPEDEFS

(

Scalar

)

call()

template<typename Scalar >

void aligator::HistoryCallbackTpl< Scalar >::call ( const Workspace & , const Results & results )

inlinevirtual

Implements aligator::CallbackBaseTpl< Scalar >.

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

Member Data Documentation

xs

template<typename Scalar >

std::vector<std::vector<VectorXs> > aligator::HistoryCallbackTpl< Scalar >::xs

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

us

template<typename Scalar >

std::vector<std::vector<VectorXs> > aligator::HistoryCallbackTpl< Scalar >::us

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

lams

template<typename Scalar >

std::vector<std::vector<VectorXs> > aligator::HistoryCallbackTpl< Scalar >::lams

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

values

template<typename Scalar >

std::vector<Scalar> aligator::HistoryCallbackTpl< Scalar >::values

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

merit_values

template<typename Scalar >

std::vector<Scalar> aligator::HistoryCallbackTpl< Scalar >::merit_values

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

prim_infeas

template<typename Scalar >

std::vector<Scalar> aligator::HistoryCallbackTpl< Scalar >::prim_infeas

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

dual_infeas

template<typename Scalar >

std::vector<Scalar> aligator::HistoryCallbackTpl< Scalar >::dual_infeas

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

inner_crits

template<typename Scalar >

std::vector<Scalar> aligator::HistoryCallbackTpl< Scalar >::inner_crits

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

al_index

template<typename Scalar >

std::vector<std::size_t> aligator::HistoryCallbackTpl< Scalar >::al_index

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

prim_tols

template<typename Scalar >

std::vector<Scalar> aligator::HistoryCallbackTpl< Scalar >::prim_tols

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

dual_tols

template<typename Scalar >

std::vector<Scalar> aligator::HistoryCallbackTpl< Scalar >::dual_tols

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

store_primal_dual_vars_

template<typename Scalar >

bool aligator::HistoryCallbackTpl< Scalar >::store_primal_dual_vars_

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

store_values_

template<typename Scalar >

bool aligator::HistoryCallbackTpl< Scalar >::store_values_

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

store_residuals_

template<typename Scalar >

bool aligator::HistoryCallbackTpl< Scalar >::store_residuals_

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

---

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

• include/aligator/helpers/history-callback.hpp