Header menu logo B2R2

RandomAccessQueue Module

Provides functions for creating or manipulating random access queues.

Functions and values

Function or value Description

RandomAccessQueue.concat arg1 arg2

Full Usage: RandomAccessQueue.concat arg1 arg2

Parameters:
Returns: RandomAccessQueue<'a>
Type parameters: 'a

Concatenates two queues.

arg0 : RandomAccessQueue<'a>
arg1 : RandomAccessQueue<'a>
Returns: RandomAccessQueue<'a>

RandomAccessQueue.dequeue q

Full Usage: RandomAccessQueue.dequeue q

Parameters:
Returns: 'a * RandomAccessQueue<'a>
Type parameters: 'a

Dequeues the oldest element from the queue.

q : RandomAccessQueue<'a>
Returns: 'a * RandomAccessQueue<'a>

RandomAccessQueue.empty

Full Usage: RandomAccessQueue.empty

Returns: RandomAccessQueue<'a>
Type parameters: 'a

Returns an empty random access queue.

Returns: RandomAccessQueue<'a>

RandomAccessQueue.enqueue v arg2

Full Usage: RandomAccessQueue.enqueue v arg2

Parameters:
Returns: RandomAccessQueue<'a>
Type parameters: 'a

Enqueues an element to the queue.

v : 'a
arg1 : RandomAccessQueue<'a>
Returns: RandomAccessQueue<'a>

RandomAccessQueue.getAt i q

Full Usage: RandomAccessQueue.getAt i q

Parameters:
Returns: 'a
Type parameters: 'a

Returns the element at the given index. Raises IndexOutOfRangeException if the index is out of range.

i : int
q : RandomAccessQueue<'a>
Returns: 'a

RandomAccessQueue.head q

Full Usage: RandomAccessQueue.head q

Parameters:
Returns: 'a
Type parameters: 'a

Returns the first element of the queue. Raises EmptyRandomAccessQueueException if the queue is empty.

q : RandomAccessQueue<'a>
Returns: 'a

RandomAccessQueue.headr q

Full Usage: RandomAccessQueue.headr q

Parameters:
Returns: 'a
Type parameters: 'a

Returns the last element of the queue. Raises EmptyRandomAccessQueueException if the queue is empty.

q : RandomAccessQueue<'a>
Returns: 'a

RandomAccessQueue.insertAt i v q

Full Usage: RandomAccessQueue.insertAt i v q

Parameters:
Returns: RandomAccessQueue<'a>
Type parameters: 'a

Inserts an element at the given index. If the index is less than or equal to zero, the element is inserted at the front. If the index is greater than or equal to the queue length, the element is appended at the end.

i : int
v : 'a
q : RandomAccessQueue<'a>
Returns: RandomAccessQueue<'a>

RandomAccessQueue.isEmpty q

Full Usage: RandomAccessQueue.isEmpty q

Parameters:
Returns: bool
Type parameters: 'a

Checks if the given queue is empty.

q : RandomAccessQueue<'a>
Returns: bool

RandomAccessQueue.length arg1

Full Usage: RandomAccessQueue.length arg1

Parameters:
Returns: int
Type parameters: 'a

Returns the length of the queue.

arg0 : RandomAccessQueue<'a>
Returns: int

RandomAccessQueue.splitAt i queue

Full Usage: RandomAccessQueue.splitAt i queue

Parameters:
Returns: RandomAccessQueue<'a> * RandomAccessQueue<'a>
Type parameters: 'a

Splits the queue based on the given index into two (left and right). The left queue contains the first i elements. If i is less than or equal to zero, the left queue is empty. If i is greater than or equal to the queue length, the right queue is empty.

i : int
queue : RandomAccessQueue<'a>
Returns: RandomAccessQueue<'a> * RandomAccessQueue<'a>

RandomAccessQueue.tail q

Full Usage: RandomAccessQueue.tail q

Parameters:
Returns: RandomAccessQueue<'a>
Type parameters: 'a

Returns the queue without its first element. Raises EmptyRandomAccessQueueException if the queue is empty.

q : RandomAccessQueue<'a>
Returns: RandomAccessQueue<'a>

RandomAccessQueue.tailr q

Full Usage: RandomAccessQueue.tailr q

Parameters:
Returns: RandomAccessQueue<'a>
Type parameters: 'a

Returns the queue without its last element. Raises EmptyRandomAccessQueueException if the queue is empty.

q : RandomAccessQueue<'a>
Returns: RandomAccessQueue<'a>

RandomAccessQueue.toList arg1

Full Usage: RandomAccessQueue.toList arg1

Parameters:
Returns: 'a list
Type parameters: 'a

Converts the queue to a list.

arg0 : RandomAccessQueue<'a>
Returns: 'a list

RandomAccessQueue.tryFindIndex pred arg2

Full Usage: RandomAccessQueue.tryFindIndex pred arg2

Parameters:
Returns: int option
Type parameters: 'a

Finds the index of the first element that satisfies the given predicate.

pred : 'a -> bool
arg1 : RandomAccessQueue<'a>
Returns: int option

RandomAccessQueue.tryFindIndexBack pred arg2

Full Usage: RandomAccessQueue.tryFindIndexBack pred arg2

Parameters:
Returns: int option
Type parameters: 'a

Finds the index of the last element that satisfies the given predicate.

pred : 'a -> bool
arg1 : RandomAccessQueue<'a>
Returns: int option

RandomAccessQueue.tryGetAt i q

Full Usage: RandomAccessQueue.tryGetAt i q

Parameters:
Returns: 'a option
Type parameters: 'a

Returns the element at the given index, or None if the index is out of range.

i : int
q : RandomAccessQueue<'a>
Returns: 'a option

Type something to start searching.