tsResult Class Reference
[Return types]

class returned analysis functions More...

#include <tsResult.h>

Inherits std::vector< double >.

List of all members.

Public Member Functions
	tsResult (int n)
	tsResult (int n, double x)
	tsResult ()
	default constructor
	operator double () const
	conversion operator Converts a tsResult object to double by extracting the zeroth element.
tsResult &	operator+= (const tsResult &tsr)
	assign-sum
tsResult &	operator+= (const double &v)
	assign-sum
tsResult &	operator-= (const tsResult &tsr)
	assign-difference
tsResult &	operator-= (const double &v)
	assign-difference
tsResult &	operator*= (const tsResult &tsr)
	assign-multiply
tsResult &	operator*= (const double &v)
	assign-multiply
tsResult &	operator/= (const tsResult &tsr)
	assign-divide
tsResult &	operator/= (const double &v)
	assign-divide
tsResult	sqrt () const
	square root
Related Functions
(Note that these are not member functions.)
const tsResult	operator+ (const tsResult &lhs, const tsResult &rhs)
template<class T >
const tsResult	operator+ (const tsResult &lhs, const T &rhs)
const tsResult	operator- (const tsResult &lhs, const tsResult &rhs)
template<class T >
const tsResult	operator- (const tsResult &lhs, const T &rhs)
const tsResult	operator* (const tsResult &lhs, const tsResult &rhs)
template<class T >
const tsResult	operator* (const tsResult &lhs, const T &rhs)
const tsResult	operator/ (const tsResult &lhs, const tsResult &rhs)
template<class T >
const tsResult	operator/ (const tsResult &lhs, const T &rhs)
std::ostream &	operator<< (std::ostream &os, tsResult &r)

---

Detailed Description

class returned analysis functions

Overview

There are several analysis operations that are defined in the tsBase class. These functions (e.g. tsBase::sum() or tsBase::mean()) are defined for both timeSeries and timeSeriesArray objects.

Since the result of tsBase::mean(), for example, on a timeSeries is a scalar and the natural result of tsBase::mean() on a timeSeriesArray is a vector, the tsResult class accomodates both types of results. A tsResult object can be subscripted with the [] operator or accessed without any subscript. When accessed with no subscript a tsResult object returns only its zeroth element.

A full complement of aritmetic operations are provided.

---

Constructor & Destructor Documentation

tsResult::tsResult

(

int

n

)

[inline, explicit]

Parameters:

n

the dimension of the tsResult object

tsResult::tsResult	(	int	n,
		double	x
	)			[inline]

Parameters:

	n	the dimension of the tsResult object
	x	the initial value

---

Member Function Documentation

tsResult::operator double

(

)

const [inline]

conversion operator Converts a tsResult object to double by extracting the zeroth element.

Caution:

This conversion is invoked automatically by the compiler when a conversion to double is required by the expression context. This can lead to errors if a subscript is inadvertently ommitted from a tsResult object in an expression.

tsResult& tsResult::operator*=

(

const double &

v

)

[inline]

assign-multiply

Parameters:

v

a scalar

tsResult& tsResult::operator*=

(

const tsResult &

tsr

)

[inline]

assign-multiply

Parameters:

tsr

the object to multiply

Exceptions:

tsResult_Dimension_error

tsResult& tsResult::operator+=

(

const double &

v

)

[inline]

assign-sum

Parameters:

v

a scalar

tsResult& tsResult::operator+=

(

const tsResult &

tsr

)

[inline]

assign-sum

Parameters:

tsr

the object to add

Exceptions:

tsResult_Dimension_error

tsResult& tsResult::operator-=

(

const double &

v

)

[inline]

assign-difference

Parameters:

v

a scalar

tsResult& tsResult::operator-=

(

const tsResult &

tsr

)

[inline]

assign-difference

Parameters:

tsr

the object to subtract

Exceptions:

tsResult_Dimension_error

tsResult& tsResult::operator/=

(

const double &

v

)

[inline]

assign-divide

Parameters:

v

a scalar

tsResult& tsResult::operator/=

(

const tsResult &

tsr

)

[inline]

assign-divide

Parameters:

tsr

the object to divide

Exceptions:

tsResult_Dimension_error