I_Deque (Interface)

Interface for a double ended queue - Deque

Extends: I_Collection

Properties

_Values

Type: I_Immutable_List

Gets an immutable list of the items in Deque.

Methods

Back

Returns: I_Deque

Get item at the back of the deque without removing it.

Inputs

Name	Type	Description
`Item`	`ANY`	Variable to store returned item value

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Clear

Returns: I_Deque

Empties/Clears/Deletes every item in the deque.

Dequeue_At_Back

Returns: I_Deque

Removes item at the front of the deque.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Dequeue_At_Front

Returns: I_Deque

Removes item at the front of the deque.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Enqueue_At_Back

Returns: I_Deque

Adds item at the back of the deque.

Inputs

Name	Type	Description
`Item`	`ANY`	Item to store.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Enqueue_At_Front

Returns: I_Deque

Add item to the front of the deque.

Inputs

Name	Type	Description
`Item`	`ANY`	Item to store.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Enqueue_Generic

Returns: I_Deque

Adds a generic item at the back of the deque.

Inputs

Name	Type	Description
`Item`	T_Generic	Item to store.
`bAt_Front`	`BOOL`	Enqueues at front if set to TRUE.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Front

Returns: I_Deque

Get item at the front of the deque without removing it.

Inputs

Name	Type	Description
`Item`	`ANY`	Variable to store returned item value

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Reverse

Returns: I_Deque

Reverses the order of items in the deque.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`