#include <optimizer_options.hpp>
◆ OptimizationOptions()
| autoware::common::optimization::OptimizationOptions::OptimizationOptions |
( |
uint64_t |
max_num_iterations = std::numeric_limits<int64_t>::max(), |
|
|
float64_t |
function_tolerance = 0.0, |
|
|
float64_t |
parameter_tolerance = 0.0, |
|
|
float64_t |
gradient_tolerance = 0.0 |
|
) |
| |
Constructor to initialize const members
- Parameters
-
| max_num_iterations | maximum number of iterations |
| function_tolerance | minimum relative change in the cost function. |
| parameter_tolerance | minimum step size relative to the parameter's norm. |
| gradient_tolerance | minimum absolute change in the gradient. |
- Exceptions
-
| std::domain_error | on negative or NaN tolerance values. |
◆ function_tolerance()
| float64_t autoware::common::optimization::OptimizationOptions::function_tolerance |
( |
| ) |
const |
|
noexcept |
Get minimum relative change in the cost function.
◆ gradient_tolerance()
| float64_t autoware::common::optimization::OptimizationOptions::gradient_tolerance |
( |
| ) |
const |
|
noexcept |
Get minimum relative change in the gradient.
◆ max_num_iterations()
| uint64_t autoware::common::optimization::OptimizationOptions::max_num_iterations |
( |
| ) |
const |
|
noexcept |
Get maximum number of iterations.
◆ parameter_tolerance()
| float64_t autoware::common::optimization::OptimizationOptions::parameter_tolerance |
( |
| ) |
const |
|
noexcept |
Get minimum relative change in the parameter.
The documentation for this class was generated from the following files: