PBL - The program base library
C# AvlDictionary and Priority Queue implementation
 All Classes Namespaces Files Functions Properties
Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.ValueCollection Class Reference

Represents the collection of values in an AvlDictionary<TKey,TValue>. This class cannot be inherited. More...

Inheritance diagram for Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.ValueCollection:
Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue > Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >

Classes

class  CollectionEnumerator
 Enumerates the elements of an AvlDictionary<TKey,TValue>.ValueCollection. This class cannot be inherited. More...
 

Public Member Functions

void Add (TValue item)
 Because the ValueCollection is read only, this method always throws a System.NotSupportedException.
 
void Clear ()
 Because the ValueCollection is read only, this method always throws a System.NotSupportedException.
 
bool Contains (TValue item)
 Determines whether the AvlDictionary.ValueCollection contains a specific value.
 
void CopyTo (TValue[] array, int index)
 Copies the elements of the AvlDictionary.ValueCollection to an existing one-dimensional TValue[], starting at the specified array index.
 
bool Remove (TValue item)
 Because the ValueCollection is read only, this method always throws a System.NotSupportedException.
 
IEnumerator< TValue > GetEnumerator ()
 Returns an enumerator that iterates through the AvlDictionary.ValueCollection.
 
void CopyTo (Array array, int index)
 Copies the elements of the AvlDictionary.ValueCollection to an existing one-dimensional Array, starting at the specified array index.
 
- Public Member Functions inherited from Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >
 AvlDictionary ()
 Initializes a new instance of the AvlDictionary<TKey,TValue> class that is empty.
 
 AvlDictionary (IEnumerable< KeyValuePair< TKey, TValue >> dictionary)
 Initializes a new instance of the AvlDictionary<TKey,TValue> class that contains elements copied from the specified System.Collections.Generic.IDictionary<TKey,TValue>.
 
void Add (TKey key, TValue value)
 Adds the specified key and value to the AvlDictionary.
 
bool ContainsKey (TKey key)
 Determines whether the AvlDictionary contains the specified key.
 
bool Remove (TKey key)
 Removes the value with the specified key from the AvlDictionary.
 
bool TryGetValue (TKey key, out TValue value)
 Gets the value associated with the specified key.
 
void Add (KeyValuePair< TKey, TValue > item)
 Adds a KeyValuePair<TKey,TValue> to the AvlDictionary.
 
void Clear ()
 Removes all keys and values from the AvlDictionary.
 
bool Contains (KeyValuePair< TKey, TValue > item)
 Determines whether the AvlDictionary contains a specific KeyValuePair<TKey,TValue>.
 
void CopyTo (KeyValuePair< TKey, TValue >[] array, int index)
 Copies the elements of the AvlDictionary to an existing one-dimensional KeyValuePair<TKey,TValue>[], starting at the specified array index.
 
bool Remove (KeyValuePair< TKey, TValue > item)
 Removes the first occurrence of a specific KeyValuePair<TKey,TValue> from the AvlDictionary.
 
IEnumerator< KeyValuePair
< TKey, TValue > > 
GetEnumerator ()
 Returns an enumerator that iterates through the AvlDictionary.
 
void CopyTo (Array array, int index)
 Copies the elements of the elements of the AvlDictionary to an System.Array, starting at a particular System.Array index.
 

Properties

int Count [get]
 Gets the number of elements contained in the AvlDictionary.
 
bool IsReadOnly [get]
 Gets a value indicating whether the AvlDictionary.ValueCollection is read-only.
 
bool IsSynchronized [get]
 Gets a value indicating whether access to the AvlDictionary.ValueCollection is synchronized (thread safe).
 
object SyncRoot [get]
 Gets an object that can be used to synchronize access to the AvlDictionary.
 
- Properties inherited from Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >
ICollection< TKey > Keys [get]
 Gets a collection containing the keys in the AvlDictionary.
 
ICollection< TValue > Values [get]
 Gets a collection containing the values in the AvlDictionary.
 
TValue this[TKey key] [get, set]
 Gets or sets the value associated with the specified key.
 
int Count [get]
 Gets the number of elements contained in the AvlDictionary.
 
bool IsReadOnly [get]
 Gets a value indicating whether the AvlDictionary is read-only.
 
bool IsSynchronized [get]
 Gets a value indicating whether access to the AvlDictionary is synchronized (thread safe).
 
