NavigableDictionary<TKey, TValue>.ValueCollection Class

Definition

Namespace

Bodu.Collections.Generic

Assembly

Bodu.Collections.dll

Package

Bodu.Collections 1.0.0

Source

NavigableDictionary{T,T}.EntryKeyComparer.cs

Represents a live view of the values contained in a NavigableDictionary<TKey, TValue>, ordered by ascending key.

public sealed class NavigableDictionary<TKey, TValue>.ValueCollection : ICollection<TValue>, IReadOnlyCollection<TValue>, IEnumerable<TValue>, IEnumerable

Inheritance

object

NavigableDictionary<TKey, TValue>.ValueCollection

Implements

ICollection<TValue>

IReadOnlyCollection<TValue>

IEnumerable<TValue>

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ComparableExtensions.AtLeast<T>(T, T, IComparer<T>)

ComparableExtensions.AtMost<T>(T, T, IComparer<T>)

ComparableExtensions.IsEqualTo<T>(T, T, IComparer<T>)

ComparableExtensions.Max<T>(T, T, IComparer<T>)

ComparableExtensions.Min<T>(T, T, IComparer<T>)

Remarks

The collection reflects subsequent mutations to the underlying dictionary. Enumeration follows ascending key order and is fail-fast against structural mutation. The collection is read-only; Add(T), Clear(), and Remove(T) throw NotSupportedException.

Properties

Count

Gets the number of elements contained in the ICollection<T>.

public int Count { get; }

Property Value

int

The number of elements contained in the ICollection<T>.

Methods

Contains(TValue)

Determines whether the ICollection<T> contains a specific value.

public bool Contains(TValue item)

Parameters

item TValue

The object to locate in the ICollection<T>.

Returns

bool

true if item is found in the ICollection<T>; otherwise, false.

Remarks

Performs a linear O(n) walk, matching ContainsValue(TValue) - values are not indexed.

CopyTo(TValue[], int)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

public void CopyTo(TValue[] array, int arrayIndex)

Parameters

array TValue[]

The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.

arrayIndex int

The zero-based index in array at which copying begins.

Exceptions

ArgumentNullException

array is null.

ArgumentOutOfRangeException

arrayIndex is less than 0.

ArgumentException

The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array.

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<TValue> GetEnumerator()

Returns

IEnumerator<TValue>

An enumerator that can be used to iterate through the collection.

Explicit Interface Implementations

ICollection<TValue>.Add(TValue)

Adds an item to the ICollection<T>.

void ICollection<TValue>.Add(TValue item)

Parameters

item TValue

The object to add to the ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

NotSupportedException

Values cannot be added directly; modify the owning dictionary instead.

ICollection<TValue>.Clear()

Removes all items from the ICollection<T>.

void ICollection<TValue>.Clear()

Exceptions

NotSupportedException

The ICollection<T> is read-only.

NotSupportedException

Values cannot be cleared directly; call Clear() instead.

ICollection<TValue>.IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

bool ICollection<TValue>.IsReadOnly { get; }

Returns

bool

true if the ICollection<T> is read-only; otherwise, false.

ICollection<TValue>.Remove(TValue)

Removes the first occurrence of a specific object from the ICollection<T>.

bool ICollection<TValue>.Remove(TValue item)

Parameters

item TValue

The object to remove from the ICollection<T>.

Returns

bool

true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

NotSupportedException

Values cannot be removed directly; remove the owning entry via Remove(TKey) instead.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerator IEnumerable.GetEnumerator()

Returns

IEnumerator

An IEnumerator object that can be used to iterate through the collection.

Applies to

Product	Versions
.NET	8, 10