num_prob_collect::opt::vibrated_quadratic_function Class Reference

Quadratic function with vibration for test of optimization. More...

#include <num_prob_collect/opt/vibrated_quadratic_function.h>

Collaboration diagram for num_prob_collect::opt::vibrated_quadratic_function:

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

Public Member Functions
void	evaluate_on (double variable)
	Evaluate function value on variable.
auto	gradient () const -> const double &
	Get gradient.
auto	hessian () const -> const double &
	Get Hessian.
auto	value () const -> const double &
	Get function value.

Private Attributes
double	coeff_ {0.25}
	Coefficient.
double	grad_ {}
	Gradient.
double	hessian_ {}
	Hessian.
double	value_ {0.0}
	Function value.

Detailed Description

Quadratic function with vibration for test of optimization.

Definition at line 29 of file vibrated_quadratic_function.h.

Member Typedef Documentation

hessian_type

using num_prob_collect::opt::vibrated_quadratic_function::hessian_type = double

Type of Hessian.

Definition at line 36 of file vibrated_quadratic_function.h.

value_type

using num_prob_collect::opt::vibrated_quadratic_function::value_type = double

Type of function values.

Definition at line 34 of file vibrated_quadratic_function.h.

variable_type

using num_prob_collect::opt::vibrated_quadratic_function::variable_type = double

Type of variables.

Definition at line 32 of file vibrated_quadratic_function.h.

Member Function Documentation

evaluate_on()

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

inline

Evaluate function value on variable.

Parameters

[in]

variable

Variable.

Definition at line 43 of file vibrated_quadratic_function.h.

gradient()

auto num_prob_collect::opt::vibrated_quadratic_function::gradient ( ) const -> const double&

inlinenodiscard

Get gradient.

Returns

Gradient.

Definition at line 62 of file vibrated_quadratic_function.h.

hessian()

auto num_prob_collect::opt::vibrated_quadratic_function::hessian ( ) const -> const double&

inlinenodiscard

Get Hessian.

Returns

Hessian.

Definition at line 69 of file vibrated_quadratic_function.h.

value()

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

inlinenodiscard

Get function value.

Returns

Function value.

Definition at line 55 of file vibrated_quadratic_function.h.

Member Data Documentation

coeff_

double num_prob_collect::opt::vibrated_quadratic_function::coeff_ {0.25}

private

Coefficient.

Definition at line 73 of file vibrated_quadratic_function.h.

grad_

double num_prob_collect::opt::vibrated_quadratic_function::grad_ {}

private

Gradient.

Definition at line 79 of file vibrated_quadratic_function.h.

hessian_

double num_prob_collect::opt::vibrated_quadratic_function::hessian_ {}

private

Hessian.

Definition at line 82 of file vibrated_quadratic_function.h.

value_

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

private

Function value.

Definition at line 76 of file vibrated_quadratic_function.h.

---

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

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