object SyncRoot [get]
 Gets an object that can be used to synchronize access to the AvlDictionary.
 

Detailed Description

Represents the collection of values in an AvlDictionary<TKey,TValue>. This class cannot be inherited.

Definition at line 1191 of file AvlDictionary.cs.

Member Function Documentation

void Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.ValueCollection.Add ( TValue  item)

Because the ValueCollection is read only, this method always throws a System.NotSupportedException.

Exceptions
System.NotSupportedExceptionThe AvlDictionary.ValueCollection is read-only.

Definition at line 1266 of file AvlDictionary.cs.

void Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.ValueCollection.Clear ( )

Because the ValueCollection is read only, this method always throws a System.NotSupportedException.

Exceptions
System.NotSupportedExceptionThe AvlDictionary.ValueCollection is read-only.

Definition at line 1278 of file AvlDictionary.cs.

bool Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.ValueCollection.Contains ( TValue  item)

Determines whether the AvlDictionary.ValueCollection contains a specific value.

Parameters
itemThe TValue to locate in the AvlDictionary.ValueCollection.

This method is an O(N) operation, where N is the number of elements in the AvlDictionary.ValueCollection.

Returns
true if item is found in the AvlDictionary.ValueCollection; otherwise, false.

Definition at line 1296 of file AvlDictionary.cs.

void Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.ValueCollection.CopyTo ( TValue[]  array,
int  index 
)

Copies the elements of the AvlDictionary.ValueCollection to an existing one-dimensional TValue[], starting at the specified array index.

Parameters
arrayThe one-dimensional TValue[] that is the destination of the elements copied from AvlDictionary.ValueCollection. The array must have zero-based indexing.
indexThe zero-based index in array at which copying begins.
Exceptions
System.ArgumentNullExceptionarray is null.
System.ArgumentOutOfRangeExceptionindex is less than zero.
System.ArgumentExceptionindex is equal to or greater than the length of array. -or- The number of elements in the source AvlDictionary.ValueCollection is greater than the available space from index to the end of the destination array.

Definition at line 1351 of file AvlDictionary.cs.

void Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.ValueCollection.CopyTo ( Array  array,
int  index 
)

Copies the elements of the AvlDictionary.ValueCollection to an existing one-dimensional Array, starting at the specified array index.

Parameters
arrayThe one-dimensional Array that is the destination of the elements copied from AvlDictionary.ValueCollection. The array must have zero-based indexing.
indexThe zero-based index in array at which copying begins.
Exceptions
System.ArgumentNullExceptionarray is null.
System.ArgumentOutOfRangeExceptionindex is less than zero.
System.ArgumentExceptionindex is equal to or greater than the length of array. -or- The number of elements in the source AvlDictionary.ValueCollection is greater than the available space from index to the end of the destination array.

Definition at line 1481 of file AvlDictionary.cs.

IEnumerator<TValue> Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.ValueCollection.GetEnumerator ( )

Returns an enumerator that iterates through the AvlDictionary.ValueCollection.

Returns
An IEnumerator<TValue> enumerator for the AvlDictionary.ValueCollection.

Definition at line 1431 of file AvlDictionary.cs.

bool Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.ValueCollection.Remove ( TValue  item)

Because the ValueCollection is read only, this method always throws a System.NotSupportedException.

Exceptions
System.NotSupportedExceptionThe AvlDictionary.ValueCollection is read-only.

Definition at line 1415 of file AvlDictionary.cs.

Property Documentation

int Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.ValueCollection.Count
get

Gets the number of elements contained in the AvlDictionary.

Returns
The number of elements contained in the AvlDictionary. Retrieving the value of this property is an O(1) operation.

Definition at line 1392 of file AvlDictionary.cs.

bool Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.ValueCollection.IsReadOnly
get

Gets a value indicating whether the AvlDictionary.ValueCollection is read-only.

Returns
true.

Definition at line 1404 of file AvlDictionary.cs.

bool Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.ValueCollection.IsSynchronized
get

Gets a value indicating whether access to the AvlDictionary.ValueCollection is synchronized (thread safe).

Returns
false.

Definition at line 1521 of file AvlDictionary.cs.

object Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.ValueCollection.SyncRoot
get

Gets an object that can be used to synchronize access to the AvlDictionary.

Returns
An object that can be used to synchronize access to the AvlDictionary.

Definition at line 1533 of file AvlDictionary.cs.


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