boolResult Class Reference
[Return types]

An STL container (dequeue) of booleans. More...

#include <boolResult.h>

Inherits std::deque< bool >.

List of all members.

Public Member Functions
template<class T >
	boolResult (const timeSeries< T > &ts)
int	getMinIndex ()
int	getMaxIndex ()
int	length ()
boolResult	operator&& (boolResult b2)
boolResult	operator|| (boolResult b2)
boolResult	operator! ()
Related Functions
(Note that these are not member functions.)
std::vector< int >	find (boolResult b)
	returns a vector containing the indices of TRUE elements contained in b

---

Detailed Description

An STL container (dequeue) of booleans.

This class is used to return the result of logical operations on timeSeries classes.

---

Constructor & Destructor Documentation

template<class T >

boolResult::boolResult

(

const timeSeries< T > &

ts

)

[inline]

construct a boolResult from a timeSeries. The index range of the boolResult container is inherited from the timeSeries.

It is rarely necessary to call this constructor explicitly, since boolResults are created automatically as the result of comparison operations between timeSeries objects

Parameters:

ts

timeSeries<T>&

---

Member Function Documentation

int boolResult::getMaxIndex

(

)

[inline]

returns the maximum allowable index

int boolResult::getMinIndex

(

)

[inline]

returns the minimum allowable index

int boolResult::length

(

)

[inline]

returns the length of the sequence

boolResult boolResult::operator!

(

)

[inline]

Returns:

!(*this)

Element-by-element logical negation.

boolResult boolResult::operator&&

(

boolResult

b2

)

[inline]

Parameters:

b2

a boolResult

Exceptions:

Length_error

Returns:

(*this) && b2

Element-by-element logical AND. The object and b2 must have the same length or this operation throws Length_error

boolResult boolResult::operator||

(

boolResult

b2

)

[inline]

Parameters:

b2

a boolResult

Exceptions:

Length_error

Returns:

(*this) || b2

Element-by-element logical OR. *this and b2 must have the same length or this operation throws Length_error