Settings for the line search. More...

#include <line_search_settings.hpp>

Public Member Functions
void	disp (std::ostream &os) const
	Displays the line search settings onto a ostream. More...

Public Attributes
LineSearchMethod	line_search_method = LineSearchMethod::Filter
	If set to LineSearchMethod::Filter, filter method is used as a search scheme. If set to LineSearchMethod::MeritBacktracking, backtracking line search is used. More...

double	step_size_reduction_rate = 0.75
	Reduction rate of the step size. More...

double	min_step_size = 0.05
	Minimum step size. More...

double	filter_cost_reduction_rate = 0.005
	The reduction rate of the cost in the filter line search method. More...

double	filter_constraint_violation_reduction_rate = 0.005
	The reduction rate of the constraint violation in the filter line search method. More...

double	armijo_control_rate = 0.001
	Control rate in Armijo condition. This value sets the slope of the linear approximation in the Armijo condition. More...

double	margin_rate = 0.05
	Margin rate to determine penalty parameter in the merit function. More...

double	eps = 1.0e-08
	A small positive value. Used to calculate directional derivative. More...

Friends
std::ostream &	operator<< (std::ostream &os, const LineSearchSettings &line_search_settings)

Detailed Description

Settings for the line search.

Member Function Documentation

◆ disp()

void robotoc::LineSearchSettings::disp ( std::ostream & os ) const

Displays the line search settings onto a ostream.

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const LineSearchSettings &	line_search_settings
	)

friend

Member Data Documentation

◆ armijo_control_rate

double robotoc::LineSearchSettings::armijo_control_rate = 0.001

Control rate in Armijo condition. This value sets the slope of the linear approximation in the Armijo condition.

◆ eps

double robotoc::LineSearchSettings::eps = 1.0e-08

A small positive value. Used to calculate directional derivative.

◆ filter_constraint_violation_reduction_rate

double robotoc::LineSearchSettings::filter_constraint_violation_reduction_rate = 0.005

The reduction rate of the constraint violation in the filter line search method.

◆ filter_cost_reduction_rate

double robotoc::LineSearchSettings::filter_cost_reduction_rate = 0.005

The reduction rate of the cost in the filter line search method.

◆ line_search_method

LineSearchMethod robotoc::LineSearchSettings::line_search_method = LineSearchMethod::Filter

If set to LineSearchMethod::Filter, filter method is used as a search scheme. If set to LineSearchMethod::MeritBacktracking, backtracking line search is used.

◆ margin_rate

double robotoc::LineSearchSettings::margin_rate = 0.05

Margin rate to determine penalty parameter in the merit function.

◆ min_step_size

double robotoc::LineSearchSettings::min_step_size = 0.05

Minimum step size.

◆ step_size_reduction_rate

double robotoc::LineSearchSettings::step_size_reduction_rate = 0.75

Reduction rate of the step size.

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

/github/workspace/include/robotoc/line_search/line_search_settings.hpp

Public Member Functions

Public Attributes

Friends