FEAT::Analytic::StaticWrapperFunction< domain_dim_, Function_, can_value_, can_grad_, can_hess_ > Class Template Reference

StaticFunction wrapper class template for Analytic::Function interface. More...

#include <static_wrapper.hpp>

Inheritance diagram for FEAT::Analytic::StaticWrapperFunction< domain_dim_, Function_, can_value_, can_grad_, can_hess_ >:

Classes
class	Evaluator
	Analytic Function Evaluator base-class template. More...

Public Types
typedef Analytic::Image::Scalar	ImageType
	this is always a scalar function More...

Public Member Functions
	StaticWrapperFunction (const StaticWrapperFunction &)
	StaticWrapperFunction (StaticWrapperFunction &&)

Static Public Attributes
static constexpr bool	can_grad = can_grad_
static constexpr bool	can_hess = can_hess_
static constexpr bool	can_value = can_value_
static constexpr int	domain_dim = domain_dim_
	our domain dimension More...

Detailed Description

template<int domain_dim_, template< typename > class Function_, bool can_value_ = true, bool can_grad_ = false, bool can_hess_ = false>
class FEAT::Analytic::StaticWrapperFunction< domain_dim_, Function_, can_value_, can_grad_, can_hess_ >

StaticFunction wrapper class template for Analytic::Function interface.

This class template implements the Analytic::Function interface by wrapping around a StaticFunction class template.

Template Parameters

domain_dim_	The domain dimension of the function. Must be 1 <= domain_dim_ <= 3.
Function_	A class template implementing the StaticFunction interface that is to be wrapped.
can_value_	Specifies whether the static function class template supports the evaluation of function values.
can_grad_	Specifies whether the static function class template supports the evaluation of first order derivatives.
can_hess_	Specifies whether the static function class template supports the evaluation of second order derivatives.

Author

Peter Zajac

Definition at line 473 of file static_wrapper.hpp.

Member Typedef Documentation

ImageType

template<int domain_dim_, template< typename > class Function_, bool can_value_ = true, bool can_grad_ = false, bool can_hess_ = false>

typedef Analytic::Image::Scalar FEAT::Analytic::StaticWrapperFunction< domain_dim_, Function_, can_value_, can_grad_, can_hess_ >::ImageType

this is always a scalar function

Definition at line 483 of file static_wrapper.hpp.

Constructor & Destructor Documentation

StaticWrapperFunction() [1/3]

template<int domain_dim_, template< typename > class Function_, bool can_value_ = true, bool can_grad_ = false, bool can_hess_ = false>

FEAT::Analytic::StaticWrapperFunction< domain_dim_, Function_, can_value_, can_grad_, can_hess_ >::StaticWrapperFunction ( )

inline

Definition at line 489 of file static_wrapper.hpp.

StaticWrapperFunction() [2/3]

template<int domain_dim_, template< typename > class Function_, bool can_value_ = true, bool can_grad_ = false, bool can_hess_ = false>

FEAT::Analytic::StaticWrapperFunction< domain_dim_, Function_, can_value_, can_grad_, can_hess_ >::StaticWrapperFunction ( const StaticWrapperFunction< domain_dim_, Function_, can_value_, can_grad_, can_hess_ > &  )

inline

Definition at line 490 of file static_wrapper.hpp.

StaticWrapperFunction() [3/3]

template<int domain_dim_, template< typename > class Function_, bool can_value_ = true, bool can_grad_ = false, bool can_hess_ = false>

FEAT::Analytic::StaticWrapperFunction< domain_dim_, Function_, can_value_, can_grad_, can_hess_ >::StaticWrapperFunction ( StaticWrapperFunction< domain_dim_, Function_, can_value_, can_grad_, can_hess_ > &&  )

inline

Definition at line 491 of file static_wrapper.hpp.

Member Data Documentation

can_grad

template<int domain_dim_, template< typename > class Function_, bool can_value_ = true, bool can_grad_ = false, bool can_hess_ = false>

constexpr bool FEAT::Analytic::StaticWrapperFunction< domain_dim_, Function_, can_value_, can_grad_, can_hess_ >::can_grad = can_grad_

staticconstexpr

Definition at line 486 of file static_wrapper.hpp.

can_hess

template<int domain_dim_, template< typename > class Function_, bool can_value_ = true, bool can_grad_ = false, bool can_hess_ = false>

constexpr bool FEAT::Analytic::StaticWrapperFunction< domain_dim_, Function_, can_value_, can_grad_, can_hess_ >::can_hess = can_hess_

staticconstexpr

Definition at line 487 of file static_wrapper.hpp.

can_value

template<int domain_dim_, template< typename > class Function_, bool can_value_ = true, bool can_grad_ = false, bool can_hess_ = false>

constexpr bool FEAT::Analytic::StaticWrapperFunction< domain_dim_, Function_, can_value_, can_grad_, can_hess_ >::can_value = can_value_

staticconstexpr

Definition at line 485 of file static_wrapper.hpp.

domain_dim

template<int domain_dim_, template< typename > class Function_, bool can_value_ = true, bool can_grad_ = false, bool can_hess_ = false>

constexpr int FEAT::Analytic::StaticWrapperFunction< domain_dim_, Function_, can_value_, can_grad_, can_hess_ >::domain_dim = domain_dim_

staticconstexpr

our domain dimension

Definition at line 480 of file static_wrapper.hpp.

---

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

• kernel/analytic/static_wrapper.hpp