Lean  $LEAN_TAG$
QuantConnect.Util.FixedSizeHashQueue< T > Class Template Reference

Provides an implementation of an add-only fixed length, unique queue system More...

Inheritance diagram for QuantConnect.Util.FixedSizeHashQueue< T >:
[legend]

Public Member Functions

 FixedSizeHashQueue (int size)
 Initializes a new instance of the FixedSizeHashQueue<T> class More...
 
bool Add (T item)
 Returns true if the item was added and didn't already exists More...
 
bool TryPeek (out T item)
 Tries to inspect the first item in the queue More...
 
Dequeue ()
 Dequeues and returns the next item in the queue More...
 
bool Contains (T item)
 Returns true if the specified item exists in the collection More...
 
IEnumerator< T > GetEnumerator ()
 Returns an enumerator that iterates through the collection. More...
 

Detailed Description

Provides an implementation of an add-only fixed length, unique queue system

Definition at line 25 of file FixedSizeHashQueue.cs.

Constructor & Destructor Documentation

◆ FixedSizeHashQueue()

Initializes a new instance of the FixedSizeHashQueue<T> class

Parameters
sizeThe maximum number of items to hold

Definition at line 35 of file FixedSizeHashQueue.cs.

Member Function Documentation

◆ Add()

bool QuantConnect.Util.FixedSizeHashQueue< T >.Add ( item)

Returns true if the item was added and didn't already exists

Definition at line 45 of file FixedSizeHashQueue.cs.

◆ TryPeek()

bool QuantConnect.Util.FixedSizeHashQueue< T >.TryPeek ( out T  item)

Tries to inspect the first item in the queue

Definition at line 63 of file FixedSizeHashQueue.cs.

◆ Dequeue()

Dequeues and returns the next item in the queue

Definition at line 71 of file FixedSizeHashQueue.cs.

◆ Contains()

bool QuantConnect.Util.FixedSizeHashQueue< T >.Contains ( item)

Returns true if the specified item exists in the collection

Definition at line 81 of file FixedSizeHashQueue.cs.

◆ GetEnumerator()

IEnumerator<T> QuantConnect.Util.FixedSizeHashQueue< T >.GetEnumerator ( )

Returns an enumerator that iterates through the collection.

Returns
A T:System.Collections.Generic.IEnumerator`1 that can be used to iterate through the collection.

<filterpriority>1</filterpriority>

Definition at line 93 of file FixedSizeHashQueue.cs.


The documentation for this class was generated from the following file: