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

Inherits System::Collections::Generic::SortedListHelper< TKey, TValue >, and 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...
 
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

 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
 
reverse_iterator rbegin () noexcept
 
reverse_iterator rend () noexcept
 
const_reverse_iterator rbegin () const noexcept
 
const_reverse_iterator rend () const noexcept
 
const_reverse_iterator crbegin () const noexcept
 
const_reverse_iterator crend () const noexcept
 
SharedPtr< IList< TValue > > get_Values () const
 
SharedPtr< IList< TKey > > get_Keys () const
 
- Public Member Functions inherited from System::Collections::Generic::SortedListHelper< TKey, TValue >
SharedPtr< IList< TKey > > get_Keys () const
 
SharedPtr< IList< TValue > > get_Values () const
 
- 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)
 
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)
 

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::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.
#include "system/collections/sorted_list.h"
#include "system/smart_ptr.h"
#include <iostream>
int main()
{
// Create an instance of the SortedList class.
auto sortedList = System::MakeObject<System::Collections::Generic::SortedList<System::String, int>>();
// Fill the list.
sortedList->Add(u"First", 100);
sortedList->Add(u"Second", 241);
sortedList->Add(u"Third", 635);
// Print properties of the list.
std::cout <<
"Count: " << sortedList->get_Count() << std::endl <<
"Capacity: " << sortedList->get_Capacity() << std::endl;
// Print items.
std::cout << "Items:" << std::endl;
for (const auto &item: sortedList)
{
std::cout << '\t' << item.get_Key() << " - " << item.get_Value() << std::endl;
}
return 0;
}
/*
* This code example produces the following output:
* Count: 3
* Capacity: 3
* Items:
* First - 100
* Second - 241
* Third - 635
*/

Member Typedef Documentation

◆ const_iterator

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

Const iterator type.

◆ const_reverse_iterator

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

Const reverse iterator type.

◆ 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.

◆ iterator

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

Iterator 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.

◆ reverse_iterator

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

Reverse iterator 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

◆ crbegin()

template<typename TKey , typename TValue >
const_reverse_iterator System::Collections::Generic::SortedList< 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::SortedList< 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 preceding the first element in the map (last in reverse).

◆ 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 >
SharedPtr<IList<TKey> > System::Collections::Generic::SortedListHelper< TKey, TValue >::get_Keys
inline

◆ get_Values()

template<typename TKey , typename TValue >
SharedPtr<IList<TValue> > System::Collections::Generic::SortedListHelper< TKey, TValue >::get_Values
inline

◆ 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 specified 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 occurrence of specified value or -1 if not found.

◆ rbegin() [1/2]

template<typename TKey , typename TValue >
reverse_iterator System::Collections::Generic::SortedList< 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::SortedList< 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).

◆ 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.

◆ rend() [1/2]

template<typename TKey , typename TValue >
reverse_iterator System::Collections::Generic::SortedList< 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 preceding the first element in the map (last in reverse).

◆ rend() [2/2]

template<typename TKey , typename TValue >
const_reverse_iterator System::Collections::Generic::SortedList< 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 preceding the first element in the const-qualified map (last in reverse).

◆ 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.