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

#include <MiniTensor_TestFunctions.h>

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

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

Public Member Functions
	Paraboloid (S xc=0.0, S yc=0.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< 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 {"Paraboloid"}
Static Public Attributes inherited from minitensor::Function_Base< FunctionDerived, S, M >
static constexpr Index	DIMENSION {M}

Private Attributes
S	xc_ {0.0}
S	yc_ {0.0}

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::Paraboloid< S, M >

Paraboloid of revolution \( (x_1-x_c)^2 + (x_2-y_c)^2 \). Two-dimensional, convex, single minimum at \( (x_c, y_c) \).

Definition at line 639 of file MiniTensor_TestFunctions.h.

Member Typedef Documentation

Base

template<typename S , Index M = 2>

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

Base class type.

Definition at line 662 of file MiniTensor_TestFunctions.h.

Constructor & Destructor Documentation

Paraboloid()

template<typename S , Index M = 2>

minitensor::Paraboloid< S, M >::Paraboloid ( S  xc = 0.0, S  yc = 0.0  )

inline

Constructor.

Parameters

xc	First coordinate of the minimizer.
yc	Second coordinate of the minimizer.

Definition at line 648 of file MiniTensor_TestFunctions.h.

Member Function Documentation

value()

template<typename S , Index M = 2>

template<typename T , Index N>

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

inline

Objective value.

Definition at line 670 of file MiniTensor_TestFunctions.h.

gradient()

template<typename S , Index M = 2>

template<typename T , Index N>

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

inline

Gradient of the objective.

Definition at line 692 of file MiniTensor_TestFunctions.h.

hessian()

template<typename S , Index M = 2>

template<typename T , Index N>

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

inline

Hessian of the objective.

Definition at line 703 of file MiniTensor_TestFunctions.h.

Member Data Documentation

NAME

template<typename S , Index M = 2>

constexpr char const* const minitensor::Paraboloid< S, M >::NAME {"Paraboloid"}

staticconstexpr

Function name.

Definition at line 657 of file MiniTensor_TestFunctions.h.

xc_

template<typename S , Index M = 2>

S minitensor::Paraboloid< S, M >::xc_ {0.0}

private

First coordinate of the minimizer.

Definition at line 713 of file MiniTensor_TestFunctions.h.

yc_

template<typename S , Index M = 2>

S minitensor::Paraboloid< S, M >::yc_ {0.0}

private

Second coordinate of the minimizer.

Definition at line 719 of file MiniTensor_TestFunctions.h.

---

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

• MiniTensor_TestFunctions.h