FEAT::Analytic::Gradient< Function_ > Class Template Reference

Analytic Function Gradient wrapper. More...

#include <wrappers.hpp>

Inheritance diagram for FEAT::Analytic::Gradient< Function_ >:

Classes
class	Evaluator

Public Types
typedef Image::Vector< domain_dim >	ImageType
	this is a vector-valued function More...

Public Member Functions
	Gradient (const Function_ &function)
	Constructor. More...

Static Public Attributes
static constexpr bool	can_grad = Function_::can_hess
static constexpr bool	can_hess = false
static constexpr bool	can_value = Function_::can_grad
static constexpr int	domain_dim = Function_::domain_dim
	our domain dimension is the same as the input function's More...

Private Attributes
const Function_ &	_function

Detailed Description

template<typename Function_>
class FEAT::Analytic::Gradient< Function_ >

Analytic Function Gradient wrapper.

This class template represents the gradient of another scalar function.

Template Parameters

Function_

The function whose gradient is to be wrapped.

Author

Peter Zajac

Definition at line 26 of file wrappers.hpp.

Member Typedef Documentation

ImageType

template<typename Function_ >

typedef Image::Vector<domain_dim> FEAT::Analytic::Gradient< Function_ >::ImageType

this is a vector-valued function

Definition at line 37 of file wrappers.hpp.

Constructor & Destructor Documentation

Gradient()

template<typename Function_ >

FEAT::Analytic::Gradient< Function_ >::Gradient ( const Function_ &  function )

inlineexplicit

Constructor.

Parameters

[in]

function

A resident reference to the function whose gradient is to be wrapped.

Definition at line 85 of file wrappers.hpp.

Member Data Documentation

_function

template<typename Function_ >

const Function_& FEAT::Analytic::Gradient< Function_ >::_function

private

Definition at line 76 of file wrappers.hpp.

can_grad

template<typename Function_ >

constexpr bool FEAT::Analytic::Gradient< Function_ >::can_grad = Function_::can_hess

staticconstexpr

Definition at line 40 of file wrappers.hpp.

can_hess

template<typename Function_ >

constexpr bool FEAT::Analytic::Gradient< Function_ >::can_hess = false

staticconstexpr

Definition at line 41 of file wrappers.hpp.

can_value

template<typename Function_ >

constexpr bool FEAT::Analytic::Gradient< Function_ >::can_value = Function_::can_grad

staticconstexpr

Definition at line 39 of file wrappers.hpp.

domain_dim

template<typename Function_ >

constexpr int FEAT::Analytic::Gradient< Function_ >::domain_dim = Function_::domain_dim

staticconstexpr

our domain dimension is the same as the input function's

Definition at line 34 of file wrappers.hpp.

---

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

• kernel/analytic/wrappers.hpp