TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

class DequeBase in Tinman.Core.Collections

abstract class DequeBase with <T>  
  implements IDeque<T>
  extends VectorConstBase<T>
  base of ArrayDeque
  StatisticSamples

Public / Attributes

Count

The number of elements in this collection.

public abstract property Count { get }
type int32
value [>=0] The number of elements.
inherited BagConstBase.Count

Public / Methods

Add

Adds the given element to this collection.

public method Add (T element)
type bool
params element The element to add.
returns true if the collection has changed, false if not.
implements ICollector.Add

Remarks:

Implementing methods shall return false iff the element has already been collected, i.e. it is contained in the collection. If in doubt, return true.

Clear

Removes all elements from the queue.

public virtual method Clear ()
implements IDeque.Clear

Contains

Returns if this collection contains the given element.

[Pure]
public override method Contains (T element)
type bool
params element The element.
returns true if element is contained in this collection, false if not.
inherited VectorConstBase.Contains

ContainsAll

Returns if this collection contains all given elements.

public method ContainsAll (IEnumerable<T> elements)
type bool
params elements [not-null] The elements.
returns true if all elements are contained in this collection, false if not.
inherited BagConstBase.ContainsAll

Equals

Compares this object with the given one.

[Pure]
public method Equals (IVectorConst<T> other)
type bool
params other The object to compare to.
returns true if this object is equal to other, false if not.
inherited VectorConstBase.Equals

First

Returns the first enumerated value.

[Pure]
public override method First ()
type T
returns The first enumerated value.
inherited VectorConstBase.First

Exceptions:

GetAt

Returns the element at the given list index.

[Pure]
public abstract method GetAt (int32 index)
type T
params index [0..Count-1] The list index.
returns The element.
inherited VectorConstBase.GetAt

GetEnumerator

public override method GetEnumerator ()
type IEnumerator<T>
implements EnumerableBase.GetEnumerator

IndexOf

Returns the list index of the given element.

[Pure]
public abstract method IndexOf (T element)
type int32
params element The element.
returns The list index or -1 if the element is not contained in the list.
inherited VectorConstBase.IndexOf

Last

Returns the last enumerated value.

[Pure]
public override method Last ()
type T
returns The last enumerated value.
inherited VectorConstBase.Last

Exceptions:

PeekFirst

Returns the first element in the queue without removing it.

public abstract method PeekFirst ()
type T
returns The first element.
implements IDeque.PeekFirst

PeekLast

Returns the last element in the queue without removing it.

public abstract method PeekLast ()
type T
returns The last element.
implements IDeque.PeekLast

PopFirst

Returns the first element in the queue and removes it.

public abstract method PopFirst ()
type T
returns The first element.
implements IDeque.PopFirst

PopLast

Returns the last element in the queue and removes it.

public abstract method PopLast ()
type T
returns The last element.
implements IDeque.PopLast

PushFirst

Prepends the given element to the queue.

public abstract method PushFirst (T element)
params element The element.
implements IDeque.PushFirst

PushLast

Appends the given element to the queue.

public abstract method PushLast (T element)
params element The element.
implements IDeque.PushLast

ToArray

Returns the elements of this enumerable object as a fresh array.

[Pure]
public method ToArray ()
type T[]
returns [not-null] The array of elements.
inherited BagConstBase.ToArray

ToArrayCopy

Returns the elements of this collection as an array.

public override method ToArrayCopy (T[] array, int32 offset = 0)
type T[]
params array [not-null] The output array.
  offset [>=0] Offset into array. Defaults to 0.
returns [not-null] The filled array.
inherited VectorConstBase.ToArrayCopy

Remarks:

The elements in this collection will be copied into the given array, starting at the array index specified by offset.

ToArrayList

Returns the elements of this enumerable object as a list.

[Pure]
public virtual method ToArrayList ()
type IArrayVector<T>
returns [not-null] The list of elements.
inherited BagConstBase.ToArrayList

ToList

Returns the elements of this enumerable object as a list.

[Pure]
public override method ToList ()
type IVectorConst<T>
returns [not-null] The list of elements.
inherited VectorConstBase.ToList

Protected / Constructors

DequeBase

protected constructor DequeBase (EqualsDelegate<T> equals)
params equals

Protected / Methods

CompareElements

Compares the given collection elements.

protected virtual method CompareElements (T a, T b)
type int32
params a First collection element.
  b Second collection element.
returns [&lt;0] if a is less than b.
[=0] if a is equal to b.
[>0] if a is greater than b.
inherited BagConstBase.CompareElements

Remarks:

The default implementation invokes the CompareDelegate that has been specified for this collection.

EmptyEnumeration

protected method EmptyEnumeration (string source)
type FailedAssertionException
params source
inherited EnumerableBase.EmptyEnumeration

EqualsElements

Checks if the given collection elements are equal.

protected virtual method EqualsElements (T a, T b)
type bool
params a First collection element.
  b Second collection element.
returns true if the collection elements are equal, false if not.
inherited BagConstBase.EqualsElements

Remarks:

The default implementation invokes the EqualsDelegate that has been specified for this collection. If a CompareDelegate has been given instead, it will be invoked and its return value tested against 0.