Crystal.ICircularBuffer< T > Interface Template Reference

Circular buffer interface. More...

Inheritance diagram for Crystal.ICircularBuffer< T >:

Public Member Functions
T	Enqueue (T item)
	Enqueue the specified item. More...
T	Dequeue ()
	Dequeue this instance. More...
void	Clear ()
	Clears the buffer. More...
int	IndexOf (T item)
	Returns the index of the first item equal to the query (item) if such an item exists within the buffer, -1 otherwise. More...
void	RemoveAt (int index)
	Removes the element at the given index. More...

Properties
int	Count [get]
	Number of elements in the buffer. More...
int	Capacity [get, set]
	The maximum capacity of the buffer. More...
T	Head [get]
	Returns the value at the head of the buffer. More...
T	Tail [get]
	Returns the value at the tail of the buffer. More...
T	this[int index] [get, set]
	Gets or sets the T:Crystal.ICircularBuffer`1 at the specified index. More...

Detailed Description

Circular buffer interface.

Member Function Documentation

void Crystal.ICircularBuffer< T >.Clear

(

)

Clears the buffer.

Implemented in Crystal.CircularBuffer< T >.

T Crystal.ICircularBuffer< T >.Dequeue

(

)

Dequeue this instance.

Implemented in Crystal.CircularBuffer< T >.

T Crystal.ICircularBuffer< T >.Enqueue

(

T

item

)

Enqueue the specified item.

Implemented in Crystal.CircularBuffer< T >.

int Crystal.ICircularBuffer< T >.IndexOf

(

T

item

)

Returns the index of the first item equal to the query (item) if such an item exists within the buffer, -1 otherwise.

Implemented in Crystal.CircularBuffer< T >.

void Crystal.ICircularBuffer< T >.RemoveAt

(

int

index

)

Removes the element at the given index.

Parameters

index

Index.

Implemented in Crystal.CircularBuffer< T >.

Property Documentation

int Crystal.ICircularBuffer< T >.Capacity

getset

The maximum capacity of the buffer.

The capacity.

int Crystal.ICircularBuffer< T >.Count

get

Number of elements in the buffer.

The count.

T Crystal.ICircularBuffer< T >.Head

get

Returns the value at the head of the buffer.

The head.

T Crystal.ICircularBuffer< T >.Tail

get

Returns the value at the tail of the buffer.

The tail.

T Crystal.ICircularBuffer< T >.this[int index]

getset

Gets or sets the T:Crystal.ICircularBuffer`1 at the specified index.

Parameters

index

Index.

---

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

• Source/Collections/ICircularBuffer.cs