Autoware.Auto
autoware::common::optimization::FixedLineSearch Class Reference

Class to use a fixed step length during optimization. More...

#include <fixed_line_search.hpp>

Inheritance diagram for autoware::common::optimization::FixedLineSearch:
Collaboration diagram for autoware::common::optimization::FixedLineSearch:

Public Member Functions

 FixedLineSearch (const StepT step=std::numeric_limits< StepT >::min())
 
template<typename DomainValueT , typename OptimizationProblemT >
DomainValueT compute_next_step (const DomainValueT &, DomainValueT &step_direction, OptimizationProblemT &) const noexcept
 

Additional Inherited Members

- Protected Member Functions inherited from autoware::common::helper_functions::crtp< FixedLineSearch >
const FixedLineSearch & impl () const
 
FixedLineSearch & impl ()
 

Detailed Description

Class to use a fixed step length during optimization.

Constructor & Destructor Documentation

◆ FixedLineSearch()

autoware::common::optimization::FixedLineSearch::FixedLineSearch ( const StepT  step = std::numeric_limits<StepT>::min())
inlineexplicit

Constructor.

Parameters
stepFixed step to be used.

Member Function Documentation

◆ compute_next_step()

template<typename DomainValueT , typename OptimizationProblemT >
DomainValueT autoware::common::optimization::FixedLineSearch::compute_next_step ( const DomainValueT &  ,
DomainValueT &  step_direction,
OptimizationProblemT &   
) const
inlinenoexcept

Returns directly the pre-set (maximum) step length

Returns
The fixed step length.

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