MiniTensor Version of the Day
Loading...
Searching...
No Matches
minitensor::Rosenbrock< S, M > Class Template Reference

#include <MiniTensor_TestFunctions.h>

Inheritance diagram for minitensor::Rosenbrock< S, M >:
minitensor::Function_Base< Rosenbrock< S, 2 >, S, 2 >

Public Types

using Base = Function_Base<Rosenbrock<S, M>, S, M>

Public Member Functions

 Rosenbrock (S a=1.0, S b=100.0)
template<typename T, Index N>
T value (Vector< T, N > const &x)
template<typename T, Index N>
Vector< T, N > gradient (Vector< T, N > const &x)
template<typename T, Index N>
Tensor< T, N > hessian (Vector< T, N > const &x)
Public Member Functions inherited from minitensor::Function_Base< Rosenbrock< S, 2 >, S, 2 >
 Function_Base ()
T value (Rosenbrock< S, 2 > &f, Vector< T, N > const &x)
Vector< T, N > gradient (Rosenbrock< S, 2 > &f, Vector< T, N > const &x)
Vector< T, N > residual (Rosenbrock< S, 2 > &f, Vector< T, N > const &x)
Tensor< T, N > hessian (Rosenbrock< S, 2 > &f, Vector< T, N > const &x)
void set_failed (char const *const msg=nullptr)
bool get_failed ()
void clear_failed ()
void set_failure_message (char const *const msg=nullptr)
char const * get_failure_message ()

Static Public Attributes

static constexpr char const *const NAME {"Rosenbrock's Function 2D"}
Static Public Attributes inherited from minitensor::Function_Base< Rosenbrock< S, 2 >, S, 2 >
static constexpr Index DIMENSION

Private Attributes

S a_ {1.0}
S b_ {100.0}

Additional Inherited Members

Protected Attributes inherited from minitensor::Function_Base< Rosenbrock< S, 2 >, S, 2 >
bool failed
char const * failure_message
 Keep a message to inform what went wrong above.

Detailed Description

template<typename S, Index M = 2>
class minitensor::Rosenbrock< S, M >

Rosenbrock's function \( (a-x_1)^2 + b(x_2-x_1^2)^2 \) with defaults \( a=1, b=100 \). Two-dimensional; its curved banana valley stresses line search and step control. Minimum at \( (a, a^2) \).

Definition at line 732 of file MiniTensor_TestFunctions.h.

Member Typedef Documentation

◆ Base

template<typename S, Index M = 2>
using minitensor::Rosenbrock< S, M >::Base = Function_Base<Rosenbrock<S, M>, S, M>

Base class type.

Definition at line 756 of file MiniTensor_TestFunctions.h.

Constructor & Destructor Documentation

◆ Rosenbrock()

template<typename S, Index M = 2>
minitensor::Rosenbrock< S, M >::Rosenbrock ( S a = 1.0,
S b = 100.0 )
inline

Constructor.

Parameters
aLocation parameter; the minimizer is \( (a, a^2) \).
bWeight of the valley (coupling) term.

Definition at line 742 of file MiniTensor_TestFunctions.h.

Member Function Documentation

◆ value()

template<typename S, Index M = 2>
template<typename T, Index N>
T minitensor::Rosenbrock< S, M >::value ( Vector< T, N > const & x)
inline

Objective value.

Definition at line 764 of file MiniTensor_TestFunctions.h.

◆ gradient()

template<typename S, Index M = 2>
template<typename T, Index N>
Vector< T, N > minitensor::Rosenbrock< S, M >::gradient ( Vector< T, N > const & x)
inline

Gradient of the objective.

Definition at line 781 of file MiniTensor_TestFunctions.h.

◆ hessian()

template<typename S, Index M = 2>
template<typename T, Index N>
Tensor< T, N > minitensor::Rosenbrock< S, M >::hessian ( Vector< T, N > const & x)
inline

Hessian of the objective.

Definition at line 792 of file MiniTensor_TestFunctions.h.

Member Data Documentation

◆ NAME

template<typename S, Index M = 2>
char const* const minitensor::Rosenbrock< S, M >::NAME {"Rosenbrock's Function 2D"}
staticconstexpr

Function name.

Definition at line 751 of file MiniTensor_TestFunctions.h.

◆ a_

template<typename S, Index M = 2>
S minitensor::Rosenbrock< S, M >::a_ {1.0}
private

Location parameter.

Definition at line 802 of file MiniTensor_TestFunctions.h.

◆ b_

template<typename S, Index M = 2>
S minitensor::Rosenbrock< S, M >::b_ {100.0}
private

Weight of the valley (coupling) term.

Definition at line 808 of file MiniTensor_TestFunctions.h.


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