A Discrete-Event Network Simulator
API
heap-scheduler.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2005 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 
21 #ifndef HEAP_SCHEDULER_H
22 #define HEAP_SCHEDULER_H
23 
24 #include "scheduler.h"
25 #include <stdint.h>
26 #include <vector>
27 
34 namespace ns3 {
35 
72 class HeapScheduler : public Scheduler
73 {
74 public:
79  static TypeId GetTypeId (void);
80 
82  HeapScheduler ();
84  virtual ~HeapScheduler ();
85 
86  // Inherited
87  virtual void Insert (const Scheduler::Event &ev);
88  virtual bool IsEmpty (void) const;
89  virtual Scheduler::Event PeekNext (void) const;
90  virtual Scheduler::Event RemoveNext (void);
91  virtual void Remove (const Scheduler::Event &ev);
92 
93 private:
95  typedef std::vector<Scheduler::Event> BinaryHeap;
96 
103  inline std::size_t Parent (std::size_t id) const;
110  std::size_t Sibling (std::size_t id) const;
117  inline std::size_t LeftChild (std::size_t id) const;
124  inline std::size_t RightChild (std::size_t id) const;
130  inline std::size_t Root (void) const;
135  std::size_t Last (void) const;
142  inline bool IsRoot (std::size_t id) const;
149  inline bool IsBottom (std::size_t id) const;
157  inline bool IsLessStrictly (std::size_t a, std::size_t b) const;
165  inline std::size_t Smallest (std::size_t a, std::size_t b) const;
172  inline void Exch (std::size_t a, std::size_t b);
174  void BottomUp (void);
180  void TopDown (std::size_t start);
181 
183  BinaryHeap m_heap;
184 };
185 
186 } // namespace ns3
187 
188 #endif /* HEAP_SCHEDULER_H */
ns3::HeapScheduler::PeekNext
virtual Scheduler::Event PeekNext(void) const
Get a pointer to the next event.
Definition: heap-scheduler.cc:210
ns3::HeapScheduler::~HeapScheduler
virtual ~HeapScheduler()
Destructor.
Definition: heap-scheduler.cc:61
ns3::HeapScheduler::Last
std::size_t Last(void) const
Return the index of the last element.
Definition: heap-scheduler.cc:106
ns3::HeapScheduler::IsRoot
bool IsRoot(std::size_t id) const
Test if an index is the root.
Definition: heap-scheduler.cc:99
ns3::HeapScheduler::Parent
std::size_t Parent(std::size_t id) const
Get the parent index of a given entry.
Definition: heap-scheduler.cc:67
ns3::HeapScheduler::RemoveNext
virtual Scheduler::Event RemoveNext(void)
Remove the earliest event from the event list.
Definition: heap-scheduler.cc:216
visualizer.core.start
def start()
Definition: core.py:1855
ns3::HeapScheduler::Sibling
std::size_t Sibling(std::size_t id) const
Get the next sibling of a given entry.
Definition: heap-scheduler.cc:73
ns3::HeapScheduler::GetTypeId
static TypeId GetTypeId(void)
Register this type.
Definition: heap-scheduler.cc:41
ns3::HeapScheduler::IsLessStrictly
bool IsLessStrictly(std::size_t a, std::size_t b) const
Compare (less than) two items.
Definition: heap-scheduler.cc:132
scheduler.h
ns3::Scheduler abstract base class, ns3::Scheduler::Event and ns3::Scheduler::EventKey declarations...
ns3::HeapScheduler
a binary heap event scheduler
Definition: heap-scheduler.h:72
ns3::Scheduler
Maintain the event list.
Definition: scheduler.h:155
ns3::HeapScheduler::Insert
virtual void Insert(const Scheduler::Event &ev)
Insert a new Event in the schedule.
Definition: heap-scheduler.cc:202
ns3::HeapScheduler::RightChild
std::size_t RightChild(std::size_t id) const
Get the right child index of a given entry.
Definition: heap-scheduler.cc:85
ns3::HeapScheduler::LeftChild
std::size_t LeftChild(std::size_t id) const
Get the left child of a given entry.
Definition: heap-scheduler.cc:79
ns3::HeapScheduler::m_heap
BinaryHeap m_heap
The event list.
Definition: heap-scheduler.h:183
ns3::Scheduler::Event
Scheduler event.
Definition: scheduler.h:181
ns3::HeapScheduler::Exch
void Exch(std::size_t a, std::size_t b)
Swap two items.
Definition: heap-scheduler.cc:121
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::HeapScheduler::HeapScheduler
HeapScheduler()
Constructor.
Definition: heap-scheduler.cc:51
ns3::HeapScheduler::Root
std::size_t Root(void) const
Get the root index of the heap.
Definition: heap-scheduler.cc:92
ns3::HeapScheduler::IsEmpty
virtual bool IsEmpty(void) const
Test if the schedule is empty.
Definition: heap-scheduler.cc:146
ns3::HeapScheduler::IsBottom
bool IsBottom(std::size_t id) const
Test if an index is at the bottom of the heap.
Definition: heap-scheduler.cc:114
ns3::HeapScheduler::Remove
virtual void Remove(const Scheduler::Event &ev)
Remove a specific event from the event list.
Definition: heap-scheduler.cc:228
ns3::HeapScheduler::BottomUp
void BottomUp(void)
Percolate a newly inserted Last item to its proper position.
Definition: heap-scheduler.cc:153
ns3::HeapScheduler::Smallest
std::size_t Smallest(std::size_t a, std::size_t b) const
Minimum of two items.
Definition: heap-scheduler.cc:139
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:58
ns3::HeapScheduler::BinaryHeap
std::vector< Scheduler::Event > BinaryHeap
Event list type: vector of Events, managed as a heap.
Definition: heap-scheduler.h:95
ns3::HeapScheduler::TopDown
void TopDown(std::size_t start)
Percolate a deletion bubble down the heap.
Definition: heap-scheduler.cc:166