Asposecpplib
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
 Enumerator class. 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

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 >, ASPOSE_COLLECTION_ALLOCATOR_TYPE >
 Underlying data type. More...
 
using iterator = typename set_t::iterator
 Iterator type. More...
 
using const_iterator = typename set_t::const_iterator
 Const 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...
 
- 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...
 
using ValueType = T
 
using iterator = EnumeratorBasedIterator< T, IEnumerator< T > >
 
using const_iterator = iterator
 

Public Member Functions

 HashSet ()
 Creates empty set. More...
 
 HashSet (const SharedPtr< IEqualityComparer< T >> &comparer)
 Creates empty set that uses the specified equality comparer. More...
 
 HashSet (const SharedPtr< IEnumerable< T >> &items)
 Creates hashset based on enumerable values. More...
 
const_iterator begin () const noexcept
 Gets iterator to the first element of the const-qualified collection. More...
 
const_iterator end () const noexcept
 Gets iterator for a non-existent element behind the end of the const-qualified collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator to the first const-qualified element of collection. More...
 
const_iterator cend () const noexcept
 Gets iterator for a non-existent const-qualified element behind the end of the collection. More...
 
IEnumeratorPtr GetEnumerator () override
 Creates enumerator. More...
 
int get_Count () const override
 Gets number of elements in set. More...
 
void Add (const T &item) override
 Adds element into set. More...
 
bool TryAdd (const T &item)
 Adds element into set. More...
 
bool Remove (const T &item) override
 Removes element from set. More...
 
void Clear () override
 Deletes all elements in set. More...
 
bool Contains (const T &item) const override
 Checks if element is present in set. More...
 
set_tdata ()
 Underlying data structure accessor. More...
 
const set_tdata () const
 Underlying data structure accessor. More...
 
void _add_range (std::initializer_list< T > list)
 C++ specific. More...
 
void CopyTo (ArrayPtr< T > arr, int index) override
 Copies hash contents into existing array elements. More...
 
virtual int get_Count () const=0
 Keeping get_Count() from hiding. More...
 
- 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...
 
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...
 
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 int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () 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...
 
virtual 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 bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. 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...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< T >
virtual bool get_IsReadOnly () const
 Checks if collection is read only. More...
 
ICollectionoperator= (ICollection &&)
 Move assignment operator. More...
 
ICollectionoperator= (const ICollection &)
 Move assignment operator. More...
 
 ICollection ()
 Default constructor. More...
 
 ICollection (const ICollection &)
 Copy constructor. More...
 
 ICollection (ICollection &&)
 Move constructor. More...
 
virtual ~ICollection ()
 Destructor. More...
 
virtual SharedPtr< Objectget_SyncRoot () const
 Gets the object the collection is being synchronized through. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< T >
LINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
LINQ_First ()
 Returns the first element of a sequence. More...
 
LINQ_First (const Func< T, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
LINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
LINQ_FirstOrDefault (std::function< bool(T)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
LINQ_Last ()
 Returns the last element of a sequence. More...
 
LINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< T > > LINQ_ToList ()
 Creates a List<T> from a sequence. More...
 
int LINQ_Count ()
 Returns the number of elements in the sequence (calculated via direct counting). More...
 
int LINQ_Count (const Func< T, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< T > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(T)> predicate)
 Determines whether all elements of a sequence satisfy a condition. More...
 
bool LINQ_Any ()
 Determines whether a sequence contains any elements. More...
 
bool LINQ_Any (std::function< bool(T)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< T > > LINQ_Where (std::function< bool(T)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (T value)
 Determines if a sequence contains a specified value. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
template<typename Key >
SharedPtr< IEnumerable< T > > LINQ_OrderBy (const Func< T, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
template<typename Key >
SharedPtr< IEnumerable< T > > LINQ_OrderByDescending (const Func< T, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, ResultType > &selector)
 Transforms elements of a sequence. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< T > > LINQ_Concat (SharedPtr< IEnumerable< T >> sequence)
 Concatenates two sequences. More...
 
template<typename Key >
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, T > > > > LINQ_GroupBy (System::Func< T, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< T, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
iterator begin () noexcept
 Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
iterator end () noexcept
 Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator begin () const noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
const_iterator end () const noexcept
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const noexcept
 Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
template<typename Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
template<typename Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
template<typename Key >
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 

Protected Member Functions

 ~HashSet () override
 Destructor. More...
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< T >
 ~IEnumerable () override
 Destructor. More...
 

Protected Attributes

set_t m_data
 Internal data structure. 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...
 
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...
 

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.

◆ const_iterator

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

Const iterator type.

◆ IEnumerablePtr

Enumerable interface pointer.

◆ IEnumeratorPtr

Enumerator pointer.

◆ iterator

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

Iterator type.

◆ set_t

template<typename T >
using System::Collections::Generic::HashSet< T >::set_t = std::unordered_set<T, EqualityComparerHashAdapter<T>, EqualityComparerAdapter<T>, ASPOSE_COLLECTION_ALLOCATOR_TYPE>

Underlying data 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() [1/3]

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

Creates empty set.

◆ HashSet() [2/3]

template<typename T >
System::Collections::Generic::HashSet< T >::HashSet ( const SharedPtr< IEqualityComparer< T >> &  comparer)
inline

Creates empty set that uses the specified equality comparer.

Parameters
comparerComparer object to associate with hashset.

◆ HashSet() [3/3]

template<typename T >
System::Collections::Generic::HashSet< T >::HashSet ( const SharedPtr< IEnumerable< T >> &  items)
inline

Creates hashset based on enumerable values.

◆ ~HashSet()

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

Destructor.

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

◆ begin()

template<typename T >
const_iterator System::Collections::Generic::HashSet< T >::begin ( ) const
inlinenoexcept

Gets iterator to the first element of the const-qualified collection.

Returns
An iterator pointing to the first element in the const-qualified instance of the hash set.

◆ cbegin()

template<typename T >
const_iterator System::Collections::Generic::HashSet< T >::cbegin ( ) const
inlinenoexcept

Gets iterator to the first const-qualified element of collection.

Returns
An iterator pointing to the first const-qualified element in the hash set.

◆ cend()

template<typename T >
const_iterator System::Collections::Generic::HashSet< T >::cend ( ) const
inlinenoexcept

Gets iterator for a non-existent const-qualified element behind the end of the collection.

Returns
An iterator pointing to the theoretical const-qualified element placed after the end element in the hash set.

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

◆ end()

template<typename T >
const_iterator System::Collections::Generic::HashSet< T >::end ( ) const
inlinenoexcept

Gets iterator for a non-existent element behind the end of the const-qualified collection.

Returns
An iterator pointing to the theoretical element placed after the end element in the const-qualified instance of the hash set.

◆ get_Count() [1/2]

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

◆ get_Count() [2/2]

template<typename T >
virtual int System::Collections::Generic::ICollection< T >::get_Count

Keeping get_Count() from hiding.

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

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

Member Data Documentation

◆ m_data

template<typename T >
set_t System::Collections::Generic::HashSet< T >::m_data
protected

Internal data structure.