Autoware.Auto
autoware::common::optimization::NewtonsMethodOptimizer< LineSearchT > Class Template Reference

Optimizer using the Newton method with line search. More...

#include <newtons_method_optimizer.hpp>

Inheritance diagram for autoware::common::optimization::NewtonsMethodOptimizer< LineSearchT >:
Collaboration diagram for autoware::common::optimization::NewtonsMethodOptimizer< LineSearchT >:

Public Types

using StepT = float_t
 

Public Member Functions

 NewtonsMethodOptimizer (const LineSearchT &line_searcher, const OptimizationOptions &options)
 
template<typename OptimizationProblemT , typename DomainValueT , typename EigenSolverT >
OptimizationSummary solve_ (OptimizationProblemT &optimization_problem, const DomainValueT &x0, DomainValueT &x_out)
 
- Public Member Functions inherited from autoware::common::optimization::Optimizer< NewtonsMethodOptimizer< LineSearchT > >
OptimizationSummary solve (OptimizationProblemT &optimization_problem, const DomainValueT &x0, DomainValueT &x_out)
 

Additional Inherited Members

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

Detailed Description

template<typename LineSearchT>
class autoware::common::optimization::NewtonsMethodOptimizer< LineSearchT >

Optimizer using the Newton method with line search.

Member Typedef Documentation

◆ StepT

template<typename LineSearchT >
using autoware::common::optimization::NewtonsMethodOptimizer< LineSearchT >::StepT = float_t

Constructor & Destructor Documentation

◆ NewtonsMethodOptimizer()

template<typename LineSearchT >
autoware::common::optimization::NewtonsMethodOptimizer< LineSearchT >::NewtonsMethodOptimizer ( const LineSearchT &  line_searcher,
const OptimizationOptions options 
)
inlineexplicit

Constructor to initialize the line search method

Parameters
[in]line_searcherAn instance of a line search class.
[in]optionsOptions to be used for this optimization.

Member Function Documentation

◆ solve_()

template<typename LineSearchT >
template<typename OptimizationProblemT , typename DomainValueT , typename EigenSolverT >
OptimizationSummary autoware::common::optimization::NewtonsMethodOptimizer< LineSearchT >::solve_ ( OptimizationProblemT &  optimization_problem,
const DomainValueT &  x0,
DomainValueT &  x_out 
)
inline

Solves x_out for an objective optimization_problem and an initial value x0

Parameters
optimization_problemoptimization_problem optimization objective
x0initial value
x_outoptimized value
Template Parameters
OptimizationProblemTOptimization problem type. Must be an implementation of common::optimization::OptimizationProblem.
DomainValueTType of the parameter
EigenSolverTType of eigen solver to be used internallt for solving the necessary linear equations. By default set to Eigen::LDLT.
Returns
Summary of this optimization.

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