System::Collections::Generic::HashSet< T > Class Template Reference

Forward declaration of HashSet class. More...

Inherits System::Object, and System::Collections::Generic::ICollection< T >.

Classes

class  Enumerator
 

Public Types

using ThisType = System::Collections::Generic::HashSet< T >
 Self type. More...
 
using ThisPtr = SharedPtr< ThisType >
 Pointer type. More...
 
using set_t = std::unordered_set< T, EqualityComparerHashAdapter< T >, EqualityComparerAdapter< T >, typename System::Details::CollectionHelpers::ContainerPointerMode< T >::allocator_type >
 Underlying data type. More...
 
using setIt_t = typename set_t::iterator
 Iterator type. More...
 
using ValueType = T
 Value type. More...
 
using BaseType = ICollection< T >
 Implemented interface. More...
 
using IEnumerablePtr = SharedPtr< IEnumerable< T > >
 Enumerable interface pointer. More...
 
using IEnumeratorPtr = SharedPtr< IEnumerator< T > >
 Enumerator pointer. 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 Types inherited from System::Collections::Generic::ICollection< T >
typedef T ValueType
 Value type name. More...
 
typedef ICollection< T > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< T >
typedef IEnumerator< T > IEnumeratorType
 Enumerator type. More...
 

Public Member Functions

 HashSet ()
 Creates empty set. More...
 
IEnumeratorPtr GetEnumerator () override
 
int get_Count () const override
 
void Add (const T &item) override
 
bool TryAdd (const T &item)
 
bool Remove (const T &item) override
 
void Clear () override
 Deletes all elements in set. More...
 
bool Contains (const T &item) const override
 
set_tdata ()
 
const set_tdata () const
 
void _add_range (std::initializer_list< T > list)
 
void CopyTo (ArrayPtr< T > arr, int index) override
 
void SetTemplateWeakPtr (unsigned int argument) override
 
- 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)
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< T >
virtual bool get_IsReadOnly () const
 

Protected Member Functions

 DEFINE_GET_SHARED_MEMBERS (m_data)
 Implements loop reference detection mechanism for container. 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 ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

template<typename T>
class System::Collections::Generic::HashSet< T >

Forward declaration of HashSet class.

Set implementation based on hashing. 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.

Parameters
TElement type.

Member Typedef Documentation

◆ BaseType

template<typename T >
using System::Collections::Generic::HashSet< T >::BaseType = ICollection<T>

Implemented interface.

◆ IEnumerablePtr

Enumerable interface pointer.

◆ IEnumeratorPtr

Enumerator pointer.

◆ set_t

template<typename T >
using System::Collections::Generic::HashSet< T >::set_t = std::unordered_set<T, EqualityComparerHashAdapter<T>, EqualityComparerAdapter<T>, typename System::Details::CollectionHelpers::ContainerPointerMode<T>::allocator_type>

Underlying data type.

◆ setIt_t

template<typename T >
using System::Collections::Generic::HashSet< T >::setIt_t = typename set_t::iterator

Iterator type.

◆ ThisPtr

template<typename T >
using System::Collections::Generic::HashSet< T >::ThisPtr = SharedPtr<ThisType>

Pointer type.

◆ ThisType

◆ ValueType

template<typename T >
using System::Collections::Generic::HashSet< T >::ValueType = T

Value type.

Constructor & Destructor Documentation

◆ HashSet()

template<typename T >
System::Collections::Generic::HashSet< T >::HashSet ( )
inline

Creates empty set.

Member Function Documentation

◆ _add_range()

template<typename T >
void System::Collections::Generic::HashSet< T >::_add_range ( std::initializer_list< T >  list)
inline

C++ specific

Parameters
listRange to insert into container.

◆ Add()

template<typename T >
void System::Collections::Generic::HashSet< T >::Add ( const T &  item)
inlineoverridevirtual

Adds element into set.

Parameters
itemElement to add.

Implements System::Collections::Generic::ICollection< T >.

◆ Clear()

template<typename T >
void System::Collections::Generic::HashSet< T >::Clear ( )
inlineoverridevirtual

Deletes all elements in set.

Implements System::Collections::Generic::ICollection< T >.

◆ Contains()

template<typename T >
bool System::Collections::Generic::HashSet< T >::Contains ( const T &  item) const
inlineoverridevirtual

Checks if element is present in set.

Parameters
itemItem to look for.
Returns
True if item is present in set, false otherwise.

Implements System::Collections::Generic::ICollection< T >.

◆ CopyTo()

template<typename T >
void System::Collections::Generic::HashSet< T >::CopyTo ( ArrayPtr< T >  arr,
int  index 
)
inlineoverridevirtual

Copies hash contents into existing array elements.

Parameters
arrDestination array.
indexDestination array beginning index.

Implements System::Collections::Generic::ICollection< T >.

◆ data() [1/2]

template<typename T >
set_t& System::Collections::Generic::HashSet< T >::data ( )
inline

Underlying data structure accessor.

Returns
Reference to underlying data structure.

◆ data() [2/2]

template<typename T >
const set_t& System::Collections::Generic::HashSet< T >::data ( ) const
inline

Underlying data structure accessor.

Returns
Const reference to underlying data structure.

◆ DEFINE_GET_SHARED_MEMBERS()

template<typename T >
System::Collections::Generic::HashSet< T >::DEFINE_GET_SHARED_MEMBERS ( m_data  )
protected

Implements loop reference detection mechanism for container.

◆ get_Count()

template<typename T >
int System::Collections::Generic::HashSet< T >::get_Count ( ) const
inlineoverridevirtual

Gets number of elements in set.

Returns
Actual number of elements.

Implements System::Collections::Generic::ICollection< T >.

◆ GetEnumerator()

template<typename T >
IEnumeratorPtr System::Collections::Generic::HashSet< T >::GetEnumerator ( )
inlineoverridevirtual

Creates enumerator.

Returns
Newly created enumerator.

Implements System::Collections::Generic::IEnumerable< T >.

◆ Remove()

template<typename T >
bool System::Collections::Generic::HashSet< T >::Remove ( const T &  item)
inlineoverridevirtual

Removes element from set.

Parameters
itemElement to remove.
Returns
True if element was found and deleted, false otherwise.

Implements System::Collections::Generic::ICollection< T >.

◆ SetTemplateWeakPtr()

template<typename T >
void System::Collections::Generic::HashSet< T >::SetTemplateWeakPtr ( unsigned int  argument)
inlineoverridevirtual

Makes stored pointers to be treated as weak (if applicable).

Parameters
argumentShould be 0 to refer the only template argument.

Reimplemented from System::Object.

◆ TryAdd()

template<typename T >
bool System::Collections::Generic::HashSet< T >::TryAdd ( const T &  item)
inline

Adds element into set.

Parameters
itemItem to add.
Returns
True if element was added, false if already exists.