aligator::SolverProxDDPTpl< _Scalar >::LinesearchVariant Struct Reference

#include <aligator/solvers/proxddp/solver-proxddp.hpp>

Public Types
using	VariantType

Public Member Functions
Scalar	run (const std::function< Scalar(Scalar)> &fun, const Scalar phi0, const Scalar dphi0, Scalar &alpha_try)
void	reset ()
bool	isValid () const
	operator const VariantType & () const

Detailed Description

template<typename _Scalar>
struct aligator::SolverProxDDPTpl< _Scalar >::LinesearchVariant

Definition at line 58 of file solver-proxddp.hpp.

Member Typedef Documentation

VariantType

template<typename _Scalar>

using aligator::SolverProxDDPTpl< _Scalar >::LinesearchVariant::VariantType

Initial value:

 std::variant<std::monostate, ArmijoLinesearch<Scalar>,
                                     NonmonotoneLinesearch<Scalar>>

Definition at line 59 of file solver-proxddp.hpp.

Member Function Documentation

run()

template<typename _Scalar>

Scalar aligator::SolverProxDDPTpl< _Scalar >::LinesearchVariant::run ( const std::function< Scalar(Scalar)> & fun, const Scalar phi0, const Scalar dphi0, Scalar & alpha_try )

inline

Definition at line 62 of file solver-proxddp.hpp.

reset()

template<typename _Scalar>

void aligator::SolverProxDDPTpl< _Scalar >::LinesearchVariant::reset ( )

inline

Definition at line 74 of file solver-proxddp.hpp.

isValid()

template<typename _Scalar>

bool aligator::SolverProxDDPTpl< _Scalar >::LinesearchVariant::isValid ( ) const

inlinenodiscard

Definition at line 80 of file solver-proxddp.hpp.

operator const VariantType &()

template<typename _Scalar>

aligator::SolverProxDDPTpl< _Scalar >::LinesearchVariant::operator const VariantType & ( ) const

inline

Definition at line 82 of file solver-proxddp.hpp.

---

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

• include/aligator/solvers/proxddp/solver-proxddp.hpp