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

Sorted dictionary type forward declaration. More...

Inherits System::Collections::Generic::BaseDictionary< std::map< TKey, TValue, ComparerAdapter< BasePointerType< TKey >::type >, ASPOSE_MAP_ALLOCATOR_TYPE(TKey, TValue)> >.

Classes

class  Enumerator
 Enumerator type to iterate through 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
 Key collection type. More...
 
typedef ICollection< TValue > ValueCollection
 Value collection type. More...
 
typedef std::map< TKey, TValue, ComparerAdapter< typename BasePointerType< TKey >::type >, ASPOSE_MAP_ALLOCATOR_TYPE(TKey, TValue)> map_t
 Underlying data type. More...
 
typedef SortedDictionary< TKey, TValue > this_t
 Self type. More...
 
typedef SharedPtr< this_tPtr
 Pointer type. More...
 
typedef KeyValuePair< TKey, TValue > KVPair
 Key-value pair type. More...
 
typedef SharedPtr< IEnumerable< KVPair > > IEnumerablePtr
 Collection of same elements. More...
 
typedef SharedPtr< IEnumerator< KVPair > > IEnumeratorPtr
 Enumerator type. More...
 
typedef _BaseType::iterator iterator
 Iterator type. More...
 
typedef _BaseType::const_iterator const_iterator
 Const iterator type. More...
 
typedef map_t::reverse_iterator reverse_iterator
 Reverse iterator type. More...
 
typedef map_t::const_reverse_iterator const_reverse_iterator
 Const reverse iterator type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

 SortedDictionary ()
 Constructs empty dictionary. More...
 
 SortedDictionary (const SharedPtr< IComparer< typename BasePointerType< TKey >::type > > &comparer)
 Constructs empty dictionary. More...
 
 SortedDictionary (const SharedPtr< IDictionary< TKey, TValue >> &src)
 Copy constructor. More...
 
 SortedDictionary (const SharedPtr< IDictionary< TKey, TValue >> &src, const SharedPtr< IComparer< typename BasePointerType< TKey >::type >> &comparer)
 Copy constructor. More...
 
SharedPtr< System::Collections::Generic::IComparer< TKey > > get_Comparer () const
 Gets the IComparer<TKey> used to order the elements of the SortedDictionary<TKey,TValue>. More...
 
IEnumeratorPtr GetEnumerator () override
 Gets enumerator to iterate through current dictionary. More...
 
reverse_iterator rbegin () noexcept
 Gets a reverse iterator to the last element of collection (first in reverse). More...
 
reverse_iterator rend () noexcept
 Gets a reverse iterator for a non-existent element before the start of the collection. More...
 
const_reverse_iterator rbegin () const noexcept
 Gets a reverse iterator to the last element of the const-qualified collection (first in reverse). More...
 
const_reverse_iterator rend () const noexcept
 Gets a reverse iterator for a non-existent element before the start of the const-qualified collection. More...
 
const_reverse_iterator crbegin () const noexcept
 Gets a reverse iterator to the last const-qualified element of collection (first in reverse). More...
 
const_reverse_iterator crend () const noexcept
 Gets a reverse iterator for a non-existent const-qualified element before the start of the collection. 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...
 

Static Public Member Functions

static SharedPtr< IComparer< typename BasePointerType< TKey >::type > > GetDefaultKeyComparer ()
 Singleton accessor function. More...
 
- 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...
 

Protected Member Functions

 ~SortedDictionary () override
 Destructor. More...
 
SharedPtr< KeyCollectionget_KeysInternal () const override
 Implementation of get_KeysInternal() method. More...
 
SharedPtr< ValueCollectionget_ValuesInternal () const override
 Implementation of get_ValuesInternal() method. More...
 

Detailed Description

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

Sorted dictionary type forward declaration.

Sorted dictionary class wrapping STL map. 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.

Template Parameters
TKeyKey type.
TValueValue type.

Member Typedef Documentation

◆ const_iterator

template<typename TKey , typename TValue >
typedef _BaseType::const_iterator System::Collections::Generic::SortedDictionary< TKey, TValue >::const_iterator

Const iterator type.

◆ const_reverse_iterator

template<typename TKey , typename TValue >
typedef map_t::const_reverse_iterator System::Collections::Generic::SortedDictionary< TKey, TValue >::const_reverse_iterator

Const reverse iterator type.

◆ IEnumerablePtr

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

Collection of same elements.

◆ IEnumeratorPtr

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

Enumerator type.

◆ iterator

template<typename TKey , typename TValue >
typedef _BaseType::iterator System::Collections::Generic::SortedDictionary< TKey, TValue >::iterator

Iterator type.

◆ KeyCollection

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

Key collection type.

◆ KVPair

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

Key-value pair type.

◆ map_t

template<typename TKey , typename TValue >
typedef std::map<TKey, TValue, ComparerAdapter<typename BasePointerType<TKey>::type>, ASPOSE_MAP_ALLOCATOR_TYPE(TKey, TValue)> System::Collections::Generic::SortedDictionary< TKey, TValue >::map_t

