Multivariate Point Process Package  0.1
Public Member Functions | List of all members
Sequence Class Reference

Sequence encapsulates the operations on a sequence of events. More...

#include "include/Sequence.h"

Public Member Functions

 Sequence (const double &T)
 
 Sequence ()
 
void Add (const Event &event)
 Add a new event to the current sequence. More...
 
const std::vector< Event > & GetEvents () const
 Return a constant reference to the sequence of event. More...
 
double GetTimeWindow () const
 Return the observation window. More...
 
void SetTimeWindow (const double &T)
 Update the current observation window. More...
 
void PopBack ()
 Get rid of the last event in the current sequence. More...
 

Detailed Description

Sequence encapsulates the operations on a sequence of events.

Definition at line 16 of file Sequence.h.

Constructor & Destructor Documentation

Sequence::Sequence ( const double &  T)
inline

The constructor.

Parameters
[in]Tobservation window of the sequence.

Definition at line 38 of file Sequence.h.

Sequence::Sequence ( )
inline

Definition at line 39 of file Sequence.h.

Member Function Documentation

void Sequence::Add ( const Event event)
inline

Add a new event to the current sequence.

Parameters
eventa given new event.

If the current maximum time is greater than the predefined observation time window, we update the time window to the maximum event time observed so far.

Definition at line 45 of file Sequence.h.

const std::vector<Event>& Sequence::GetEvents ( ) const
inline

Return a constant reference to the sequence of event.

Definition at line 58 of file Sequence.h.

double Sequence::GetTimeWindow ( ) const
inline

Return the observation window.

Returns
the observation window of the sequence.

Definition at line 64 of file Sequence.h.

void Sequence::PopBack ( )
inline

Get rid of the last event in the current sequence.

Definition at line 75 of file Sequence.h.

void Sequence::SetTimeWindow ( const double &  T)
inline

Update the current observation window.

Parameters
Tnew observation window.

Definition at line 70 of file Sequence.h.


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