|
SyDEVS
v0.6.7
Multiscale Simulation and Systems Modeling Library
|
|
SyDEVS
v0.6.7
Multiscale Simulation and Systems Modeling Library
|
A data structure which represents a sequence of increasing time points. More...
#include <time_sequence.h>
Classes | |
| class | const_iterator |
Public Types | |
| using | value_type = std::pair< int64, time_point > |
| The type used to store each entry. More... | |
Public Member Functions | |
| time_sequence () | |
| Constructs an empty time sequence. More... | |
| time_sequence (const time_sequence &)=default | |
| Copy constructor. More... | |
| time_sequence & | operator= (const time_sequence &)=default |
| Copy assignment. More... | |
| time_sequence (time_sequence &&)=default | |
| Move constructor. More... | |
| time_sequence & | operator= (time_sequence &&)=default |
| Move assignment. More... | |
| ~time_sequence ()=default | |
| Destructor. More... | |
| bool | empty () const |
Returns true if the time sequence is empty. More... | |
| int64 | size () const |
| Returns the number of time points. More... | |
| void | append (const time_point &tp) |
Appends tp if it exceeds all previously added time points. More... | |
| const_iterator | begin () const |
| Returns an iterator pointing to the oldest entry. More... | |
| const_iterator | end () const |
| Returns an iterator pointing beyond the newest entry. More... | |
| const_iterator | lower_bound (const time_point &tp) const |
Returns an iterator to the first position tp could be inserted. More... | |
| const_iterator | upper_bound (const time_point &tp) const |
Returns an iterator to the last position tp could be inserted. More... | |
| const time_point | front () const |
| Returns the first time point. More... | |
| const time_point | back () const |
| Returns the last time point. More... | |
| const time_point | operator[] (int64 rhs) const |
Returns the time point associated with the index rhs. More... | |
| const std::vector< value_type > & | partitions () const |
| Returns the partition indices and associated time points. More... | |
A data structure which represents a sequence of increasing time points.
A time_sequence object represents a strictly increasing sequence of time_point objects, saving space by storing duration-valued offsets. The offsets are expressed relative to the beginning of each partition, and each partition is associated with a single time_point object. Adding the partition and the offset yields the represented time point. Thus, from the outside, a time sequence appears as a vector containing a potentially large number of time points, whereas on the inside it stores time points only for partitions which are generally much smaller in number.
The time_sequence class can help record time series that are either supplied to simulation runs or result from them. The values associated with these time series are not represented, but each time value has an index that can be used to look up the corresponding value in another data structure.
While it is possible to access the i-th time_point object using ts[i], it is preferable to use iterators when possible. In particular, when accessing time points in sequence (either forwards or backwards), the iterator increment and decrement operations are more efficient than ts[i] as the latter involves a search through the partitions. To make iterators more convenient and thereby encourage their use, they provide both the time point and the index through the methods first and second, similar to a std::map. In addition to the begin() and end() methods, an iterator can be obtained using lower_bound or upper_bound, which search for a time point using the conventions of the standard C++ algorithm of the same name.
A current limitation of a time_sequence object is that it can only be modified by appending time points, since inserting or removing them might affect the partitions. Below is an example where a time sequence is created, three time points are added, and then each index and associated time point is accessed in sequence using a C++11 range-based for loop.
| using sydevs::time_sequence::value_type = std::pair<int64, time_point> |
The type used to store each entry.
| sydevs::time_sequence::time_sequence | ( | ) |
Constructs an empty time sequence.
|
default |
Copy constructor.
|
default |
Move constructor.
|
default |
Destructor.
| void sydevs::time_sequence::append | ( | const time_point & | tp | ) |
Appends tp if it exceeds all previously added time points.
| const time_point sydevs::time_sequence::back | ( | ) | const |
Returns the last time point.
| time_sequence::const_iterator sydevs::time_sequence::begin | ( | ) | const |
Returns an iterator pointing to the oldest entry.
|
inline |
Returns true if the time sequence is empty.
| time_sequence::const_iterator sydevs::time_sequence::end | ( | ) | const |
Returns an iterator pointing beyond the newest entry.
| const time_point sydevs::time_sequence::front | ( | ) | const |
Returns the first time point.
| time_sequence::const_iterator sydevs::time_sequence::lower_bound | ( | const time_point & | tp | ) | const |
Returns an iterator to the first position tp could be inserted.
|
default |
Copy assignment.
|
default |
Move assignment.
| const time_point sydevs::time_sequence::operator[] | ( | int64 | rhs | ) | const |
Returns the time point associated with the index rhs.
|
inline |
Returns the partition indices and associated time points.
|
inline |
Returns the number of time points.
| time_sequence::const_iterator sydevs::time_sequence::upper_bound | ( | const time_point & | tp | ) | const |
Returns an iterator to the last position tp could be inserted.
1.8.6 
