A resizable-array implementation of the IDeque interface which has no capacity restrictions. The backing array will grow as necessary to support usage. This collection is not thread-safe. Null elements are prohibited in this collection. More...
Public Member Functions | |
| ArrayDeque (uint size=DefaultInitialSize) | |
| ArrayDeque (IEnumerable< T > elements) | |
| bool | TryEnqueue (T value) |
| Attempts to insert the given value onto the back of this queue unless the deque has reached its capacity limit in which case this method would throw an exception. | |
| void | Enqueue (T value) |
| Inserts the given value onto the back of this queue unless the queue has reached its capacity limit in which case this method would throw an exception. Generally it is preferable to call the TryEnqueue method and check the return value to determine if the operation succeeded. | |
| bool | TryDequeue (out T front) |
| Attempt to remove and return the element at the front of the queue if there is any element to return otherwise the method returns false. | |
| T | Dequeue () |
| Removes and returns the element at the front of the queue if the queue is currently not empty, otherwise this method throws an exception to indicate that there is no value in the queue currently. Generally it is preferable to call the TryDequeue method and check the return value to see if the operation succeeded. | |
| bool | TryEnqueueFront (T item) |
| Attempts to insert the given value onto the front of this queue unless the queue has reached its capacity limit in which case this method would throw an exception. | |
| void | EnqueueFront (T item) |
| Inserts the given value onto the front of this queue unless the queue has reached its capacity limit in which case this method would throw an exception. Generally it is preferable to call the TryEnqueueFront method and check the return value to determine if the operation succeeded. | |
| bool | TryEnqueueBack (T item) |
| Attempts to insert the given value onto the back of this queue unless the deque has reached its capacity limit in which case this method would throw an exception. | |
| void | EnqueueBack (T item) |
| Inserts the given value onto the back of this queue unless the deque has reached its capacity limit in which case this method would throw an exception. Generally it is preferable to call the TryEnqueueBack method and check the return value to determine if the operation succeeded. | |
| bool | TryDequeueFront (out T result) |
| Attempt to remove and return the element at the front of the queue if there is any element to return otherwise the method returns false. | |
| T | DequeueFront () |
| Removes and returns the element at the front of the queue if the queue is currently not empty, otherwise this method throws an exception to indicate that there is no value in the queue currently. Generally it is preferable to call the TryDequeueFront method and check the return value to see if the operation succeeded. | |
| bool | TryDequeueBack (out T result) |
| Attempt to remove and return the element at the back of the queue if there is any element to return otherwise the method returns false. | |
| T | DequeueBack () |
| Removes and returns the element at the back of the queue if the queue is currently not empty, otherwise this method throws an exception to indicate that there is no value in the queue currently. Generally it is preferable to call the TryDequeue method and check the return value to see if the operation succeeded. | |
| T | Peek () |
| Returns the element at the front of the queue if the queue is currently not empty, otherwise this method throws an exception to indicate that there is no value in the queue currently. Generally it is preferable to call the TryPeek method and check the return value to see if the operation succeeded. | |
| bool | TryPeek (out T front) |
| Attempt to read and return the element at the front of the queue if there is any element to return otherwise the method returns false. | |
| T | PeekFront () |
| Returns the element at the front of the queue if the queue is currently not empty, otherwise this method throws an exception to indicate that there is no value in the queue currently. Generally it is preferable to call the TryPeek method and check the return value to see if the operation succeeded. | |
| bool | TryPeekFront (out T front) |
| Attempt to read and return the element at the front of the queue if there is any element to return otherwise the method returns false. | |
| T | PeekBack () |
| Returns the element at the front of the queue if the queue is currently not empty, otherwise this method throws an exception to indicate that there is no value in the queue currently. Generally it is preferable to call the TryPeek method and check the return value to see if the operation succeeded. | |
| bool | TryPeekBack (out T back) |
| Attempt to read and return the element at the front of the queue if there is any element to return otherwise the method returns false. | |
| void | Clear () |
| bool | Contains (T item) |
| void | CopyTo (T[] array, int index) |
| void | CopyTo (Array array, int index) |
| bool | Remove (T item) |
| IEnumerator< T > | GetEnumerator () |
| override bool | Equals (object other) |
| bool | Equals (IEnumerable< T > other) |
| override int | GetHashCode () |
 Public Member Functions inherited from Apache.Qpid.Proton.Utilities.IDeque< T > | |
