core/collections/queues.facts

   1 IN: queues
   2 USING: help ;
   3
   4 HELP: queue
   5 { $class-description "A simple first-in-first-out queue. See " { $link "queues" } "." } ;
   6
   7 HELP: <queue>
   8 { $values { "queue" "a new queue" } }
   9 { $description "Makes a new queue with no elements." } ;
  10
  11 HELP: queue-empty?
  12 { $values { "queue" "a queue" } { "?" "a boolean" } }
  13 { $description "Tests if a queue contains no elements." } ;
  14
  15 HELP: deque
  16 { $values { "queue" "a queue" } { "elt" "an object" } }
  17 { $description "Removes an element from the front of the queue." }
  18 { $errors "Throws an " { $link empty-queue } " error if the queue has no entries." } ;
  19
  20 HELP: enque
  21 { $values { "elt" "an object" } { "queue" "a queue" } }
  22 { $description "Adds an element to the back of the queue." } ;
  23
  24 HELP: empty-queue
  25 { $description "Throws an " { $link empty-queue } " error." }
  26 { $error-description "Thrown by " { $link deque } " if the queue has no entries." } ;