This class implements a "sorted list" data structure, sorting "events" based on a date. More...
#include <timeline.h>
Classes | |
class | const_iterator |
This is bi-directional iterator through the timeline. More... | |
class | Event |
Base class for nodes in the timeline. More... | |
class | EventChangeOnhand |
A timeline event representing a change of the current value. More... | |
class | EventMaxQuantity |
A timeline event representing a change of the maximum target. More... | |
class | EventMinQuantity |
A timeline event representing a change of the minimum target. More... | |
class | iterator |
This is bi-directional iterator through the timeline. More... | |
Public Member Functions | |
const_iterator | begin (const Event *e) const |
const_iterator | begin () const |
iterator | begin (Event *e) |
iterator | begin () |
bool | check () const |
bool | empty () const |
const_iterator | end () const |
iterator | end () |
void | erase (Event *) |
void | insert (EventChangeOnhand *e, double qty, const Date &d) |
void | insert (Event *) |
void | inspect (string name) const |
const_iterator | rbegin () const |
iterator | rbegin () |
int | size () const |
TimeLine () | |
void | update (EventChangeOnhand *, double, const Date &) |
Friends | |
class | Event |
This class implements a "sorted list" data structure, sorting "events" based on a date.
The data structure has slow insert scalability: O(n)
Moving data around in the structure is efficient though: O(1)
The class leverages the STL library and also follows its api.
The class used to instantiate a timeline must support the "bool operator < (TYPE)".
Note that the events store the quantity but NOT the date. We pick up the date from the template type. The reasoning for this choice is that the quantity requires more computation than the date and is worthwhile caching. The date field can be read efficiently from the parent type.
Definition at line 52 of file timeline.h.
frepple::utils::TimeLine< type >::TimeLine | ( | ) | [inline] |
Definition at line 234 of file timeline.h.
const_iterator frepple::utils::TimeLine< type >::begin | ( | const Event * | e | ) | const [inline] |
Definition at line 246 of file timeline.h.
const_iterator frepple::utils::TimeLine< type >::begin | ( | ) | const [inline] |
Definition at line 245 of file timeline.h.
iterator frepple::utils::TimeLine< type >::begin | ( | Event * | e | ) | [inline] |
Definition at line 242 of file timeline.h.
iterator frepple::utils::TimeLine< type >::begin | ( | ) | [inline] |
Definition at line 241 of file timeline.h.
bool frepple::utils::TimeLine< type >::check | ( | ) | const [inline] |
This function is used to trace the consistency of the data structure.
Definition at line 491 of file timeline.h.
bool frepple::utils::TimeLine< type >::empty | ( | ) | const [inline] |
Definition at line 249 of file timeline.h.
const_iterator frepple::utils::TimeLine< type >::end | ( | ) | const [inline] |
Definition at line 248 of file timeline.h.
iterator frepple::utils::TimeLine< type >::end | ( | ) | [inline] |
Definition at line 244 of file timeline.h.
void frepple::utils::TimeLine< type >::erase | ( | Event * | e | ) | [inline] |
Definition at line 385 of file timeline.h.
void frepple::utils::TimeLine< type >::insert | ( | EventChangeOnhand * | e, | |
double | qty, | |||
const Date & | d | |||
) | [inline] |
Definition at line 251 of file timeline.h.
void frepple::utils::TimeLine< type >::insert | ( | Event * | e | ) | [inline] |
Definition at line 291 of file timeline.h.
void frepple::utils::TimeLine< type >::inspect | ( | string | name | ) | const [inline] |
This function is used for debugging purposes.
It prints a header line, followed by the date, quantity and on_hand of all events in the timeline.
Definition at line 264 of file timeline.h.
const_iterator frepple::utils::TimeLine< type >::rbegin | ( | ) | const [inline] |
Definition at line 247 of file timeline.h.
iterator frepple::utils::TimeLine< type >::rbegin | ( | ) | [inline] |
Definition at line 243 of file timeline.h.
int frepple::utils::TimeLine< type >::size | ( | ) | const [inline] |
Definition at line 235 of file timeline.h.
void frepple::utils::TimeLine< type >::update | ( | EventChangeOnhand * | e, | |
double | newqty, | |||
const Date & | d | |||
) | [inline] |
Definition at line 416 of file timeline.h.
friend class Event [friend] |
Definition at line 54 of file timeline.h.