SimpleQueue - Maple Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Programming : Operations : Queues : SimpleQueue

SimpleQueue

the basic queue constructor

 

Calling Sequence

Parameters

Description

Examples

Calling Sequence

SimpleQueue(e1, e2, ..., en)

type(e::anything, 'Queue')

q:-enqueue(e::anything)

q:-dequeue()

q:-empty()

q:-front()

q:-length()

q:-clear()

 

$include <Queue.mi>

Enqueue(q::Queue, e::anything)::anything

Dequeue(q::Queue)::anything

Front(q::Queue)::anything

EmptyP(q::Queue)::anything

Parameters

ei

-

(optional) arbitrary Maple expression (not an expression sequence)

q

-

queue returned by SimpleQueue

e

-

arbitrary Maple expression (not an expression sequence)

Description

• 

The procedure SimpleQueue is a queue constructor. It returns a Maple expression that implements a queue object, which is of type Queue.

  

The SimpleQueue(e1, e2, ..., en) calling sequence constructs a queue containing the items e1, e2, ..., en. The item e1 is at the front of the queue.

• 

You can test whether a Maple expression e is a Queue object by using type(e, 'Queue'). An expression is of type Queue if it is an object with the methods empty, front, enqueue, and dequeue. Specific Queue implementations may support additional methods, but all Queues support at least these four methods. Queues built by the constructor SimpleQueue are currently represented by modules, so the message-passing syntax uses the :- operator.

• 

The empty method returns the value true if no items are on the queue, and returns the value false otherwise.

• 

To insert an item e (any Maple expression) at the back of a queue, use the enqueue method. The inserted value is returned.

• 

Items may be removed from the front of the queue by using the dequeue method. An error is raised if the queue is empty. This error may be caught using the exception string "empty queue".

• 

The item at the front of a non-empty queue may be examined, without changing the contents of the queue, by using the method front. If the queue is non-empty, this method returns the item at the front of the queue (the value that will be returned by the next call to the dequeue method), and raises the "empty queue" exception otherwise.

• 

Queues constructed by the SimpleQueue constructor also support the methods length, which returns the number of items on the queue, and clear, which empties the queue.

• 

The standard include file <Queue.mi> defines several inline procedures for invoking the basic Queue operations. The procedures provided are Enqueue, Dequeue, EmptyP, and Front. These procedures are not part of the Maple library, and are provided only as inlined procedures. (Note: The include file Stack&period;mi also provides an EmptyP inlined procedure, but it is compatible with the one in <Queue.mi>, so both include files may be used in the same Maple source file.

• 

For a non-object-oriented queue implementation, see the queue package.

Examples

QSimpleQueue&colon;

typeQ&comma;&apos;Queue&apos;

true

(1)

Q:-enqueue1&semi;Q:-enqueue2&semi;Q:-enqueue3

1

2

3

(2)

Q:-length

3

(3)

Q:-front

1

(4)

Q:-dequeue

1

(5)

Q:-front

2

(6)

whilenotQ:-emptydoQ:-dequeueend do

3

(7)

Q:-length

0

(8)

Q:-front

Error, (in front) empty queue

MathFolksSimpleQueue&colon;

MathFolks:-enqueueAlex&colon;MathFolks:-enqueueAllan&colon;MathFolks:-enqueueDave&colon;MathFolks:-enqueueDavid&colon;MathFolks:-enqueueEdgardo&colon;MathFolks:-enqueueJames&colon;MathFolks:-enqueueJuergen&colon;MathFolks:-enqueueLaurent&colon;MathFolks:-enqueueMichael&colon;MathFolks:-enqueuePaulina&colon;MathFolks:-enqueueRaqeeb&colon;MathFolks:-enqueueStephen&colon;whilenotMathFolks:-emptydoMathFolks:-dequeueend do

Stephen

(9)

See Also

module

queue

Stack

stack

 


Download Help Document

Was this information helpful?



Please add your Comment (Optional)
E-mail Address (Optional)
What is ? This question helps us to combat spam