Resources/Documents/heap-scheduler_8h_source.html

 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
 /*
  * Copyright (c) 2005 INRIA
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 2 as
  * published by the Free Software Foundation;
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
  */

 #ifndef HEAP_SCHEDULER_H
 #define HEAP_SCHEDULER_H

 #include "scheduler.h"
 #include <stdint.h>
 #include <vector>

 namespace ns3 {

 class HeapScheduler : public Scheduler
 {
 public:
   static TypeId GetTypeId (void);

   HeapScheduler ();
   virtual ~HeapScheduler ();

   // Inherited
   virtual void Insert (const Scheduler::Event &ev);
   virtual bool IsEmpty (void) const;
   virtual Scheduler::Event PeekNext (void) const;
   virtual Scheduler::Event RemoveNext (void);
   virtual void Remove (const Scheduler::Event &ev);

 private:
   typedef std::vector<Scheduler::Event> BinaryHeap;

   inline std::size_t Parent (std::size_t id) const;
   std::size_t Sibling (std::size_t id) const;
   inline std::size_t LeftChild (std::size_t id) const;
   inline std::size_t RightChild (std::size_t id) const;
   inline std::size_t Root (void) const;
   std::size_t Last (void) const;
   inline bool IsRoot (std::size_t id) const;
   inline bool IsBottom (std::size_t id) const;
   inline bool IsLessStrictly (std::size_t a, std::size_t b) const;
   inline std::size_t Smallest (std::size_t a, std::size_t b) const;
   inline void Exch (std::size_t a, std::size_t b);
   void BottomUp (void);
   void TopDown (std::size_t start);

   BinaryHeap m_heap;
 };

 } // namespace ns3

 #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:1844

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:53

ns3::Scheduler
Maintain the event list.
Definition: scheduler.h:66

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:164

ns3::Scheduler::Event
Scheduler event.
Definition: scheduler.h:92

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:76

ns3::HeapScheduler::TopDown
void TopDown(std::size_t start)
Percolate a deletion bubble down the heap.
Definition: heap-scheduler.cc:166