robotoc::LineSearchFilter Class Reference

Filter of the line search. More...

#include <line_search_filter.hpp>

Public Member Functions
	LineSearchFilter (const double cost_reduction_rate=0.005, const double constraint_violation_reduction_rate=0.005)
	Construct a line search filter. More...
	~LineSearchFilter ()=default
	Default destructor. More...
	LineSearchFilter (const LineSearchFilter &)=default
	Default copy constructor. More...
LineSearchFilter &	operator= (const LineSearchFilter &)=default
	Default copy assign operator. More...
	LineSearchFilter (LineSearchFilter &&) noexcept=default
	Default move constructor. More...
LineSearchFilter &	operator= (LineSearchFilter &&) noexcept=default
	Default move assign operator. More...
bool	isAccepted (const double cost, const double constraint_violation) const
	Check wheather the pair of cost and constraint violation is accepted by the filter or not. More...
void	augment (const double cost, const double constraint_violation)
	Augment the pair of cost and constraint violation to the filter. More...
void	clear ()
	Clears the filter. More...
bool	isEmpty () const
	Checks wheather the filter is empty or not. More...

Detailed Description

Filter of the line search.

Constructor & Destructor Documentation

LineSearchFilter() [1/3]

robotoc::LineSearchFilter::LineSearchFilter	(	const double	cost_reduction_rate = 0.005,
		const double	constraint_violation_reduction_rate = 0.005
	)

Construct a line search filter.

Parameters

[in]	cost_reduction_rate	Reduction rate of the cost. Default is 0.005.
[in]	constraint_violation_reduction_rate	Reduction rate of the constraint violation. Default is 0.005

~LineSearchFilter()

robotoc::LineSearchFilter::~LineSearchFilter ( )

default

Default destructor.

LineSearchFilter() [2/3]

robotoc::LineSearchFilter::LineSearchFilter ( const LineSearchFilter &  )

default

Default copy constructor.

LineSearchFilter() [3/3]

robotoc::LineSearchFilter::LineSearchFilter ( LineSearchFilter &&  )

defaultnoexcept

Default move constructor.

Member Function Documentation

augment()

void robotoc::LineSearchFilter::augment	(	const double	cost,
		const double	constraint_violation
	)

Augment the pair of cost and constraint violation to the filter.

Parameters

[in]	cost	Value of the cost.
[in]	constraint_violation	Value of the constraint violation.

clear()

void robotoc::LineSearchFilter::clear

(

)

Clears the filter.

isAccepted()

bool robotoc::LineSearchFilter::isAccepted	(	const double	cost,
		const double	constraint_violation
	)		const

Check wheather the pair of cost and constraint violation is accepted by the filter or not.

Parameters

[in]	cost	Value of the cost.
[in]	constraint_violation	Value of the constraint violation.

Returns

true if the pair of cost and constraint violation is accepted. false if not.

isEmpty()

bool robotoc::LineSearchFilter::isEmpty

(

)

const

Checks wheather the filter is empty or not.

Returns

true if the filter is empty. false if not.

operator=() [1/2]

LineSearchFilter & robotoc::LineSearchFilter::operator= ( const LineSearchFilter &  )

default

Default copy assign operator.

operator=() [2/2]

LineSearchFilter & robotoc::LineSearchFilter::operator= ( LineSearchFilter &&  )

defaultnoexcept

Default move assign operator.

---

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

• /github/workspace/include/robotoc/line_search/line_search_filter.hpp