minitensor::Banana< S, M > Class Template Reference

#include <MiniTensor_TestFunctions.h>

Inheritance diagram for minitensor::Banana< S, M >:

Public Types
using	Base = Function_Base< Banana< S, M >, S, M >

Public Member Functions
	Banana ()
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) const
template<typename T , Index N>
Tensor< T, N >	hessian (Vector< T, N > const &x)
Public Member Functions inherited from minitensor::Function_Base< FunctionDerived, S, M >
	Function_Base ()
template<typename T , Index N>
T	value (FunctionDerived &f, Vector< T, N > const &x)
template<typename T , Index N>
Vector< T, N >	gradient (FunctionDerived &f, Vector< T, N > const &x)
template<typename T , Index N>
Vector< T, N >	residual (FunctionDerived &f, Vector< T, N > const &x)
template<typename T , Index N>
Tensor< T, N >	hessian (FunctionDerived &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 Banana"}
Static Public Attributes inherited from minitensor::Function_Base< FunctionDerived, S, M >
static constexpr Index	DIMENSION {M}

Additional Inherited Members
Protected Attributes inherited from minitensor::Function_Base< FunctionDerived, S, M >
bool	failed {false}
char const *	failure_message {nullptr}
	Keep a message to inform what went wrong above.

Detailed Description

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

Rosenbrock's banana function as an NLS: the residual is the gradient of \( (1-x_1)^2 + 100(x_2-x_1^2)^2 \). Two-dimensional; its curved, flat-bottomed valley stresses step control. Minimum at \( (1, 1) \).

Definition at line 324 of file MiniTensor_TestFunctions.h.

Member Typedef Documentation

Base

template<typename S , Index M = 2>

using minitensor::Banana< S, M >::Base = Function_Base<Banana<S, M>, S, M>

Base class type.

Definition at line 345 of file MiniTensor_TestFunctions.h.

Constructor & Destructor Documentation

Banana()

template<typename S , Index M = 2>

minitensor::Banana< S, M >::Banana ( )

inline

Constructor.

Definition at line 331 of file MiniTensor_TestFunctions.h.

Member Function Documentation

value()

template<typename S , Index M = 2>

template<typename T , Index N>

T minitensor::Banana< S, M >::value ( Vector< T, N > const &  x )

inline

Objective value.

Definition at line 353 of file MiniTensor_TestFunctions.h.

gradient()

template<typename S , Index M = 2>

template<typename T , Index N>

Vector< T, N > minitensor::Banana< S, M >::gradient ( Vector< T, N > const &  x ) const

inline

Gradient of the objective.

Definition at line 364 of file MiniTensor_TestFunctions.h.

hessian()

template<typename S , Index M = 2>

template<typename T , Index N>

Tensor< T, N > minitensor::Banana< S, M >::hessian ( Vector< T, N > const &  x )

inline

Hessian of the objective.

Definition at line 386 of file MiniTensor_TestFunctions.h.

Member Data Documentation

NAME

template<typename S , Index M = 2>

constexpr char const* const minitensor::Banana< S, M >::NAME {"Rosenbrock's Banana"}

staticconstexpr

Function name.

Definition at line 340 of file MiniTensor_TestFunctions.h.

---

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

• MiniTensor_TestFunctions.h