| void ICollection< T >. | Add (T item) |
| Inserts the given value onto the back of this queue unless the deque has reached its capacity limit in which case this method would throw an exception. Generally it is preferable to call the TryEnqueueBack method and check the return value to determine if the operation succeeded. | |
Public Attributes | |
| readonly object | sync = new() |
Static Public Attributes | |
| const int | DefaultInitialSize = 16 |
| const int | AtLeastOne = 1 |
Properties | |
| bool | IsEmpty [get] |
| Returns true if the double ended queue is currently empty. This method provides an optimized means of checking for empty in this collection type where otherwise the count property might be used which could require a calculation on each call to determine the current element count. | |
| int | Count [get] |
| Returns the current number of elements contained in the double ended Queue. | |
| bool | IsReadOnly [get] |
| bool | IsSynchronized [get] |
| object | SyncRoot [get] |
| Properties inherited from Apache.Qpid.Proton.Utilities.IDeque< T > | |
Detailed Description
A resizable-array implementation of the IDeque interface which has no capacity restrictions. The backing array will grow as necessary to support usage. This collection is not thread-safe. Null elements are prohibited in this collection.
0 1 2 3 4 5 6 7 8 9
| | | | | | | | | | | Empty head = tail = 0
H T
0 1 2 3 4 5 6 7 8 9
|x|x|x|x|x| | | | | | Size 5; Head = 0, tail = 5
H T
0 1 2 3 4 5 6 7 8 9
|x|x|x| | | | | |x|x| Size 5; Head = 8, tail = 3
T H
- Head always advances to meat tail even on wrap.
- In the inverted case the gap between head and tail is empty elements
Following capacity increase when head > tail (or head == tail because of insert when one slot left)
0 1 2 3 4 5 6 7 8 9
|x|x|x| | | | | |x|x| | Size 5; Head = 8, tail = 3
T H
- Template Parameters
-
T The type that is stored in this double ended queue implementation
Member Function Documentation
◆ Dequeue()
|
inline |
Removes and returns the element at the front of the queue if the queue is currently not empty, otherwise this method throws an exception to indicate that there is no value in the queue currently. Generally it is preferable to call the TryDequeue method and check the return value to see if the operation succeeded.
- Returns
- The element at the front of the queue
- Exceptions
-
InvalidOperationException If the queue is currently empty
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ DequeueBack()
|
inline |
Removes and returns the element at the back of the queue if the queue is currently not empty, otherwise this method throws an exception to indicate that there is no value in the queue currently. Generally it is preferable to call the TryDequeue method and check the return value to see if the operation succeeded.
- Returns
- The element at the back of the queue
- Exceptions
-
InvalidOperationException If the queue is currently empty
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ DequeueFront()
|
inline |
Removes and returns the element at the front of the queue if the queue is currently not empty, otherwise this method throws an exception to indicate that there is no value in the queue currently. Generally it is preferable to call the TryDequeueFront method and check the return value to see if the operation succeeded.
- Returns
- The element at the front of the queue
- Exceptions
-
InvalidOperationException If the queue is currently empty
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ Enqueue()
|
inline |
Inserts the given value onto the back of this queue unless the queue has reached its capacity limit in which case this method would throw an exception. Generally it is preferable to call the TryEnqueue method and check the return value to determine if the operation succeeded.
- Parameters
-
value The value to add to the tail of the queue
- Exceptions
-
InvalidOperationException If the queue is currently at max capacity
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ EnqueueBack()
|
inline |
Inserts the given value onto the back of this queue unless the deque has reached its capacity limit in which case this method would throw an exception. Generally it is preferable to call the TryEnqueueBack method and check the return value to determine if the operation succeeded.
- Parameters
-
value The value to add to the back of the queue
- Exceptions
-
InvalidOperationException If the queue is currently at max capacity
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ EnqueueFront()
|
inline |
Inserts the given value onto the front of this queue unless the queue has reached its capacity limit in which case this method would throw an exception. Generally it is preferable to call the TryEnqueueFront method and check the return value to determine if the operation succeeded.
- Parameters
-
value The value to add to the front of the queue
- Exceptions
-
InvalidOperationException If the queue is currently at max capacity
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ Peek()
|
inline |
Returns the element at the front of the queue if the queue is currently not empty, otherwise this method throws an exception to indicate that there is no value in the queue currently. Generally it is preferable to call the TryPeek method and check the return value to see if the operation succeeded.
- Returns
- The element at the front of the queue
- Exceptions
-
InvalidOperationException If the queue is currently empty
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ PeekBack()
|
inline |
Returns the element at the front of the queue if the queue is currently not empty, otherwise this method throws an exception to indicate that there is no value in the queue currently. Generally it is preferable to call the TryPeek method and check the return value to see if the operation succeeded.
- Returns
- The element at the front of the queue
- Exceptions
-
InvalidOperationException If the queue is currently empty
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ PeekFront()
|
inline |
Returns the element at the front of the queue if the queue is currently not empty, otherwise this method throws an exception to indicate that there is no value in the queue currently. Generally it is preferable to call the TryPeek method and check the return value to see if the operation succeeded.
- Returns
- The element at the front of the queue
- Exceptions
-
InvalidOperationException If the queue is currently empty
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ TryDequeue()
|
inline |
Attempt to remove and return the element at the front of the queue if there is any element to return otherwise the method returns false.
- Parameters
-
front A reference to store the value at the front of the queue
- Returns
- True if a value was removed from the queue and returned.
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ TryDequeueBack()
|
inline |
Attempt to remove and return the element at the back of the queue if there is any element to return otherwise the method returns false.
- Parameters
-
back A reference to store the value at the back of the queue
- Returns
- True if a value was removed from the queue and returned.
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ TryDequeueFront()
|
inline |
Attempt to remove and return the element at the front of the queue if there is any element to return otherwise the method returns false.
- Parameters
-
front A reference to store the value at the front of the queue
- Returns
- True if a value was removed from the queue and returned.
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ TryEnqueue()
|
inline |
Attempts to insert the given value onto the back of this queue unless the deque has reached its capacity limit in which case this method would throw an exception.
- Parameters
-
value The value to add to the front of the queue
- Returns
- True if the value was added to the deque
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ TryEnqueueBack()
|
inline |
Attempts to insert the given value onto the back of this queue unless the deque has reached its capacity limit in which case this method would throw an exception.
- Parameters
-
value The value to add to the front of the queue
- Returns
- True if the value was added to the deque
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ TryEnqueueFront()
|
inline |
Attempts to insert the given value onto the front of this queue unless the queue has reached its capacity limit in which case this method would throw an exception.
- Parameters
-
value The value to add to the front of the queue
- Returns
- True if the value was added to the deque
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ TryPeek()
|
inline |
Attempt to read and return the element at the front of the queue if there is any element to return otherwise the method returns false.
- Parameters
-
front A reference to store the value at the front of the queue
- Returns
- True if a value was read from the queue and returned.
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ TryPeekBack()
|
inline |
Attempt to read and return the element at the front of the queue if there is any element to return otherwise the method returns false.
- Parameters
-
front A reference to store the value at the front of the queue
- Returns
- True if a value was read from the queue and returned.
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ TryPeekFront()
|
inline |
Attempt to read and return the element at the front of the queue if there is any element to return otherwise the method returns false.
- Parameters
-
front A reference to store the value at the front of the queue
- Returns
- True if a value was read from the queue and returned.
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
Property Documentation
◆ Count
|
get |
Returns the current number of elements contained in the double ended Queue.
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
◆ IsEmpty
|
get |
Returns true if the double ended queue is currently empty. This method provides an optimized means of checking for empty in this collection type where otherwise the count property might be used which could require a calculation on each call to determine the current element count.
Implements Apache.Qpid.Proton.Utilities.IDeque< T >.
The documentation for this class was generated from the following file:
- src/Proton/Utilities/ArraryDeque.cs
