pluginbase.Helpers.Collections.BiDictionary< T, Q > Class Template Reference

A specialized dictionary that allows either side to be accessed as if it were the key More...

Inheritance diagram for pluginbase.Helpers.Collections.BiDictionary< T, Q >:

Public Member Functions
	BiDictionary ()
	Initialize the class More...
	BiDictionary (IDictionary< T, Q > src)
	Initialize the class given an existing dictionary More...
Dictionary< T, Q >	ToDict ()
	Convert the BiDictionary into a Dictionary More...
IEnumerator< KeyValuePair< T, Q > >	GetEnumerator ()
	Gets the enumerator. More...
void	Add (KeyValuePair< T, Q > item)
	Add the specified item. More...
void	Clear ()
	Clear this instance. More...
bool	Contains (KeyValuePair< T, Q > item)
	Contains the specified item. More...
void	CopyTo (KeyValuePair< T, Q >[] array, int arrayIndex)
	Copies to a target array More...
bool	Remove (KeyValuePair< T, Q > item)
	Remove the specified item. More...
void	Add (T key, Q value)
	Add the specified key and value. More...
bool	ContainsKey (T key)
	Containses the key. More...
bool	ContainsValue (Q value)
	Checks if dictionary contains a given value More...
bool	Remove (T key)
	Remove the specified key. More...
bool	Remove (Q value)
	Remove the specified value. More...
bool	TryGetValue (T key, out Q value)
	Try to get a value by a given key More...

Properties
int	Count [get]
	Gets the count. More...
bool	IsReadOnly [get]
	Gets a value indicating whether this instance is read only. More...

Detailed Description

A specialized dictionary that allows either side to be accessed as if it were the key

Constructor & Destructor Documentation

BiDictionary() [1/2]

pluginbase.Helpers.Collections.BiDictionary< T, Q >.BiDictionary

(

)

Initialize the class

        {
        }

BiDictionary() [2/2]

pluginbase.Helpers.Collections.BiDictionary< T, Q >.BiDictionary

(

IDictionary< T, Q >

src

)

Initialize the class given an existing dictionary

Parameters

src

Source.

        {
            foreach(var kv in src)
            {
                Add(kv);
            }
        }

Member Function Documentation

Add() [1/2]

void pluginbase.Helpers.Collections.BiDictionary< T, Q >.Add

(

KeyValuePair< T, Q >

item

)

Add the specified item.

<Docs>The item to add to the current collection.</Docs>

Adds an item to the current collection.

To be added.

Exceptions

System.NotSupportedException

The current collection is read-only.

Parameters

item

Item.

Attribute: item.Key

= item.Value;

Attribute: item.Value

= item.Key;

        {
            _forward[item.Key] = item.Value;
            _reverse[item.Value] = item.Key;
        }

Add() [2/2]

void pluginbase.Helpers.Collections.BiDictionary< T, Q >.Add	(	T	key,
		Q	value
	)

Add the specified key and value.

Parameters

key	Key.
value	Value.

Attribute: key

= value;

Attribute: value

= key;

        {
            if (_forward.ContainsKey(key) || _reverse.ContainsKey(value))
            {
                throw new ArgumentException("Pair key conflict");
            }
            _forward[key] = value;
            _reverse[value] = key;
        }

Clear()

void pluginbase.Helpers.Collections.BiDictionary< T, Q >.Clear

(

)

Clear this instance.

        {
            _forward.Clear();
            _reverse.Clear();
        }

Contains()

bool pluginbase.Helpers.Collections.BiDictionary< T, Q >.Contains

(

KeyValuePair< T, Q >

item

)

Contains the specified item.

<Docs>The object to locate in the current collection.</Docs>

Determines whether the current collection contains a specific value.

Parameters

item

Item.

        {
            Q ele;
            if (_forward.TryGetValue(item.Key, out ele))
            {
                return ele.Equals(item.Value);
            }
            return false;
        }

ContainsKey()

bool pluginbase.Helpers.Collections.BiDictionary< T, Q >.ContainsKey

(

T

key

)

Containses the key.

<Docs>The key to locate in the current instance.</Docs>

Determines whether the current instance contains an entry with the specified key.

Returns

true, if key was containsed, false otherwise.

Parameters

key

Key.

        {
            return _forward.ContainsKey(key);
        }

ContainsValue()

bool pluginbase.Helpers.Collections.BiDictionary< T, Q >.ContainsValue

(

Q

value

)

Checks if dictionary contains a given value

Returns

true, if value was containsed, false otherwise.

Parameters

value

Value.

        {
            return _reverse.ContainsKey(value);
        }

CopyTo()

void pluginbase.Helpers.Collections.BiDictionary< T, Q >.CopyTo	(	KeyValuePair< T, Q > []	array,
		int	arrayIndex
	)

Copies to a target array

Parameters

array	Array.
arrayIndex	Array index.

Attribute: i+arrayIndex

= item;

        {
            int i=0;
            foreach(var item in _forward)
            {
                array[i+arrayIndex] = item;
                ++i;
            }
        }

GetEnumerator()

IEnumerator<KeyValuePair<T, Q> > pluginbase.Helpers.Collections.BiDictionary< T, Q >.GetEnumerator

(

)

Gets the enumerator.

Returns

The enumerator.

        {
            return _forward.GetEnumerator();
        }

Remove() [1/3]

bool pluginbase.Helpers.Collections.BiDictionary< T, Q >.Remove

(

KeyValuePair< T, Q >

item

)

Remove the specified item.

<Docs>The item to remove from the current collection.</Docs>

Removes the first occurrence of an item from the current collection.

Parameters

item

Item.

        {
            return _reverse.Remove(item.Value) && _forward.Remove(item.Key);
        }

Remove() [2/3]

bool pluginbase.Helpers.Collections.BiDictionary< T, Q >.Remove

(

T

key

)

Remove the specified key.

<Docs>The item to remove from the current collection.</Docs>

Removes the first occurrence of an item from the current collection.

Parameters

key

Key.

        {
            Q val;
            if (_forward.TryGetValue(key, out val))
            {
                _reverse.Remove(val);
                return _forward.Remove(key);;
            }
            return false;
        }

Remove() [3/3]

bool pluginbase.Helpers.Collections.BiDictionary< T, Q >.Remove

(

Q

value

)

Remove the specified value.

<Docs>The item to remove from the current collection.</Docs>

Removes the first occurrence of an item from the current collection.

Parameters

value

Value.

        {
            T key;
            if (_reverse.TryGetValue(value, out key))
            {
                _forward.Remove(key);
                return _reverse.Remove(value);
            }
            return false;
        }

ToDict()

Dictionary<T,Q> pluginbase.Helpers.Collections.BiDictionary< T, Q >.ToDict

(

)

Convert the BiDictionary into a Dictionary

Returns

The dict.

        {
            return new Dictionary<T, Q>(_forward);
        }

TryGetValue()

bool pluginbase.Helpers.Collections.BiDictionary< T, Q >.TryGetValue	(	T	key,
		out Q	value
	)

Try to get a value by a given key

To be added.

Returns

true, if get value was tryed, false otherwise.

Parameters

key	Key.
value	Value.

        {
            return _forward.TryGetValue(key, out value);
        }

Property Documentation

Count

int pluginbase.Helpers.Collections.BiDictionary< T, Q >.Count

get

Gets the count.

The count.

IsReadOnly

bool pluginbase.Helpers.Collections.BiDictionary< T, Q >.IsReadOnly

get

Gets a value indicating whether this instance is read only.

true if this instance is read only; otherwise, false.

---

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

• pluginbase/Helpers/Collections/BiDictionary.cs