STK::ISerie< Serie > Class Template Reference

Interface base class for Series. More...

#include <STK_ISerie.h>

Inheritance diagram for STK::ISerie< Serie >:

Public Member Functions
Real	first () const
Real	next () const
Public Member Functions inherited from STK::IRecursiveTemplate< Serie >
Serie &	asDerived ()
	static cast : return a reference of this with a cast to the derived class.
Serie const &	asDerived () const
	static cast : return a const reference of this with a cast to the derived class.
Serie *	asPtrDerived ()
	static cast : return a ptr on a Derived of this with a cast to the derived class.
Serie const *	asPtrDerived () const
	static cast : return a ptr on a constant Derived of this with a cast to the derived class.
Serie *	clone () const
	create a leaf using the copy constructor of the Derived class.
Serie *	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.

Protected Member Functions
	ISerie ()
	Default Constructor.
	~ISerie ()
	destructor.
Protected Member Functions inherited from STK::IRecursiveTemplate< Serie >
	IRecursiveTemplate ()
	constructor.
	~IRecursiveTemplate ()
	destructor.

Detailed Description

template<class Serie>
class STK::ISerie< Serie >

Interface base class for Series.

The ISerie class is the template base class for all Series.

ISerie takes a Serie template parameter. This parameter is the type of the class which derives from it. For exemple

class Serie: public ISerie<Serie>
{...}

The pseudo virtual function defined in this interface have the following definition:

// return the first coefficient
inline Real firstImpl() const;
// return the next coefficient: first() have to be called before
//  any use of nextImpl()
inline Real next() const;

Definition at line 66 of file STK_ISerie.h.

Constructor & Destructor Documentation

ISerie()

template<class Serie >

STK::ISerie< Serie >::ISerie ( )

inlineprotected

Default Constructor.

Definition at line 70 of file STK_ISerie.h.

{}

~ISerie()

template<class Serie >

STK::ISerie< Serie >::~ISerie ( )

inlineprotected

destructor.

Definition at line 72 of file STK_ISerie.h.

{}

Member Function Documentation

first()

template<class Serie >

Real STK::ISerie< Serie >::first ( ) const

inline

Returns

the first coefficient of the serie

Definition at line 76 of file STK_ISerie.h.

{ return this->asDerived().firstImpl();}

References STK::IRecursiveTemplate< Serie >::asDerived().

next()

template<class Serie >

Real STK::ISerie< Serie >::next ( ) const

inline

Returns

the next coefficient: first() have to be called before any use of next()

Definition at line 80 of file STK_ISerie.h.

{ return this->asDerived().nextImpl();}

References STK::IRecursiveTemplate< Serie >::asDerived().

---

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

• STK_ISerie.h