aligator::ArmijoLinesearch< Scalar > Class Template Reference

Basic backtracking Armijo line-search strategy. More...

#include <aligator/core/linesearch-armijo.hpp>

Inheritance diagram for aligator::ArmijoLinesearch< Scalar >:

Collaboration diagram for aligator::ArmijoLinesearch< Scalar >:

Public Types
using	Base = Linesearch<Scalar>
using	FunctionSample = typename Base::FunctionSample
using	Polynomial = PolynomialTpl<Scalar>
using	VectorXs = typename math_types<Scalar>::VectorXs
using	Matrix2s = Eigen::Matrix<Scalar, 2, 2>
using	Vector2s = Eigen::Matrix<Scalar, 2, 1>
using	Options
Public Types inherited from aligator::Linesearch< Scalar >
using	Options
using	Options

Public Member Functions
	ArmijoLinesearch (const Options &options) noexcept
Scalar	run (const std::function< Scalar(Scalar)> &phi, const Scalar phi0, const Scalar dphi0, Scalar &alpha_try)
Scalar	minimize_interpolant (LSInterpolation strat, Scalar min_step_size, Scalar max_step_size)
	Propose a new candidate step size through safeguarded interpolation.
Public Member Functions inherited from aligator::Linesearch< Scalar >
	Linesearch (const Linesearch::Options &options) noexcept
	~Linesearch ()=default
void	setOptions (const Linesearch::Options &options)
void	reset ()
	Linesearch (const Linesearch::Options &options) noexcept
	~Linesearch ()=default
void	setOptions (const Linesearch::Options &options)
void	reset ()

Public Attributes
Linesearch::Options	options_
Public Attributes inherited from aligator::Linesearch< Scalar >
Linesearch::Options	options_
Linesearch::Options	options_

Protected Attributes
Polynomial	interpolant
std::vector< FunctionSample >	samples

Detailed Description

template<typename Scalar>
class aligator::ArmijoLinesearch< Scalar >

Basic backtracking Armijo line-search strategy.

Definition at line 45 of file linesearch-armijo.hpp.

Member Typedef Documentation

Base

template<typename Scalar>

using aligator::ArmijoLinesearch< Scalar >::Base = Linesearch<Scalar>

Definition at line 47 of file linesearch-armijo.hpp.

FunctionSample

template<typename Scalar>

using aligator::ArmijoLinesearch< Scalar >::FunctionSample = typename Base::FunctionSample

Definition at line 50 of file linesearch-armijo.hpp.

Polynomial

template<typename Scalar>

using aligator::ArmijoLinesearch< Scalar >::Polynomial = PolynomialTpl<Scalar>

Definition at line 51 of file linesearch-armijo.hpp.

VectorXs

template<typename Scalar>

using aligator::ArmijoLinesearch< Scalar >::VectorXs = typename math_types<Scalar>::VectorXs

Definition at line 52 of file linesearch-armijo.hpp.

Matrix2s

template<typename Scalar>

using aligator::ArmijoLinesearch< Scalar >::Matrix2s = Eigen::Matrix<Scalar, 2, 2>

Definition at line 53 of file linesearch-armijo.hpp.

Vector2s

template<typename Scalar>

using aligator::ArmijoLinesearch< Scalar >::Vector2s = Eigen::Matrix<Scalar, 2, 1>

Definition at line 54 of file linesearch-armijo.hpp.

Options

template<typename Scalar>

using aligator::Linesearch< Scalar >::Options

Definition at line 48 of file linesearch-base.hpp.

Constructor & Destructor Documentation

ArmijoLinesearch()

template<typename Scalar>

aligator::ArmijoLinesearch< Scalar >::ArmijoLinesearch ( const Options & options )

inlineexplicitnoexcept

Definition at line 56 of file linesearch-armijo.hpp.

Member Function Documentation

run()

template<typename Scalar>

Scalar aligator::ArmijoLinesearch< Scalar >::run ( const std::function< Scalar(Scalar)> & phi, const Scalar phi0, const Scalar dphi0, Scalar & alpha_try )

inline

Definition at line 59 of file linesearch-armijo.hpp.

minimize_interpolant()

template<typename Scalar>

Scalar aligator::ArmijoLinesearch< Scalar >::minimize_interpolant ( LSInterpolation strat, Scalar min_step_size, Scalar max_step_size )

inline

Propose a new candidate step size through safeguarded interpolation.

Solver for the 2x2 linear system

Definition at line 150 of file linesearch-armijo.hpp.

Member Data Documentation

interpolant

template<typename Scalar>

Polynomial aligator::ArmijoLinesearch< Scalar >::interpolant

protected

Definition at line 225 of file linesearch-armijo.hpp.

samples

template<typename Scalar>

std::vector<FunctionSample> aligator::ArmijoLinesearch< Scalar >::samples

protected

Definition at line 226 of file linesearch-armijo.hpp.

options_

template<typename Scalar>

Linesearch::Options aligator::Linesearch< Scalar >::options_

Definition at line 79 of file linesearch-base.hpp.

---

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

• include/aligator/core/linesearch-armijo.hpp