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

#include <MiniTensor_TestFunctions.h>

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

Public Types

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

Public Member Functions

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

Additional Inherited Members

Protected Attributes inherited from minitensor::Function_Base< McCormick< 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::McCormick< S, M >

McCormick function NLS: the residual is the gradient of \( \sin(x_1+x_2) + (x_1-x_2)^2 - 1.5 x_1 + 2.5 x_2 + 1 \). Two-dimensional with multiple minima; global minimum near \( (-0.547, -1.547) \).

Definition at line 480 of file MiniTensor_TestFunctions.h.

Member Typedef Documentation

◆ Base

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

Base class type.

Definition at line 499 of file MiniTensor_TestFunctions.h.

Constructor & Destructor Documentation

◆ McCormick()

template<typename S, Index M = 2>
minitensor::McCormick< S, M >::McCormick ( )
inline

Constructor.

Definition at line 487 of file MiniTensor_TestFunctions.h.

Member Function Documentation

◆ value()

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

Objective value.

Definition at line 507 of file MiniTensor_TestFunctions.h.

◆ gradient()

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

Gradient of the objective.

Definition at line 518 of file MiniTensor_TestFunctions.h.

◆ hessian()

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

Hessian of the objective.

Definition at line 540 of file MiniTensor_TestFunctions.h.

Member Data Documentation

◆ NAME

template<typename S, Index M = 2>
char const* const minitensor::McCormick< S, M >::NAME {"McCormick"}
staticconstexpr

Function name.

Definition at line 494 of file MiniTensor_TestFunctions.h.


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