ptems::FuncGradAndHessianData< DIM, X > Struct Template Reference

Structure holding the values of a function, its gradient, and its Hessian at a point. More...

#include <ptems/spaces/polynomials.hpp>

Inheritance diagram for ptems::FuncGradAndHessianData< DIM, X >:

Collaboration diagram for ptems::FuncGradAndHessianData< DIM, X >:

Public Member Functions
	FuncGradAndHessianData ()
	Creates structure containing empty (zero) values of a function, its gradient, and its Hessian at a point. More...
	FuncGradAndHessianData (X func)
	Creates structure containing values of a function. More...
	FuncGradAndHessianData (const FuncAndGradData< DIM, X > &func)
	Creates structure containing values of a function and its gradient with zero Hessian from the gradient data. More...
	FuncGradAndHessianData (X func, const BasicVector< X, DIM > &grad, const BasicMatrix< X, DIM > &hessian)
	Creates structure containing values of a function, its gradient, and its Hessian at a point. More...

Public Attributes
BasicMatrix< X, DIM >	Hessian
	The Hessian of the function. More...
X	Func
	Value of the function. More...
BasicVector< X, DIM >	Gradient
	The gradient of the function. More...

Detailed Description

template<std::size_t DIM, typename X>
struct ptems::FuncGradAndHessianData< DIM, X >

Structure holding the values of a function, its gradient, and its Hessian at a point.

Constructor & Destructor Documentation

FuncGradAndHessianData() [1/4]

template<std::size_t DIM, typename X >

ptems::FuncGradAndHessianData< DIM, X >::FuncGradAndHessianData ( )

inline

Creates structure containing empty (zero) values of a function, its gradient, and its Hessian at a point.

FuncGradAndHessianData() [2/4]

template<std::size_t DIM, typename X >

ptems::FuncGradAndHessianData< DIM, X >::FuncGradAndHessianData ( X  func )

inline

Creates structure containing values of a function.

Parameters

func	Value of function at point

FuncGradAndHessianData() [3/4]

template<std::size_t DIM, typename X >

ptems::FuncGradAndHessianData< DIM, X >::FuncGradAndHessianData ( const FuncAndGradData< DIM, X > &  func )

inline

Creates structure containing values of a function and its gradient with zero Hessian from the gradient data.

Parameters

func	Value of function and gradient at point

FuncGradAndHessianData() [4/4]

template<std::size_t DIM, typename X >

ptems::FuncGradAndHessianData< DIM, X >::FuncGradAndHessianData ( X  func, const BasicVector< X, DIM > &  grad, const BasicMatrix< X, DIM > &  hessian  )

inline

Creates structure containing values of a function, its gradient, and its Hessian at a point.

Parameters

func	Value of function at point
grad	Value of gradient at point
hessian	Value of Hessian at point

Member Data Documentation

Func

template<std::size_t DIM, typename X >

X ptems::FuncAndGradData< DIM, X >::Func

inherited

Value of the function.

Gradient

template<std::size_t DIM, typename X >

BasicVector<X, DIM> ptems::FuncAndGradData< DIM, X >::Gradient

inherited

The gradient of the function.

Hessian

template<std::size_t DIM, typename X >

BasicMatrix<X, DIM> ptems::FuncGradAndHessianData< DIM, X >::Hessian

The Hessian of the function.

---

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

• ptems/spaces/polynomials.hpp