aff::Series< T > Class Template Reference

A base class for time series and spectra. More...

#include <series.h>

Inheritance diagram for aff::Series< T >:

Collaboration diagram for aff::Series< T >:

Public Types
Various types
typedef Series< T >	Tcontainer
	Type of this array. More...
typedef ConstSeries< T >	Tbase
	base is container of const (see specialization below) More...
typedef Tbase	Tcontainer_of_const
	Type of the array of const values. More...
typedef aff::LinearShape	Tshape
	Type of shape. More...
typedef Tbase	Tcoc
	short for Tcontainer_of_const More...
typedef aff::SharedHeap< T >	Trepresentation
	Type of representation. More...
typedef T	Tvalue
	Element type. More...
typedef T *	Tpointer
	Type of pointer to element. More...
typedef T &	Treference
	Type of reference to element. More...
typedef const T	Tconst_value
	Element const type. More...
typedef const T *	Tconst_pointer
	Type of pointer to const element. More...
typedef const T &	Tconst_reference
	Type of reference to const element. More...
Various types
In particular due to our concept of const-correctness we need several typedefs to declare types derived from the element type of the array. See also Notes on the const-correctness of arrays
typedef Tshape::Tstepper	Tstepper
	Type of stepper. More...

Public Member Functions
T &	operator() (const Tsubscript &i) const
	Data modification access. More...
T *	pointer () const
Tcontainer &	operator= (const T &value)
	set whole series to value More...
template<class C >
Tcontainer &	copyin (const C &a)
	copy in is allowed here More...
Tcontainer	copyout () const
	create a (deep) copy of this More...
const Trepresentation &	representation () const
	expose representation More...
const Tshape &	shape () const
	provide access to const shape More...
Constructors
Note We use the default copy constructor, which automatically invokes the copy constructors of the base classes aff::LinearShape and aff::SharedHeap<T>. This essentially is a shallow copy of the array, i.e. the copy will reference to the same elements in memory. See aff::Series<T>::copyin() and aff::Series<T>::copyout() for deep copy operations.
	Series ()
	construct from nothing (empty) More...
	Series (const Tsize &size)
	construct for a given size More...
	Series (const Tsubscript &first, const Tsubscript &last)
	construct from index range limits More...
	Series (const Tshape &shape)
	construct from shape More...
	Series (const Tshape &shape, const Trepresentation &representation)
	construct from shape and representation More...
	Series (const Trepresentation &representation, const Tsubscript &shift=0)
	construct from representation More...
access declarations
const Tshape &	shape () const
	provide access to const shape More...
Shape access
const Tsubscript &	f () const
	(short for) first valid index More...
const Tsubscript &	l () const
	(short for) last valid index More...
access declarations
const Tsubscript &	first () const
	access to base class function More...
const Tsubscript &	last () const
	return last legal index More...
Tsize	size () const
	by size we mean the size defined by the shape More...
void	setfirstindex (const Tsubscript &first)
	set first index to first More...
void	setlastindex (const Tsubscript &last)
	set last index to last More...
void	setindexrange (const Tsubscript &first, const Tsubscript last)
	set index range [ first , last ] More...
void	shift (const Tsubscript &i)
	shift effective index range by i More...

Protected Member Functions
Tsubscript	offset (const Tsubscript &i) const
	provide offset function to derived class More...

Private Attributes
Trepresentation	Mrepresentation
	my (mutable) memory representation More...

Detailed Description

template<class T>
class aff::Series< T >

A base class for time series and spectra.

See also

aff::ConstSeries

Notes on the const-correctness of arrays

Replicated ConstSharedHeap

Examples:

tests/helpertest.cc, tests/operatortest.cc, and tests/seriestest.cc.

Definition at line 266 of file series.h.

---

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

• series.h