interface IMap in Tinman.Core.Collections

Base interface for classes that represent a set of key/value pairs.

interface	IMap	with	<TKey>
			<TValue>
		extends	IMapConst<TKey, TValue>
		base of	IdentityMap
			ISortedMap
			Map

Attributes

Count

The number of elements in this collection.

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

Keys

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

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

Values

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

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

Methods

Clear

Removes all key/value pairs from the map.

method

Clear ()

Contains

Returns if this collection contains the given element.

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

ContainsAll

Returns if this collection contains all given elements.

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	IBagConst.ContainsAll

ContainsKey

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

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.
inherited	IMapConst.ContainsKey

First

Returns the first enumerated value.

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

Exceptions:

• TinmanException:
  If the enumeration is empty.

Get

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

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.
inherited	IMapConst.Get

GetEnumerator

method	GetEnumerator ()
type	IEnumerator<T>
inherited	IEnumerable.GetEnumerator

Last

Returns the last enumerated value.

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

Exceptions:

• TinmanException:
  If the enumeration is empty.

Put

Maps the given value to the specified key.

method	Put (TKey key, TValue value)
type	TValue
params	key		The key.
	value		The value.
returns			The previously mapped value.

Remove

Removes the mapping for the given key.

method	Remove (TKey key)
type	TValue
params	key		The key.
returns			The previously mapped value.

ToArray

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

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

ToArrayCopy

Returns the elements of this collection as an array.

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	IBagConst.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]
method	ToArrayList ()
type	IArrayVector<T>
returns		[not-null]	The list of elements.
inherited	IBagConst.ToArrayList

ToList

Returns the elements of this enumerable object as a list.

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