interface IBijectiveMapConst in Tinman.Core.Collections

Base interface for classes that represent a read-only bidirectional aka. bijective mapping between left and right value pairs.

interface	IBijectiveMapConst	with	<TLeft>
			<TRight>
		base of	IBijectiveMap

Attributes

Count

The number of key/value pairs in the map.

property	Count { get }
type	int32
value	[>=0]	The number of map entries.

Entries

Returns a read-only set of all key/value pairs in this dictionary.

property	Entries { get }
type	IBagConst<MapEntry<TLeft, TRight>>
value	[not-null]	The set of key/value pairs.

KeysLeft

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

property	KeysLeft { get }
type	IBagConst<TLeft>
value	[not-null]	The set of keys.

KeysRight

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

property	KeysRight { get }
type	IBagConst<TRight>
value	[not-null]	The collection of values.

Methods

ContainsLeft

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

method	ContainsLeft (TLeft left)
type	bool
params	left		The key.
returns			true if the map contains an entry for the key, false if it does not.

ContainsRight

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

method	ContainsRight (TRight right)
type	bool
params	right		The key.
returns			true if the map contains an entry for the key, false if it does not.

GetLeft

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

method	GetLeft (TLeft left, TRight defaultValue = default(TRight))
type	TRight
params	left		The key.
	defaultValue		The default value to return in case the map does not contain an entry for left.
returns			The entry value.

GetRight

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

method	GetRight (TRight right, TLeft defaultValue = default(TLeft))
type	TLeft
params	right		The key.
	defaultValue		The default value to return in case the map does not contain an entry for right.
returns			The entry value.