HelpSource/Classes/PriorityQueue.schelp

   1 CLASS::PriorityQueue
   2 summary:: Priority queue data structure
   3 categories:: Collections>Ordered
   4
   5 DESCRIPTION::
   6 PriorityQueue implements a priority queue data structure, which is used to build schedulers. It allows you to put in items at some arbitrary time and pop them in
   7 time order.
   8
   9 INSTANCEMETHODS::
  10 private::prInternalArray
  11
  12
  13 method::put
  14 Puts the item in the queue at the given time.
  15
  16 method::topPriority
  17 Returns the time of the earliest item in the queue.
  18
  19 method::pop
  20 Returns the earliest item in the queue.
  21
  22 method::clear
  23 Empty the queue.
  24
  25 method::isEmpty
  26 Return a link::Classes/Boolean:: whether the queue is empty.
  27
  28 method::notEmpty
  29 Return a link::Classes/Boolean:: whether the queue is not empty.
  30
  31 method::removeValue
  32 Remove all instances of value from the queue.
  33
  34
  35 EXAMPLES::
  36
  37 code::
  38 (
  39 var p;
  40 p = PriorityQueue.new;
  41
  42 p.put(0.1, \a);
  43 p.put(2.0, \b);
  44 p.put(0.5, \c);
  45 p.put(0.2, \d);
  46 p.put(1.0, \e);
  47
  48 while ({ p.notEmpty },{
  49         [p.topPriority, p.pop].postln;
  50 });
  51
  52
  53 p.pop.postln;
  54 p.pop.postln;
  55 p.pop.postln;
  56
  57 )
  58
  59 [ 0.1, a ]
  60 [ 0.2, d ]
  61 [ 0.5, c ]
  62 [ 1, e ]
  63 [ 2, b ]
  64 nil
  65 nil
  66 nil
  67 ::