numerical-collection-cpp 0.10.0
A collection of algorithms in numerical analysis implemented in C++
Loading...
Searching...
No Matches
num_prob_collect::opt::rosenbrock_function Class Reference

Class of Rosenbrock function in 3 dimensions. More...

#include <num_prob_collect/opt/rosenbrock_function.h>

+ Collaboration diagram for num_prob_collect::opt::rosenbrock_function:

Public Types

using value_type = double
 Type of function values.
 
using variable_type = Eigen::Vector3d
 Type of variables.
 

Public Member Functions

void evaluate_on (const Eigen::Vector3d &x)
 Evaluate function value on variable.
 
auto gradient () const -> const Eigen::Vector3d &
 Get gradient.
 
auto value () const -> const double &
 Get function value.
 

Private Attributes

Eigen::Vector3d grad_ {}
 Gradient.
 
double value_ {}
 Function value.
 

Detailed Description

Class of Rosenbrock function in 3 dimensions.

This function has no local minimum except for the global one at (1, 1, 1).

Reference: http://www-optima.amp.i.kyoto-u.ac.jp/member/student/hedar/Hedar_files/TestGO_files/Page2537.htm

Definition at line 35 of file rosenbrock_function.h.

Member Typedef Documentation

◆ value_type

Type of function values.

Definition at line 41 of file rosenbrock_function.h.

◆ variable_type

Type of variables.

Definition at line 38 of file rosenbrock_function.h.

Member Function Documentation

◆ evaluate_on()

void num_prob_collect::opt::rosenbrock_function::evaluate_on ( const Eigen::Vector3d & x)
inline

Evaluate function value on variable.

Parameters
[in]xVariable.

Definition at line 48 of file rosenbrock_function.h.

◆ gradient()

auto num_prob_collect::opt::rosenbrock_function::gradient ( ) const -> const Eigen::Vector3d&
inlinenodiscard

Get gradient.

Returns
Gradient.

Definition at line 74 of file rosenbrock_function.h.

◆ value()

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

Get function value.

Returns
Function value.

Definition at line 67 of file rosenbrock_function.h.

Member Data Documentation

◆ grad_

Eigen::Vector3d num_prob_collect::opt::rosenbrock_function::grad_ {}
private

Gradient.

Definition at line 83 of file rosenbrock_function.h.

◆ value_

double num_prob_collect::opt::rosenbrock_function::value_ {}
private

Function value.

Definition at line 80 of file rosenbrock_function.h.


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