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

Inherits System::Collections::Generic::BaseDictionary< Detail::FlatMap< TKey, TValue, ComparerAdapter< TKey > > >.

Classes

class  Enumerator
 

Public Types

typedef ICollection< TKey > KeyCollection
 Key collection type. More...
 
typedef ICollection< TValue > ValueCollection
 Value collection type. More...
 
typedef Detail::FlatMap< TKey, TValue, ComparerAdapter< TKey > > map_t
 Underlying data type. More...
 
typedef SortedList< TKey, TValue > this_t
 This 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 pairs type. More...
 
typedef SharedPtr< IEnumerator< KVPair > > IEnumeratorPtr
 Enumerator type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 

Public Member Functions

 SortedList ()
 Constructs empty list. More...
 
 SortedList (const SharedPtr< IComparer< TKey > > &comparer)
 
 SortedList (const SharedPtr< IDictionary< TKey, TValue > > &src)
 
 SortedList (const map_t &map)
 
 SortedList (int capacity)
 
int get_Capacity () const
 
void set_Capacity (int capacity)
 
void RemoveAt (int index)
 
int IndexOfKey (TKey key) const
 
int IndexOfValue (TValue value) const
 
IEnumeratorPtr GetEnumerator () override
 
KVPairIterator< KVPair, map_tbegin () noexcept
 
KVPairIterator< KVPair, map_tend () noexcept
 
virtual SharedPtr< IList< TKey > > get_Keys () const
 Allows loop reference lookup for SortedList type. More...
 
virtual SharedPtr< IList< TValue > > get_Values () const
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 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...
 
void SharedRefRemoved ()
 Decrements shared reference count and deletes object if it hits zero. Shouldn't be called directly; instead, use smart pointers or ThisProtector. 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 refernce counter. More...
 
void FreeOrDetectCycles (int count)
 Reacts on shared reference counter decrement. Shouldn't be called directly, use smart pointers instead. If neccessary, deletes the object. If allowed, initiates loop references lookup. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Protected Member Functions

virtual SharedPtr< KeyCollectionget_KeysInternal () const override
 
virtual SharedPtr< ValueCollectionget_ValuesInternal () const override
 

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 ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

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

Sorted list wrapping FlatMap structure. 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

◆ IEnumerablePtr

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

Collection of same pairs type.

◆ IEnumeratorPtr

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

Enumerator type.

◆ KeyCollection

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

Key collection type.

◆ KVPair

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

Key value pair type.

◆ map_t

template<typename TKey , typename TValue >
typedef Detail::FlatMap<TKey, TValue, ComparerAdapter<TKey> > System::Collections::Generic::SortedList< TKey, TValue >::map_t

Underlying data type.

◆ Ptr

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

Pointer type.

◆ this_t

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

This type.

◆ ValueCollection

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

Value collection type.

Constructor & Destructor Documentation

◆ SortedList() [1/5]

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

Constructs empty list.

◆ SortedList() [2/5]

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

Constructs empty list.

Parameters
comparerComparer to use.

◆ SortedList() [3/5]

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

Copy constructor.

Parameters
srcDictionary to copy data from.

◆ SortedList() [4/5]

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

Copy constructor.

Parameters
mapMap tp copy data from.

◆ SortedList() [5/5]

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

Constructs empty list.

Parameters
capacityNumber of elements to reserve.

Member Function Documentation

◆ begin()

template<typename TKey , typename TValue >
KVPairIterator<KVPair, map_t> System::Collections::Generic::SortedList< TKey, TValue >::begin ( )
inlinenoexcept

Returns an iterator to the first element of the container. If the container is empty, the returned iterator will be equal to end().

◆ end()

template<typename TKey , typename TValue >
KVPairIterator<KVPair, map_t> System::Collections::Generic::SortedList< TKey, TValue >::end ( )
inlinenoexcept

Returns an iterator to the element following the last element of the container. This element acts as a placeholder; attempting to access it results in undefined behavior.

◆ get_Capacity()

template<typename TKey , typename TValue >
int System::Collections::Generic::SortedList< TKey, TValue >::get_Capacity ( ) const
inline

Gets current list capacity.

Returns
Actual capacity of current list.

◆ get_Keys()

template<typename TKey , typename TValue >
virtual SharedPtr<IList<TKey> > System::Collections::Generic::SortedList< TKey, TValue >::get_Keys ( ) const
inlinevirtual

Allows loop reference lookup for SortedList type.

Gets wrapper collection to access this collection's keys.

Returns
Wrapper to access dictionary keys through.

◆ get_KeysInternal()

template<typename TKey , typename TValue >
virtual SharedPtr<KeyCollection> System::Collections::Generic::SortedList< TKey, TValue >::get_KeysInternal ( ) const
inlineoverrideprotectedvirtual

◆ get_Values()

template<typename TKey , typename TValue >
virtual SharedPtr<IList<TValue> > System::Collections::Generic::SortedList< TKey, TValue >::get_Values ( ) const
inlinevirtual

Gets wrapper collection to access this collection's values.

Returns
Wrapper to access dictionary values through.

◆ get_ValuesInternal()

template<typename TKey , typename TValue >
virtual SharedPtr<ValueCollection> System::Collections::Generic::SortedList< TKey, TValue >::get_ValuesInternal ( ) const
inlineoverrideprotectedvirtual

◆ GetEnumerator()

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

Gets enumerator iterating through current list.

Returns
Pointer to newly created enumerator iterating through current list.

Implements System::Collections::Generic::BaseDictionary< Detail::FlatMap< TKey, TValue, ComparerAdapter< TKey > > >.

◆ IndexOfKey()

template<typename TKey , typename TValue >
int System::Collections::Generic::SortedList< TKey, TValue >::IndexOfKey ( TKey  key) const
inline

Looks for specific key.

Parameters
keyKey to look for.
Returns
index of speified key or -1 if not found.

◆ IndexOfValue()

template<typename TKey , typename TValue >
int System::Collections::Generic::SortedList< TKey, TValue >::IndexOfValue ( TValue  value) const
inline

Looks for specific value.

Parameters
valueValue to look for.
Returns
Index of the first occurrance of specified value or -1 if not found.

◆ RemoveAt()

template<typename TKey , typename TValue >
void System::Collections::Generic::SortedList< TKey, TValue >::RemoveAt ( int  index)
inline

Removes item at specified position.

Parameters
indexIndex to remove element at.

◆ set_Capacity()

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

Sets current list capacity.

Parameters
capacityCapacity to set.