class MapConstBase in Tinman.Core.Collections

abstract class	MapConstBase	with	<TKey>
			<TValue>
		extends	BagConstBase<MapEntry<TKey, TValue>>
		implements	IMapConst<TKey, TValue>
		base of	IdentityMap
			Map
			TreeMap

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

Keys

Returns a read-only set of all keys in this dictionary.

public abstract property	Keys { get }
type	IBagConst<TKey>
value	[not-null]	The set of keys.
implements	IMapConst.Keys

Values

Returns a read-only collection of all values in this dictionary.

public abstract property	Values { get }
type	IBagConst<TValue>
value	[not-null]	The collection of values.
implements	IMapConst.Values

Public / Methods

Contains

Returns if this collection contains the given element.

[Pure]
public override method	Contains (MapEntry<TKey, TValue> element)
type	bool
params	element		The element.
returns			true if element is contained in this collection, false if not.
implements	BagConstBase.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

ContainsKey

Returns if this map contains an entry for the given key.

public abstract method	ContainsKey (TKey key)
type	bool
params	key		The key.
returns			true if the map contains an entry for the key, false if it does not.
implements	IMapConst.ContainsKey

EqualsEntry

public method	EqualsEntry (MapEntry<TKey, TValue> a, MapEntry<TKey, TValue> b)
type	bool
params	a
	b

First

Returns the first enumerated value.

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

Exceptions:

• TinmanException:
  If the enumeration is empty.

Get

Returns the value that is currently mapped to the given key.

public abstract method	Get (TKey key, TValue defaultValue = default(TValue))
type	TValue
params	key		The key.
	defaultValue		The default value to return in case the map does not contain an entry for key.
returns			The entry value.
implements	IMapConst.Get

GetEnumerator

public abstract method	GetEnumerator ()
type	IEnumerator<T>
inherited	EnumerableBase.GetEnumerator

Last

Returns the last enumerated value.

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

Exceptions:

• TinmanException:
  If the enumeration is empty.

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 abstract 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	BagConstBase.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 virtual method	ToList ()
type	IVectorConst<T>
returns		[not-null]	The list of elements.
inherited	BagConstBase.ToList

Protected / Constructors

MapConstBase

protected constructor

MapConstBase ()

---

protected constructor	MapConstBase (CompareDelegate<TKey> compare)
params	compare

---

protected constructor	MapConstBase (EqualsDelegate<TKey> equals)
params	equals

Protected / Methods

CompareElements

Compares the given collection elements.

protected override method	CompareElements (MapEntry<TKey, TValue> a, MapEntry<TKey, TValue> 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.
overrides	BagConstBase.CompareElements

Remarks:

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

CompareKeys

Compares the given keys.

protected method	CompareKeys (TKey a, TKey b)
type	int32
params	a		First key.
	b		Second key.
returns		[<0]	if a is less than b. [=0] if a is equal to b. [>0] if a is greater than b.

Remarks:

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

EmptyEnumeration

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

EqualsElements

Checks if the given collection elements are equal.

protected override method	EqualsElements (MapEntry<TKey, TValue> a, MapEntry<TKey, TValue> b)
type	bool
params	a		First collection element.
	b		Second collection element.
returns			true if the collection elements are equal, false if not.
overrides	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.

EqualsKeys

Checks if the given keys are equal.

protected method	EqualsKeys (TKey a, TKey b)
type	bool
params	a		First key.
	b		Second key.
returns			true if the keys are equal, false if not.

Remarks:

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