LSLOpt  1.0
Static Public Member Functions | List of all members
LSLOpt::Implementation::MaxStepLengthIdentifierTrait< Problem, Scalar > Struct Template Reference

The max step length identifier. More...

#include <ProblemTraits.hpp>

Static Public Member Functions

static Scalar initial_step_length (Problem &problem, const Vector< Scalar > &x, const Vector< Scalar > &p)
 Get the initial step length from problem. More...
 
static Scalar change_acceptable (Problem &problem, const Vector< Scalar > &x0, const Vector< Scalar > &x)
 Check if suggested step is acceptable. More...
 
static bool is_check_acceptable_first (Problem &problem)
 Check if change acceptability should be checked first. More...
 

Detailed Description

template<typename Problem, typename Scalar>
struct LSLOpt::Implementation::MaxStepLengthIdentifierTrait< Problem, Scalar >

The max step length identifier.

Member Function Documentation

◆ change_acceptable()

template<typename Problem , typename Scalar >
static Scalar LSLOpt::Implementation::MaxStepLengthIdentifierTrait< Problem, Scalar >::change_acceptable ( Problem &  problem,
const Vector< Scalar > &  x0,
const Vector< Scalar > &  x 
)
inlinestatic

Check if suggested step is acceptable.

Parameters
problemThe optimization problem.
x0Current value.
xSuggested new value.
Returns
If change is acceptable.

◆ initial_step_length()

template<typename Problem , typename Scalar >
static Scalar LSLOpt::Implementation::MaxStepLengthIdentifierTrait< Problem, Scalar >::initial_step_length ( Problem &  problem,
const Vector< Scalar > &  x,
const Vector< Scalar > &  p 
)
inlinestatic

Get the initial step length from problem.

Parameters
problemThe optimization problem.
xCurrent value.
pSearch direction.
Returns
The initial step length.

◆ is_check_acceptable_first()

template<typename Problem , typename Scalar >
static bool LSLOpt::Implementation::MaxStepLengthIdentifierTrait< Problem, Scalar >::is_check_acceptable_first ( Problem &  problem)
inlinestatic

Check if change acceptability should be checked first.

Parameters
problemThe optimization problem.
Returns
true If acceptability is to be checked first.

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