aligator::FilterTpl< Scalar > Struct Template Reference

A basic filter line-search strategy. More...

#include <aligator/core/filter.hpp>

Collaboration diagram for aligator::FilterTpl< Scalar >:

Public Member Functions
	ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
	FilterTpl (const Scalar &beta, const Scalar &alpha_min, const std::size_t &max_num_steps)
virtual	~FilterTpl ()=default
void	resetFilter (const Scalar &beta, const Scalar &alpha_min, const std::size_t &max_num_steps)
Scalar	run (const std::function< std::pair< Scalar, Scalar >(Scalar)> &phi, Scalar &alpha_try)
bool	accept_pair (const std::pair< Scalar, Scalar > &fpair)

Public Attributes
std::vector< std::pair< Scalar, Scalar > >	filter_pairs_
Scalar	beta_
Scalar	alpha_min_
std::size_t	max_num_steps_

Detailed Description

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

A basic filter line-search strategy.

Definition at line 131 of file fwd.hpp.

Constructor & Destructor Documentation

FilterTpl()

template<typename Scalar >

aligator::FilterTpl< Scalar >::FilterTpl ( const Scalar & beta, const Scalar & alpha_min, const std::size_t & max_num_steps )

inline

Definition at line 24 of file filter.hpp.

~FilterTpl()

template<typename Scalar >

virtual aligator::FilterTpl< Scalar >::~FilterTpl ( )

virtualdefault

Member Function Documentation

ALIGATOR_DYNAMIC_TYPEDEFS()

template<typename Scalar >

aligator::FilterTpl< Scalar >::ALIGATOR_DYNAMIC_TYPEDEFS

(

Scalar

)

resetFilter()

template<typename Scalar >

void aligator::FilterTpl< Scalar >::resetFilter ( const Scalar & beta, const Scalar & alpha_min, const std::size_t & max_num_steps )

inline

Definition at line 34 of file filter.hpp.

run()

template<typename Scalar >

Scalar aligator::FilterTpl< Scalar >::run ( const std::function< std::pair< Scalar, Scalar >(Scalar)> & phi, Scalar & alpha_try )

inline

Definition at line 42 of file filter.hpp.

accept_pair()

template<typename Scalar >

bool aligator::FilterTpl< Scalar >::accept_pair ( const std::pair< Scalar, Scalar > & fpair )

inline

Definition at line 78 of file filter.hpp.

Member Data Documentation

filter_pairs_

template<typename Scalar >

std::vector<std::pair<Scalar, Scalar> > aligator::FilterTpl< Scalar >::filter_pairs_

Definition at line 17 of file filter.hpp.

beta_

template<typename Scalar >

Scalar aligator::FilterTpl< Scalar >::beta_

Definition at line 20 of file filter.hpp.

alpha_min_

template<typename Scalar >

Scalar aligator::FilterTpl< Scalar >::alpha_min_

Definition at line 21 of file filter.hpp.

max_num_steps_

template<typename Scalar >

std::size_t aligator::FilterTpl< Scalar >::max_num_steps_

Definition at line 22 of file filter.hpp.

---

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

• include/aligator/core/filter.hpp
• include/aligator/fwd.hpp