STK::hidden::invPsi Class Reference

Functor computing the difference between the psi function and a fixed value. More...

#include <STK_GammaBase.h>

Inheritance diagram for STK::hidden::invPsi:

Public Member Functions
	invPsi (Real const &y)
	initialize y_
Real	fImpl (Real const &x) const
Real	xminImpl () const
Public Member Functions inherited from STK::IFunction< invPsi >
Real	operator() (Real const &x) const
Real	xmin () const
Real	xmax () const
Real	xminImpl () const
Real	xmaxImpl () const
Public Member Functions inherited from STK::IRecursiveTemplate< Derived >
Derived &	asDerived ()
	static cast : return a reference of this with a cast to the derived class.
Derived const &	asDerived () const
	static cast : return a const reference of this with a cast to the derived class.
Derived *	asPtrDerived ()
	static cast : return a ptr on a Derived of this with a cast to the derived class.
Derived const *	asPtrDerived () const
	static cast : return a ptr on a constant Derived of this with a cast to the derived class.
Derived *	clone () const
	create a leaf using the copy constructor of the Derived class.
Derived *	clone (bool isRef) const
	create a leaf using the copy constructor of the Derived class and a flag determining if the clone is a reference or not.

Private Attributes
Real	y_

Additional Inherited Members
Protected Member Functions inherited from STK::IFunction< invPsi >
	IFunction ()
	Default Constructor.
	~IFunction ()
	destructor.
Protected Member Functions inherited from STK::IRecursiveTemplate< Derived >
	IRecursiveTemplate ()
	constructor.
	~IRecursiveTemplate ()
	destructor.

Detailed Description

Functor computing the difference between the psi function and a fixed value.

Definition at line 74 of file STK_GammaBase.h.

Constructor & Destructor Documentation

invPsi()

STK::hidden::invPsi::invPsi ( Real const &  y )

inline

initialize y_

Definition at line 78 of file STK_GammaBase.h.

: y_(y) {}

Member Function Documentation

fImpl()

Real STK::hidden::invPsi::fImpl ( Real const &  x ) const

inline

Returns

the value of the function at a

Parameters

x	a positive real value

Definition at line 82 of file STK_GammaBase.h.

{ return (y_ - Funct::psi_raw(x));}

References STK::Funct::psi_raw(), and y_.

xminImpl()

Real STK::hidden::invPsi::xminImpl ( ) const

inline

Returns

the minimal value of the function at x

Definition at line 84 of file STK_GammaBase.h.

{ return 0;}

Member Data Documentation

y_

Real STK::hidden::invPsi::y_

private

Definition at line 86 of file STK_GammaBase.h.

Referenced by fImpl().

---

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

• STK_GammaBase.h