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 |
 Public Member Functions inherited from autoware::common::optimization::LineSearch< FixedLineSearch > | |
| LineSearch (const StepT step_max=std::numeric_limits< StepT >::min()) | |
| DomainValueT | compute_next_step (const DomainValueT &x0, const DomainValueT &initial_step, OptimizationProblemT &optimization_problem) |
| StepT | get_step_max () const noexcept |
| void | set_step_max (const StepT step_max) noexcept |
Additional Inherited Members | |
| Public Types inherited from autoware::common::optimization::LineSearch< FixedLineSearch > | |
| using | StepT = float_t |
| 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()
|
inlineexplicit |
Constructor.
- Parameters
-
step Fixed step to be used.
Member Function Documentation
◆ compute_next_step()
template<typename DomainValueT , typename OptimizationProblemT >
|
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: