System::Collections::Generic::Dictionary< TKey, TValue > Class Template Reference

Forward declaration of Dictionary class. More...

#include "Artifact.h"

Inherits System::Collections::Generic::BaseDictionary< std::unordered_map< TKey, TValue, EqualityComparerHashAdapter< TKey >, EqualityComparerAdapter< TKey >, ASPOSE_MAP_ALLOCATOR_TYPE(TKey, TValue)> >.

Inherited by System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >.

Classes

class  Enumerator
 Enumerator that allows iterating through the dictionary. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...
 

Public Types

typedef ICollection< TKey > KeyCollection
 Collection of keys to extract. More...
 
typedef ICollection< TValue > ValueCollection
 Collection of values to extract. More...
 
typedef std::unordered_map< TKey, TValue, EqualityComparerHashAdapter< TKey >, EqualityComparerAdapter< TKey >, ASPOSE_MAP_ALLOCATOR_TYPE(TKey, TValue)> map_t
 Underlying data type. More...
 
typedef SharedPtr< Dictionary< TKey, TValue > > Ptr
 Pointer type. More...
 
typedef KeyValuePair< TKey, TValue > KVPair
 Key-value pair type. More...
 
typedef SharedPtr< IEnumerable< KVPair > > IEnumerablePtr
 Pointer to enumerable interface. More...
 
typedef SharedPtr< IEnumerator< KVPair > > IEnumeratorPtr
 Pointer to enumerator. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

 Dictionary ()
 Creates empty dictionary. More...
 
 Dictionary (const map_t &map)
 Copies data from map. More...
 
 Dictionary (int capacity)
 Overload which corresponds to creating pre-allocated dictionary; does no allocation, actually. More...
 
 Dictionary (const SharedPtr< IDictionary< TKey, TValue > > &src)
 Copy constructor. More...
 
 Dictionary (const SharedPtr< IDictionary< TKey, TValue > > &src, const SharedPtr< IEqualityComparer< TKey > > &comparer)
 Copy constructor. More...
 
 Dictionary (const SharedPtr< IEqualityComparer< TKey > > &comparer)
 Creates empty dictionary. More...
 
 Dictionary (int capacity, const SharedPtr< IEqualityComparer< TKey > > &comparer)
 Creates empty dictionary. More...
 
virtual IEnumeratorPtr GetEnumerator () override
 Creates enumerator object. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

 ~Dictionary () override
 Destructor. More...
 
SharedPtr< KeyCollectionget_KeysInternal () const override
 Implementation of internal keys collection accessor. More...
 
SharedPtr< ValueCollectionget_ValuesInternal () const override
 Implementation of internal value collection accessor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

template<typename TKey, typename TValue>
class System::Collections::Generic::Dictionary< TKey, TValue >

Forward declaration of Dictionary class.

Dictionary that maps values to keys. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

#include <system/collections/dictionary.h>
#include <system/smart_ptr.h>
using namespace System;
int main()
{
// Create the Dictionary-class instance.
auto dictionary = MakeObject<Dictionary<int, String>>();
// Fill the dictionary.
dictionary->Add(0, u"Foo");
dictionary->Add(1, u"Bar");
dictionary->Add(2, u"Baz");
// Print the dictionary items.
for (const auto &pair: dictionary)
{
std::cout << pair.get_Key() << " - " << pair.get_Value() << std::endl;
}
return 0;
}
/*
This code example produces the following output:
0 - Foo
1 - Bar
2 - Baz
*/
Template Parameters
TKeyKey type.
TValueValue type.

Member Typedef Documentation

◆ IEnumerablePtr

template<typename TKey, typename TValue>
typedef SharedPtr< IEnumerable<KVPair> > System::Collections::Generic::Dictionary< TKey, TValue >::IEnumerablePtr

Pointer to enumerable interface.

◆ IEnumeratorPtr

template<typename TKey, typename TValue>
typedef SharedPtr< IEnumerator<KVPair> > System::Collections::Generic::Dictionary< TKey, TValue >::IEnumeratorPtr

Pointer to enumerator.

◆ KeyCollection

template<typename TKey, typename TValue>
typedef ICollection<TKey> System::Collections::Generic::Dictionary< TKey, TValue >::KeyCollection

Collection of keys to extract.

◆ KVPair

template<typename TKey, typename TValue>
typedef KeyValuePair<TKey, TValue> System::Collections::Generic::Dictionary< TKey, TValue >::KVPair

Key-value pair type.

◆ map_t

template<typename TKey, typename TValue>
typedef std::unordered_map<TKey, TValue, EqualityComparerHashAdapter<TKey>, EqualityComparerAdapter<TKey>, ASPOSE_MAP_ALLOCATOR_TYPE(TKey, TValue)> System::Collections::Generic::Dictionary< TKey, TValue >::map_t

Underlying data type.

◆ Ptr

template<typename TKey, typename TValue>
typedef SharedPtr< Dictionary<TKey, TValue> > System::Collections::Generic::Dictionary< TKey, TValue >::Ptr

Pointer type.

◆ ValueCollection

template<typename TKey, typename TValue>
typedef ICollection<TValue> System::Collections::Generic::Dictionary< TKey, TValue >::ValueCollection

Collection of values to extract.

Constructor & Destructor Documentation

◆ Dictionary() [1/7]

template<typename TKey, typename TValue>
System::Collections::Generic::Dictionary< TKey, TValue >::Dictionary ( )
inline

Creates empty dictionary.

◆ Dictionary() [2/7]

template<typename TKey, typename TValue>
System::Collections::Generic::Dictionary< TKey, TValue >::Dictionary ( const map_t map)
inline

Copies data from map.

Parameters
mapMap to copy data from.

◆ Dictionary() [3/7]

template<typename TKey, typename TValue>
System::Collections::Generic::Dictionary< TKey, TValue >::Dictionary ( int  capacity)
inline

Overload which corresponds to creating pre-allocated dictionary; does no allocation, actually.

Parameters
capacityCapacity to allocate; ignored.

◆ Dictionary() [4/7]

template<typename TKey, typename TValue>
System::Collections::Generic::Dictionary< TKey, TValue >::Dictionary ( const SharedPtr< IDictionary< TKey, TValue > > &  src)
inline

Copy constructor.

Parameters
srcDictionary to copy data from.

◆ Dictionary() [5/7]

template<typename TKey, typename TValue>
System::Collections::Generic::Dictionary< TKey, TValue >::Dictionary ( const SharedPtr< IDictionary< TKey, TValue > > &  src,
const SharedPtr< IEqualityComparer< TKey > > &  comparer 
)
inline

Copy constructor.

Parameters
srcSource dictionary.
comparerComparer object to use.

◆ Dictionary() [6/7]

template<typename TKey, typename TValue>
System::Collections::Generic::Dictionary< TKey, TValue >::Dictionary ( const SharedPtr< IEqualityComparer< TKey > > &  comparer)
inline

Creates empty dictionary.

Parameters
comparerComparer to use.

◆ Dictionary() [7/7]

template<typename TKey, typename TValue>
System::Collections::Generic::Dictionary< TKey, TValue >::Dictionary ( int  capacity,
const SharedPtr< IEqualityComparer< TKey > > &  comparer 
)
inline

Creates empty dictionary.

Parameters
capacityDictionary capacity after creation; ignored.
comparerComparer to use.

◆ ~Dictionary()

template<typename TKey, typename TValue>
System::Collections::Generic::Dictionary< TKey, TValue >::~Dictionary ( )
inlineoverrideprotected

Destructor.

Member Function Documentation

◆ get_KeysInternal()

◆ get_ValuesInternal()

◆ GetEnumerator()

template<typename TKey, typename TValue>
virtual IEnumeratorPtr System::Collections::Generic::Dictionary< TKey, TValue >::GetEnumerator ( )
inlineoverridevirtual