num_prob_collect::opt::single_variate_multi_optima_function Class Reference

Class of functions of single-variate optimization problems with multiple local optima. More...

#include <num_prob_collect/opt/single_variate_multi_optima_function.h>

Collaboration diagram for num_prob_collect::opt::single_variate_multi_optima_function:

Public Types
using	value_type = double
	Type of function values.
using	variable_type = double
	Type of variables.

Public Member Functions
	single_variate_multi_optima_function (Eigen::ArrayXd optimal_variables, Eigen::ArrayXd optimal_values, Eigen::ArrayXd coefficients)
	Constructor.
auto	coefficients () const noexcept -> const Eigen::ArrayXd &
	Get the coefficients for optima.
void	evaluate_on (double variable) noexcept
	Evaluate function value on variable.
auto	optimal_values () const noexcept -> const Eigen::ArrayXd &
	Get the optimal values.
auto	optimal_variables () const noexcept -> const Eigen::ArrayXd &
	Get the optimal variables.
auto	value () const noexcept -> const double &
	Get function value.

Private Attributes
Eigen::ArrayXd	coefficients_
	Coefficients for optima.
Eigen::ArrayXd	optimal_values_
	Optimal values.
Eigen::ArrayXd	optimal_variables_
	Optimal variables.
double	value_ {0.0}
	Function value.

Detailed Description

Class of functions of single-variate optimization problems with multiple local optima.

Definition at line 38 of file single_variate_multi_optima_function.h.

Member Typedef Documentation

value_type

using num_prob_collect::opt::single_variate_multi_optima_function::value_type = double

Type of function values.

Definition at line 43 of file single_variate_multi_optima_function.h.

variable_type

using num_prob_collect::opt::single_variate_multi_optima_function::variable_type = double

Type of variables.

Definition at line 41 of file single_variate_multi_optima_function.h.

Constructor & Destructor Documentation

single_variate_multi_optima_function()

num_prob_collect::opt::single_variate_multi_optima_function::single_variate_multi_optima_function ( Eigen::ArrayXd optimal_variables, Eigen::ArrayXd optimal_values, Eigen::ArrayXd coefficients )

inline

Constructor.

Parameters

[in]	optimal_variables	Optimal variables.
[in]	optimal_values	Optimal values.
[in]	coefficients	Coefficients for optima.

Definition at line 52 of file single_variate_multi_optima_function.h.

Member Function Documentation

coefficients()

auto num_prob_collect::opt::single_variate_multi_optima_function::coefficients ( ) const -> const Eigen::ArrayXd&

inlinenodiscardnoexcept

Get the coefficients for optima.

Returns

Coefficients for optima.

Definition at line 103 of file single_variate_multi_optima_function.h.

evaluate_on()

void num_prob_collect::opt::single_variate_multi_optima_function::evaluate_on ( double variable )

inlinenoexcept

Evaluate function value on variable.

Parameters

[in]

variable

Variable.

Definition at line 63 of file single_variate_multi_optima_function.h.

optimal_values()

auto num_prob_collect::opt::single_variate_multi_optima_function::optimal_values ( ) const -> const Eigen::ArrayXd&

inlinenodiscardnoexcept

Get the optimal values.

Returns

Optimal values.

Definition at line 93 of file single_variate_multi_optima_function.h.

optimal_variables()

auto num_prob_collect::opt::single_variate_multi_optima_function::optimal_variables ( ) const -> const Eigen::ArrayXd&

inlinenodiscardnoexcept

Get the optimal variables.

Returns

Optimal variables.

Definition at line 83 of file single_variate_multi_optima_function.h.

value()

auto num_prob_collect::opt::single_variate_multi_optima_function::value ( ) const -> const double&

inlinenodiscardnoexcept

Get function value.

Returns

Function value.

Definition at line 74 of file single_variate_multi_optima_function.h.

Member Data Documentation

coefficients_

Eigen::ArrayXd num_prob_collect::opt::single_variate_multi_optima_function::coefficients_

private

Coefficients for optima.

Definition at line 115 of file single_variate_multi_optima_function.h.

optimal_values_

Eigen::ArrayXd num_prob_collect::opt::single_variate_multi_optima_function::optimal_values_

private

Optimal values.

Definition at line 112 of file single_variate_multi_optima_function.h.

optimal_variables_

Eigen::ArrayXd num_prob_collect::opt::single_variate_multi_optima_function::optimal_variables_

private

Optimal variables.

Definition at line 109 of file single_variate_multi_optima_function.h.

value_

double num_prob_collect::opt::single_variate_multi_optima_function::value_ {0.0}

private

Function value.

Definition at line 118 of file single_variate_multi_optima_function.h.

---

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

• problems/include/num_prob_collect/opt/single_variate_multi_optima_function.h