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

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

#include <ptems/spaces/polynomials.hpp>

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

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

Public Member Functions
	FuncThirdOrderData ()
	Creates structure containing empty (zero) values of a function and its gradient, Hessian, and third order derivatives at a point. More...
	FuncThirdOrderData (X func, const BasicVector< X, DIM > &grad, const BasicMatrix< X, DIM > &hessian, const BasicTensor< X, 3, DIM > &thirdOrder)
	Creates structure containing values of a function, and its gradient, Hessian, and third order derivatives at a point. More...

Public Attributes
BasicTensor< X, 3, DIM >	ThirdOrder
	The third order derivatives of the function as a rank 3 tensor. More...
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::FuncThirdOrderData< DIM, X >

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

Constructor & Destructor Documentation

FuncThirdOrderData() [1/2]

template<std::size_t DIM, typename X >

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

inline

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

FuncThirdOrderData() [2/2]

template<std::size_t DIM, typename X >

ptems::FuncThirdOrderData< DIM, X >::FuncThirdOrderData ( X  func, const BasicVector< X, DIM > &  grad, const BasicMatrix< X, DIM > &  hessian, const BasicTensor< X, 3, DIM > &  thirdOrder  )

inline

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

Parameters

func	Value of function at point
grad	Value of gradient at point
hessian	Value of Hessian at point
thirdOrder	Value of third order derivatives 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

inherited

The Hessian of the function.

ThirdOrder

template<std::size_t DIM, typename X >

BasicTensor<X, 3, DIM> ptems::FuncThirdOrderData< DIM, X >::ThirdOrder

The third order derivatives of the function as a rank 3 tensor.

The first dimension of the tensor is the first derivative, the second the second derivative etc.

---

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

• ptems/spaces/polynomials.hpp