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

#include <MiniTensor_TestFunctions.h>

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

Public Types

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

Public Member Functions

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

Private Attributes

S const a_ {0.0}
S const b_ {0.0}
S const c_ {0.0}

Additional Inherited Members

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

Inverted Gaussian NLS: the residual is the gradient of \( -e^{-c^2((x_1-a)^2+(x_2-b)^2)} \) scaled by \( c \). Two-dimensional; minimum at \( (a, b) \), nearly flat away from it, stressing globalization.

Definition at line 216 of file MiniTensor_TestFunctions.h.

Member Typedef Documentation

◆ Base

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

Base class type.

Definition at line 239 of file MiniTensor_TestFunctions.h.

Constructor & Destructor Documentation

◆ Gaussian()

template<typename S, Index M = 2>
minitensor::Gaussian< S, M >::Gaussian ( S const a,
S const b,
S const c )
inline

Constructor.

Parameters
aFirst coordinate of the center (minimizer).
bSecond coordinate of the center (minimizer).
cInverse width of the Gaussian.

Definition at line 225 of file MiniTensor_TestFunctions.h.

Member Function Documentation

◆ value()

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

Objective value.

Definition at line 247 of file MiniTensor_TestFunctions.h.

◆ gradient()

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

Gradient of the objective.

Definition at line 258 of file MiniTensor_TestFunctions.h.

◆ hessian()

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

Hessian of the objective.

Definition at line 289 of file MiniTensor_TestFunctions.h.

Member Data Documentation

◆ NAME

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

Function name.

Definition at line 234 of file MiniTensor_TestFunctions.h.

◆ a_

template<typename S, Index M = 2>
S const minitensor::Gaussian< S, M >::a_ {0.0}
private

First coordinate of the center.

Definition at line 299 of file MiniTensor_TestFunctions.h.

◆ b_

template<typename S, Index M = 2>
S const minitensor::Gaussian< S, M >::b_ {0.0}
private

Second coordinate of the center.

Definition at line 305 of file MiniTensor_TestFunctions.h.

◆ c_

template<typename S, Index M = 2>
S const minitensor::Gaussian< S, M >::c_ {0.0}
private

Inverse width of the Gaussian.

Definition at line 311 of file MiniTensor_TestFunctions.h.


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