deque_iterator

class deque_iterator #(type T =  int) extends iterator#( T )

Provides an iterator to a deque.

Parameter

Toptional The type of data collected in a deque.  The default is int.
Summary
deque_iteratorProvides an iterator to a deque.
Types
deque_typeThe shorthand of the deque type of type T.
Functions
newCreates a deque iterator.
has_nextvirtual Returns 1 if the iterator has more elements.
nextvirtual Returns the next element.
removevirtual Removes the last element returned by the iterator.

Types

deque_type

typedef deque#(T) deque_type

The shorthand of the deque type of type T.

Functions

new

function new(deque_type dq)

Creates a deque iterator.

Argument

dqA deque to be iterated.

has_next

virtual function bit has_next()

virtual Returns 1 if the iterator has more elements.

Returns

If the iterator has more elements, returns 1.  Otherwise, returns 0.

next

virtual function T next()

virtual Returns the next element.

Returns

The next element in the iterator.

remove

virtual function void remove()

virtual Removes the last element returned by the iterator.  This function can be called once per call to next.

Returns

None.

class deque_iterator #(type T =  int) extends iterator#( T )
Provides an iterator to a deque.
class deque #(type T =  int) extends collection#( T )
Implements a double-ended queue using a queue.
typedef deque#(T) deque_type
The shorthand of the deque type of type T.
function new(deque_type dq)
Creates a deque iterator.
virtual function bit has_next()
virtual Returns 1 if the iterator has more elements.
virtual function T next()
virtual Returns the next element.
virtual function void remove()
virtual Removes the last element returned by the iterator.