Underlying data type.

◆ Ptr

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

Pointer type.

◆ reverse_iterator

template<typename TKey , typename TValue >
typedef map_t::reverse_iterator System::Collections::Generic::SortedDictionary< TKey, TValue >::reverse_iterator

Reverse iterator type.

◆ this_t

template<typename TKey , typename TValue >
typedef SortedDictionary<TKey, TValue> System::Collections::Generic::SortedDictionary< TKey, TValue >::this_t

Self type.

◆ ValueCollection

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

Value collection type.

Constructor & Destructor Documentation

◆ SortedDictionary() [1/4]

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

Constructs empty dictionary.

◆ SortedDictionary() [2/4]

template<typename TKey , typename TValue >
System::Collections::Generic::SortedDictionary< TKey, TValue >::SortedDictionary ( const SharedPtr< IComparer< typename BasePointerType< TKey >::type > > &  comparer)
inline

Constructs empty dictionary.

Parameters
comparerComparer to use.

◆ SortedDictionary() [3/4]

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

Copy constructor.

Parameters
srcSource dictionary to copy data from.

◆ SortedDictionary() [4/4]

template<typename TKey , typename TValue >
System::Collections::Generic::SortedDictionary< TKey, TValue >::SortedDictionary ( const SharedPtr< IDictionary< TKey, TValue >> &  src,
const SharedPtr< IComparer< typename BasePointerType< TKey >::type >> &  comparer 
)
inline

Copy constructor.

Parameters
srcSource dictionary to copy data from.
comparerComparer to use.

◆ ~SortedDictionary()

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

Destructor.

Member Function Documentation

◆ crbegin()

template<typename TKey , typename TValue >
const_reverse_iterator System::Collections::Generic::SortedDictionary< TKey, TValue >::crbegin ( ) const
inlinenoexcept

Gets a reverse iterator to the last const-qualified element of collection (first in reverse).

Returns
A reverse iterator pointing to the last const-qualified element in the map (first in reverse).

◆ crend()

template<typename TKey , typename TValue >
const_reverse_iterator System::Collections::Generic::SortedDictionary< TKey, TValue >::crend ( ) const
inlinenoexcept

Gets a reverse iterator for a non-existent const-qualified element before the start of the collection.

Returns
A reverse iterator pointing to the theoretical const-qualified element preceeding the first element in the map (last in reverse).

◆ get_Comparer()

template<typename TKey , typename TValue >
SharedPtr<System::Collections::Generic::IComparer<TKey> > System::Collections::Generic::SortedDictionary< TKey, TValue >::get_Comparer ( ) const
inline

Gets the IComparer<TKey> used to order the elements of the SortedDictionary<TKey,TValue>.

◆ get_KeysInternal()

◆ get_ValuesInternal()

◆ GetDefaultKeyComparer()

template<typename TKey , typename TValue >
static SharedPtr<IComparer<typename BasePointerType<TKey>::type> > System::Collections::Generic::SortedDictionary< TKey, TValue >::GetDefaultKeyComparer ( )
inlinestatic

Singleton accessor function.

Returns
key default comparer.

◆ GetEnumerator()

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

Gets enumerator to iterate through current dictionary.

Returns
Pointer to newly created enumerator.

Implements System::Collections::Generic::BaseDictionary< std::map< TKey, TValue, ComparerAdapter< BasePointerType< TKey >::type >, ASPOSE_MAP_ALLOCATOR_TYPE(TKey, TValue)> >.

◆ rbegin() [1/2]

template<typename TKey , typename TValue >
reverse_iterator System::Collections::Generic::SortedDictionary< TKey, TValue >::rbegin ( )
inlinenoexcept

Gets a reverse iterator to the last element of collection (first in reverse).

Returns
A reverse iterator pointing to the last element in the map (first in reverse).

◆ rbegin() [2/2]

template<typename TKey , typename TValue >
const_reverse_iterator System::Collections::Generic::SortedDictionary< TKey, TValue >::rbegin ( ) const
inlinenoexcept

Gets a reverse iterator to the last element of the const-qualified collection (first in reverse).

Returns
A reverse iterator pointing to the last element in the const-qualified map (first in reverse).

◆ rend() [1/2]

template<typename TKey , typename TValue >
reverse_iterator System::Collections::Generic::SortedDictionary< TKey, TValue >::rend ( )
inlinenoexcept

Gets a reverse iterator for a non-existent element before the start of the collection.

Returns
A reverse iterator pointing to the theoretical element preceeding the first element in the map (last in reverse).

◆ rend() [2/2]

template<typename TKey , typename TValue >
const_reverse_iterator System::Collections::Generic::SortedDictionary< TKey, TValue >::rend ( ) const
inlinenoexcept

Gets a reverse iterator for a non-existent element before the start of the const-qualified collection.

Returns
A reverse iterator pointing to the theoretical element preceeding the first element in the const-qualified map (last in reverse).