adore::mad::LConstFun< DT, CT > Class Template Reference

#include <alfunction.h>

Inheritance diagram for adore::mad::LConstFun< DT, CT >:

Collaboration diagram for adore::mad::LConstFun< DT, CT >:

Public Member Functions
	LConstFun (const CT &value, DT xlo, DT xhi)
virtual CT	f (DT x) const override
virtual DT	limitHi () const override
virtual DT	limitLo () const override
virtual void	invertDirection ()
virtual void	setLimits (DT lo, DT hi)
virtual ALFunction< DT, CT > *	clone () override
virtual ALFunction< DT, CT > *	create_derivative () override
virtual void	bound (const DT &xmin, const DT &xmax, CT &ymin, CT &ymax) override
Public Member Functions inherited from adore::mad::ALFunction< DT, CT >
virtual	~ALFunction ()
	ALFunction ()
const CT	operator() (DT x) const
bool	isInDomain (DT x)
CT	f_bounded (DT x)
virtual void	f (DT *xvec, CT *yvec, unsigned int count) const
void	bound (CT &ymin, CT &ymax)
void	invalidateCachedBounds ()

Public Attributes
CT	m_value
DT	m_xlo
DT	m_xhi

Detailed Description

template<typename DT, typename CT>
class adore::mad::LConstFun< DT, CT >

LConstFun - a function with constant output

Constructor & Destructor Documentation

LConstFun()

template<typename DT , typename CT >

adore::mad::LConstFun< DT, CT >::LConstFun ( const CT &  value, DT  xlo, DT  xhi  )

inline

Member Function Documentation

bound()

template<typename DT , typename CT >

virtual void adore::mad::LConstFun< DT, CT >::bound ( const DT &  xmin, const DT &  xmax, CT &  ymin, CT &  ymax  )

inlineoverridevirtual

bound function values in the x-range defined by the hypercube between corner points lower left xmin and upper right xmax

Implements adore::mad::ALFunction< DT, CT >.

clone()

template<typename DT , typename CT >

virtual ALFunction<DT, CT>* adore::mad::LConstFun< DT, CT >::clone ( )

inlineoverridevirtual

create a copy of child class object - is used for function operations

Implements adore::mad::ALFunction< DT, CT >.

create_derivative()

template<typename DT , typename CT >

virtual ALFunction<DT, CT>* adore::mad::LConstFun< DT, CT >::create_derivative ( )

inlineoverridevirtual

create a new function object, which is the derivative function

Implements adore::mad::ALFunction< DT, CT >.

f()

template<typename DT , typename CT >

virtual CT adore::mad::LConstFun< DT, CT >::f ( DT  x ) const

inlineoverridevirtual

function evaluation returns y of codomain type CT for a value x of domain type DT

Implements adore::mad::ALFunction< DT, CT >.

invertDirection()

template<typename DT , typename CT >

virtual void adore::mad::LConstFun< DT, CT >::invertDirection ( )

inlinevirtual

limitHi()

template<typename DT , typename CT >

virtual DT adore::mad::LConstFun< DT, CT >::limitHi ( ) const

inlineoverridevirtual

query upper limit of the domain

Implements adore::mad::ALFunction< DT, CT >.

limitLo()

template<typename DT , typename CT >

virtual DT adore::mad::LConstFun< DT, CT >::limitLo ( ) const

inlineoverridevirtual

lower limit of the domain

Implements adore::mad::ALFunction< DT, CT >.

setLimits()

template<typename DT , typename CT >

virtual void adore::mad::LConstFun< DT, CT >::setLimits ( DT  lo, DT  hi  )

inlinevirtual

reduce or increase the limit of the function, without changing y

Implements adore::mad::ALFunction< DT, CT >.

Member Data Documentation

m_value

template<typename DT , typename CT >

CT adore::mad::LConstFun< DT, CT >::m_value

m_xhi

template<typename DT , typename CT >

DT adore::mad::LConstFun< DT, CT >::m_xhi

m_xlo

template<typename DT , typename CT >

DT adore::mad::LConstFun< DT, CT >::m_xlo

---

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

• /home/akoerner/repos/csa/github.com/akoerner1/adore_docs_publish/adore/libadore/libadore/adore/mad/include/adore/mad/alfunction.h