mpqc::math::TaylorExpansionFunction< Value, Parameters > Class Template Reference

Collaboration diagram for mpqc::math::TaylorExpansionFunction< Value, Parameters >:

Documentation

template<typename Value, typename Parameters>
class mpqc::math::TaylorExpansionFunction< Value, Parameters >

TaylorExpansionFunction<Value> is a Function that returns TaylorExpansionCoefficients<Value>

Public Types
typedef Function< TaylorExpansionCoefficients< Value >, Parameters >	function_base_type
Public Types inherited from mpqc::math::Function< TaylorExpansionCoefficients< Value >, Parameters >
typedef TaylorExpansionCoefficients< Value >	value_type
typedef Parameters	parameters_type
using	Timestampable = ::mpqc::utility::Timestampable< X >

Public Member Functions
size_t	order () const
double	target_precision (size_t ord) const
Public Member Functions inherited from mpqc::math::Function< TaylorExpansionCoefficients< Value >, Parameters >
	Function ()=default
	Function (std::shared_ptr< Parameters > params)
virtual	~Function ()
std::shared_ptr< const TaylorExpansionCoefficients< Value > >	value ()
bool	must_compute () const
std::shared_ptr< const Parameters >	params () const
virtual void	set_params (std::shared_ptr< Parameters > params)

Protected Member Functions
	TaylorExpansionFunction (const KeyVal &kv, std::shared_ptr< Parameters > params, double default_precision=default_precision_)
	auxiliary KeyVal constructor More...
Protected Member Functions inherited from mpqc::math::Function< TaylorExpansionCoefficients< Value >, Parameters >
const Timestampable< TaylorExpansionCoefficients< Value > > &	get_value () const
void	set_value (TaylorExpansionCoefficients< Value > v)
virtual void	compute ()=0
	evaluates value , implemented by the derived class More...

Static Protected Attributes
static constexpr double	default_precision_ = 1e-8
	the default target precision to use if not provided to the constructor More...

Member Typedef Documentation

function_base_type

template<typename Value , typename Parameters >

typedef Function<TaylorExpansionCoefficients<Value>, Parameters> mpqc::math::TaylorExpansionFunction< Value, Parameters >::function_base_type

Constructor & Destructor Documentation

TaylorExpansionFunction()

template<typename Value , typename Parameters >

mpqc::math::TaylorExpansionFunction< Value, Parameters >::TaylorExpansionFunction ( const KeyVal &  kv, std::shared_ptr< Parameters >  params, double  default_precision = default_precision_  )

inlineprotected

auxiliary KeyVal constructor

The KeyVal object will be query the following keywords:

Keyword	Type	Default	Description
precision	{array<real> | real}	{none | 1e-8}	target precision for {each | all} derivative orders
deriv_order	int	0	the highest derivative order; only queried if precision is not given or is given as an array

Note

that if keyword precision is not given then will use the default_precision parameter.

Parameters

kv	the KeyVal object to be queried
params	the Parameters object that this function depends on
default_precision	the default precision to use

Member Function Documentation

order()

template<typename Value , typename Parameters >

size_t mpqc::math::TaylorExpansionFunction< Value, Parameters >::order ( ) const

inline

Returns

the order of Taylor expansion

target_precision()

template<typename Value , typename Parameters >

double mpqc::math::TaylorExpansionFunction< Value, Parameters >::target_precision ( size_t  ord ) const

inline

Parameters

ord	the derivative order

Returns

the target precision for derivatives order ord

Member Data Documentation

default_precision_

template<typename Value , typename Parameters >

constexpr double mpqc::math::TaylorExpansionFunction< Value, Parameters >::default_precision_ = 1e-8

staticconstexprprotected

the default target precision to use if not provided to the constructor

---

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

• mpqc/math/function/taylor.h