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

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

#include <ptems/spaces/polynomials.hpp>

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

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

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

Public Attributes
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::FuncAndGradData< DIM, X >

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

Constructor & Destructor Documentation

FuncAndGradData() [1/2]

template<std::size_t DIM, typename X >

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

inline

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

FuncAndGradData() [2/2]

template<std::size_t DIM, typename X >

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

inline

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

Parameters

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

Member Data Documentation

Func

template<std::size_t DIM, typename X >

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

Value of the function.

Gradient

template<std::size_t DIM, typename X >

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

The gradient of the function.

---

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

• ptems/spaces/polynomials.hpp