List forward declaration. More...

#include <list.h>

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

Inherited by System::Collections::Generic::ListExt< T >.

Classes
class	Enumerator
	Enumerator to iterate through list elements. 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 T	ValueType
	This type. More...

typedef IList< T >	BaseType
	Interface type. More...

typedef std::vector< T, ASPOSE_COLLECTION_ALLOCATOR_TYPE >	vector_t
	Underlying data type. More...

typedef vector_t::iterator	iterator
	Iterator type. More...

typedef vector_t::const_iterator	const_iterator
	Const iterator type. More...

typedef vector_t::reverse_iterator	reverse_iterator
	Reverse iterator type. More...

typedef vector_t::const_reverse_iterator	const_reverse_iterator
	Const reverse iterator type. More...

typedef SharedPtr< IEnumerable< T > >	IEnumerablePtr
	Container holding elements of same type we hold. More...

typedef SharedPtr< IEnumerator< T > >	IEnumeratorPtr
	Enumerator type. More...

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Public Types inherited from System::Collections::Generic::IList< T >
typedef ICollection< T >	BaseType
	Base type. More...

typedef IList< T >	ThisType
	This type. More...

typedef T	ValueType
	Value 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 = System::Details::VirtualizedIterator< T >
	Iterator type. More...

using	const_iterator = System::Details::VirtualizedConstIterator< T >
	Const iterator type. More...

using	virtualized_iterator = System::Details::VirtualizedIteratorBase< T >
	Inner iterator base type. More...

using	virtualized_iterator_element = T
	Inner iterator element type. More...

Public Member Functions
	List ()
	Creates empty list. More...

	List (int capacity)
	Creates list with pre-defined capacity. More...

	List (IEnumerablePtr collection)
	Copy constructor. More...

void	AddInitializer (int size, const T inits[])
	Adds elements to list; used when translating initializers. More...

iterator	begin () noexcept
	Gets iterator to the first element of collection. More...

iterator	end () noexcept
	Gets iterator for a non-existent element behind the end of the collection. 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...

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

IEnumeratorPtr	GetEnumerator () override
	Gets enumerator to iterate through list elements. More...

int	get_Count () const override
	Gets number of elements in current list. More...

void	Add (const T &item) override
	Adds element to the end of list. More...

void	Clear () override
	Deletes all elements. More...

bool	Contains (const T &item) const override
	Checks if item is present in list. More...

bool	Remove (const T &item) override
	Removes first instance of specific item from list. More...

void	CopyTo (System::ArrayPtr< T > array, int arrayIndex) override
	Copies list elements into existing array elements. More...

int	IndexOf (const T &item) const override
	Gets first index of specific item. More...

void	Insert (int index, const T &item) override
	Inserts item at specified position. More...

void	RemoveAt (int index) override
	Removes item at specified position. More...

T	idx_get (int index) const override
	Gets element at specific position. More...

void	idx_set (int index, T value) override
	Sets element at specific position. More...

int	get_Capacity () const
	Gets current list capacity. More...

void	set_Capacity (int capacity)
	Sets list capacity. More...

void	AddRange (IEnumerablePtr collection)
	Adds all elements from collection (or itself) to the end of current list. More...

SharedPtr< System::Collections::ObjectModel::ReadOnlyCollection< T > >	AsReadOnly ()
	Gets read-only reference to this collection. More...

int	BinarySearch (const T &item) const
	Looks for item in a sorted list. More...

int	BinarySearch (const T &item, const SharedPtr< System::Collections::Generic::IComparer< T > > &comparer) const
	Looks for item in a sorted list. More...

int	BinarySearch (int index, int count, const T &item, const SharedPtr< System::Collections::Generic::IComparer< T > > &comparer) const
	Looks for item in a sorted list. More...

template<typename OutputType >
SharedPtr< List< OutputType > >	ConvertAll (Converter< T, OutputType > converter)
	Creates a list of elements converted to different type. More...

void	CopyTo (const System::ArrayPtr< T > &array)
	Copies all elements into existing array elements. More...

void	CopyTo (int index, const System::ArrayPtr< T > &array, int arrayIndex, int count)
	Copies elements starting from the specified index into existing array elements. More...

bool	Exists (System::Predicate< T > match)
	Checks if element adhering to specific predicate exists in list. More...

T	Find (System::Predicate< T > predicate)
	Looks for element adhering to specific predicate. More...

ListPtr< T >	FindAll (System::Predicate< T > match)
	Looks for elements adhering to specific predicate. More...

int	FindIndex (System::Predicate< T > match)
	Looks for element adhering to specific predicate. More...

int	FindIndex (int startIndex, System::Predicate< T > match)
	Looks for element adhering to specific predicate. More...

int	FindIndex (int startIndex, int count, System::Predicate< T > match)
	Looks for element adhering to specific predicate. More...

T	FindLast (System::Predicate< T > match)
	Looks for last element adhering to specific predicate. More...

void	ForEach (System::Action< T > action)
	Applies action to all elements in list. More...

ThisPtr	GetRange (int index, int count)
	Creates slice of list. More...

int	IndexOf (const T &item, int index) const
	Looks for specific item in list. More...

void	InsertRange (int index, IEnumerablePtr collection)
	Inserts data range at specific position. More...

int32_t	LastIndexOf (const T &item) const
	Searches for the specified object and returns the zero-based index of the last occurrence within the entire list. More...

int32_t	LastIndexOf (const T &item, int32_t index) const
	Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List that extends from the first element to the specified index. More...

int32_t	LastIndexOf (const T &item, int32_t index, int32_t count) const
	Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List that contains the specified number of elements and ends at the specified index. More...

int	RemoveAll (Predicate< T > match)
	Removes all elements matching specific predicate. More...

void	RemoveRange (int index, int count)
	Removes slice of list. More...

void	Reverse ()
	Reverses elements order of the whole list. More...

void	Reverse (int index, int count)
	Reverses elements order of the list slice. More...

void	Sort (const SharedPtr< System::Collections::Generic::IComparer< T > > &comparator)
	Sorts elements in the list. More...

void	Sort ()
	Sorts elements in the list using default comparator. More...

void	Sort (int index, int count, SharedPtr< System::Collections::Generic::IComparer< T > > comparator)
	Sorts elements in the list slice. More...

void	Sort (Comparison< T > comparison, bool)
	Sorts elements in the list. More...

ArrayPtr< T >	ToArray () const
	Converst list to array. More...

void	TrimExcess ()
	Makes list capacity to fit its size. More...

bool	TrueForAll (System::Predicate< T > match)
	Determines whether every element in the collection matches the conditions defined by the specified predicate. More...

vector_t::reference	operator[] (int index)
	Accessor function. More...

vector_t::const_reference	operator[] (int index) const
	Accessor function. More...

vector_t &	data ()
	Underlying data structure access function. More...

const vector_t &	data () const
	Underlying data structure access function. More...

void	_add_range (std::initializer_list< T > list)
	C++ specific. More...

System::Details::VirtualizedIteratorBase< T > *	virtualizeBeginIterator () override
	Gets the implementation of begin iterator for the current container. More...

System::Details::VirtualizedIteratorBase< T > *	virtualizeEndIterator () override
	Gets the implementation of end iterator for the current container. More...

System::Details::VirtualizedIteratorBase< T > *	virtualizeBeginConstIterator () const override
	Gets the implementation of begin const iterator for the current container. More...

System::Details::VirtualizedIteratorBase< T > *	virtualizeEndConstIterator () const override
	Gets the implementation of end const iterator for the current container. 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...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	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 TypeInfo &	GetType () 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::IList< T >
virtual int	IndexOf (const T &item) const =0
	Gets index of first appearance of item in container. More...

virtual void	Insert (int index, const T &item)=0
	Inserts element into specified position, shifting other elements. More...

virtual void	RemoveAt (int index)=0
	Removes element at specified index. More...

virtual T	idx_get (int index) const =0
	Gets element at specified index. More...

virtual void	idx_set (int index, T value)=0
	Sets element at specified index. More...

bool	get_IsFixedSize ()
	Checks whether the collection is of fixed size. More...

Public Member Functions inherited from System::Collections::Generic::ICollection< T >
virtual int	get_Count () const =0
	Gets number of elements in collection. More...

virtual void	Add (const T &item)=0
	Adds element into collection. More...

virtual void	Clear ()=0
	Deletes all elements from collection. More...

virtual bool	Contains (const T &item) const =0
	Checks if element is present in collection. More...

virtual bool	Remove (const T &item)=0
	Deletes element from collection. More...

virtual bool	get_IsReadOnly () const
	Checks if collection is read only. More...

virtual void	CopyTo (System::ArrayPtr< T > array, int arrayIndex)=0
	Copies all collection elements to existing array elements. More...

ICollection &	operator= (ICollection &&) noexcept
	Move assignment operator. More...

ICollection &	operator= (const ICollection &)
	Move assignment operator. More...

	ICollection ()
	Default constructor. More...

	ICollection (const ICollection &)
	Copy constructor. More...

	ICollection (ICollection &&) noexcept
	Move constructor. More...

virtual	~ICollection ()
	Destructor. More...

SharedPtr< Object >	get_SyncRoot () const
	Gets the object the collection is being synchronized through. More...

Public Member Functions inherited from System::Collections::Generic::IEnumerable< T >
virtual SharedPtr< IEnumerator< T > >	GetEnumerator ()=0
	Gets enumerator. More...

T	LINQ_ElementAt (int index)
	Returns the element at a specified index in a sequence. More...

T	LINQ_First ()
	Returns the first element of a sequence. More...

T	LINQ_First (const Func< T, bool > &predicate)
	Returns the first element of a sequence that satisfy the specified condition. More...

T	LINQ_FirstOrDefault ()
	Returns the first element of a sequence, or a default value if the sequence is empty. More...

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

T	LINQ_Last ()
	Returns the last element of a sequence. More...

T	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 ()
	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 ()
	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
	Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...

const_iterator	end () const
	Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...

const_iterator	cbegin () const
	Gets iterator pointing to the first const-qualified element (if any) of the collection. More...

const_iterator	cend () const
	Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...

virtual virtualized_iterator *	virtualizeBeginIterator ()
	Gets the implementation of begin iterator for the current container. More...

virtual virtualized_iterator *	virtualizeEndIterator ()
	Gets the implementation of end iterator for the current container. More...

virtual virtualized_iterator *	virtualizeBeginConstIterator () const
	Gets the implementation of begin const iterator for the current container. More...

virtual virtualized_iterator *	virtualizeEndConstIterator () const
	Gets the implementation of end const iterator for the current container. 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 Types
typedef SharedPtr< List< T > >	ThisPtr
	Pointer type. More...

Protected Member Functions
	~List () override
	Destructor. More...

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

virtualized_iterator *	GetEnumeratorAsVirtualizedIterator ()
	Gets enumerator instance and prepares it to be used as iterator kernel. More...

virtualized_iterator *	GetEnumeratorAsVirtualizedIterator () const
	Gets enumerator instance and prepares it to be used as iterator kernel. More...

Protected Attributes
vector_t	m_data
	Underlting 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 TypeInfo &	Type ()
	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::List< T >

List forward declaration.

List - wrapper around std::vector to be used in translated code. Requires operator == to be impemented for element type. 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.

#include <system/collections/list.h>
#include <system/smart_ptr.h>
 
using namespace System;
using namespace System::Collections::Generic;
 
int main()
{
  // Create the first list.
  auto list1 = MakeObject<List<int>>();
 
  // Fill the first list.
  list1->Add(3);
  list1->Add(1);
  list1->Add(-5);
  list1->Add(8);
 
  // Sort the first list.
  // The first list items will be: {-5, 1, 3, 8}
  list1->Sort();
 
  // Remove the item at index 2.
  // The first list items will be: {-5, 1, 8}
  list1->RemoveAt(2);
 
  // Insert the item to index 1.
  // The first list items will be: {-5, 15, 1, 8}
  list1->Insert(1, 15);
 
  // Create the second list.
  auto list2 = MakeObject<List<int>>();
 
  // Fill the second list.
  list2->Add(10);
  list2->Add(20);
  list2->Add(30);
 
  // Append elements from the second list to the first one.
  list1->AddRange(list2);
 
  // Print the first list items.
  for (const auto item: list1)
  {
    std::cout << item << ' ';
  }
 
  return 0;
}
/*
This code example produces the following output:
-5 15 1 8 10 20 30
*/

Template Parameters

T	Element type.

Member Typedef Documentation

◆ BaseType

template<typename T >

typedef IList<T> System::Collections::Generic::List< T >::BaseType

Interface type.

◆ const_iterator

template<typename T >

typedef vector_t::const_iterator System::Collections::Generic::List< T >::const_iterator

Const iterator type.

◆ const_reverse_iterator

template<typename T >

typedef vector_t::const_reverse_iterator System::Collections::Generic::List< T >::const_reverse_iterator

Const reverse iterator type.

◆ IEnumerablePtr

template<typename T >

typedef SharedPtr<IEnumerable<T> > System::Collections::Generic::List< T >::IEnumerablePtr

Container holding elements of same type we hold.

◆ IEnumeratorPtr

template<typename T >

typedef SharedPtr<IEnumerator<T> > System::Collections::Generic::List< T >::IEnumeratorPtr

Enumerator type.

◆ iterator

template<typename T >

typedef vector_t::iterator System::Collections::Generic::List< T >::iterator

Iterator type.

◆ reverse_iterator

template<typename T >

typedef vector_t::reverse_iterator System::Collections::Generic::List< T >::reverse_iterator

Reverse iterator type.

◆ ThisPtr

template<typename T >

typedef SharedPtr<List<T> > System::Collections::Generic::List< T >::ThisPtr

protected

Pointer type.

◆ ValueType

template<typename T >

typedef T System::Collections::Generic::List< T >::ValueType

This type.

◆ vector_t

template<typename T >

typedef std::vector<T, ASPOSE_COLLECTION_ALLOCATOR_TYPE> System::Collections::Generic::List< T >::vector_t

Underlying data type.

Constructor & Destructor Documentation

◆ List() [1/3]

template<typename T >

System::Collections::Generic::List< T >::List ( )

inline

Creates empty list.

◆ List() [2/3]

template<typename T >

System::Collections::Generic::List< T >::List ( int capacity )

inline

Creates list with pre-defined capacity.

Parameters

capacity Number of elements to reserve.

Exceptions

ArgumentOutOfRangeException if capacity is less than zero.

◆ List() [3/3]

template<typename T >

System::Collections::Generic::List< T >::List ( IEnumerablePtr collection )

inline

Copy constructor.

Parameters

collection Collection to copy data from.

Exceptions

ArgumentNullException if collection is nullptr.

◆ ~List()

template<typename T >

System::Collections::Generic::List< T >::~List ( )

inlineoverrideprotected

Destructor.

Member Function Documentation

◆ _add_range()

template<typename T >

void System::Collections::Generic::List< T >::_add_range ( std::initializer_list< T > list )

inline

C++ specific.

Parameters

list	Range to insert into container.

◆ Add()

template<typename T >

void System::Collections::Generic::List< T >::Add ( const T & item )

inlineoverridevirtual

Adds element to the end of list.

Parameters

item	Item to add.

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

◆ AddInitializer()

template<typename T >

void System::Collections::Generic::List< T >::AddInitializer	(	int	size,
		const T	inits[]
	)

inline

Adds elements to list; used when translating initializers.

Parameters

size	Number of elements to insert.
inits	Elements to insert.

◆ AddRange()

template<typename T >

void System::Collections::Generic::List< T >::AddRange ( IEnumerablePtr collection )

inline

Adds all elements from collection (or itself) to the end of current list.

Parameters

collection Collection to copy elements from.

Exceptions

ArgumentNullException if collection is nullptr.

◆ AsReadOnly()

template<typename T >

SharedPtr< System::Collections::ObjectModel::ReadOnlyCollection< T > > System::Collections::Generic::List< T >::AsReadOnly ( )

inline

Gets read-only reference to this collection.

Returns: Newly created read-only wrapper around current list.

◆ begin() [1/2]

template<typename T >

const_iterator System::Collections::Generic::List< 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 list.

◆ begin() [2/2]

template<typename T >

iterator System::Collections::Generic::List< T >::begin ( )

inlinenoexcept

Gets iterator to the first element of collection.

Returns: An iterator pointing to the first element in the list.

◆ BinarySearch() [1/3]

template<typename T >

int System::Collections::Generic::List< T >::BinarySearch ( const T & item ) const

inline

Looks for item in a sorted list.

Parameters

item	Item to look for.

Returns: Index of the item in sorted list or complement of closest index.

◆ BinarySearch() [2/3]

template<typename T >

int System::Collections::Generic::List< T >::BinarySearch	(	const T &	item,
		const SharedPtr< System::Collections::Generic::IComparer< T > > &	comparer
	)		const

inline

Looks for item in a sorted list.

Parameters

item	Item to look for.
comparer	Comparer to use.

Returns: Index of the item in sorted list or complement of closest index.

◆ BinarySearch() [3/3]

template<typename T >

int System::Collections::Generic::List< T >::BinarySearch	(	int	index,
		int	count,
		const T &	item,
		const SharedPtr< System::Collections::Generic::IComparer< T > > &	comparer
	)		const

inline

Looks for item in a sorted list.

Parameters

index	Range beginning.
count	Range size.
item	Item to look for.
comparer	Comparer to use.

Returns: Index of the item in sorted list or complement of closest index.

◆ cbegin()

template<typename T >

const_iterator System::Collections::Generic::List< 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 list.

◆ cend()

template<typename T >

const_iterator System::Collections::Generic::List< 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 list.

◆ Clear()

template<typename T >

void System::Collections::Generic::List< T >::Clear ( )

inlineoverridevirtual

Deletes all elements.

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

◆ Contains()

template<typename T >

bool System::Collections::Generic::List< T >::Contains ( const T & item ) const

inlineoverridevirtual

Checks if item is present in list.

Parameters

item	Item to look for.

Returns: True if item is found, false otherwise.

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

◆ ConvertAll()

template<typename T >

template<typename OutputType >

SharedPtr< List< OutputType > > System::Collections::Generic::List< T >::ConvertAll ( Converter< T, OutputType > converter )

inline

Creates a list of elements converted to different type.

Template Parameters

OutputType Output list element type.

Parameters

converter Converter to use for items conversion.

Returns: A newly created list of converted elements.

◆ CopyTo() [1/3]

template<typename T >

void System::Collections::Generic::List< T >::CopyTo ( const System::ArrayPtr< T > & array )

inline

Copies all elements into existing array elements.

Parameters

array Array to copy elements into.

◆ CopyTo() [2/3]

template<typename T >

void System::Collections::Generic::List< T >::CopyTo	(	int	index,
		const System::ArrayPtr< T > &	array,
		int	arrayIndex,
		int	count
	)

inline

Copies elements starting from the specified index into existing array elements.

Parameters

index	A 0-based index of the element in the list represented by the current object to start copying from
array	Array to copy elements into.
arrayIndex	Beginning position in desitnation array.
count	Number of elements to copy.

◆ CopyTo() [3/3]

template<typename T >

void System::Collections::Generic::List< T >::CopyTo	(	System::ArrayPtr< T >	array,
		int	arrayIndex
	)

inlineoverridevirtual

Copies list elements into existing array elements.

Parameters

array	Destination array.
arrayIndex	Destination array starting index.

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

◆ crbegin()

template<typename T >

const_reverse_iterator System::Collections::Generic::List< T >::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 list (first in reverse).

◆ crend()

template<typename T >

const_reverse_iterator System::Collections::Generic::List< T >::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 list (last in reverse).

◆ data() [1/2]

template<typename T >

vector_t & System::Collections::Generic::List< T >::data ( )

inline

Underlying data structure access function.

Returns: Reference to underlying vector.

◆ data() [2/2]

template<typename T >

const vector_t & System::Collections::Generic::List< T >::data ( ) const

inline

Underlying data structure access function.

Returns: Const reference to underlying vector.

◆ end() [1/2]

template<typename T >

const_iterator System::Collections::Generic::List< 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 list.

◆ end() [2/2]

template<typename T >

iterator System::Collections::Generic::List< T >::end ( )

inlinenoexcept

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

Returns: An iterator pointing to the theoretical element placed after the end element in the list.

◆ Exists()

template<typename T >

bool System::Collections::Generic::List< T >::Exists ( System::Predicate< T > match )

inline

Checks if element adhering to specific predicate exists in list.

Parameters

match Predicate to check elements with.

Returns: True if matching element is found, false otherwise.

◆ Find()

template<typename T >

T System::Collections::Generic::List< T >::Find ( System::Predicate< T > predicate )

inline

Looks for element adhering to specific predicate.

Parameters

predicate Predicate to check elements with.

Returns: Value of matching element or nullprtr if not found.

◆ FindAll()

template<typename T >

ListPtr< T > System::Collections::Generic::List< T >::FindAll ( System::Predicate< T > match )

inline

Looks for elements adhering to specific predicate.

Parameters

match Predicate to check elements with.

Returns: List of matching elements (if any) or empty list.

◆ FindIndex() [1/3]

template<typename T >

int System::Collections::Generic::List< T >::FindIndex	(	int	startIndex,
		int	count,
		System::Predicate< T >	match
	)

inline

Looks for element adhering to specific predicate.

Parameters

startIndex	Index to start search from.
count	Number of elements to look through.
match	Predicate to check elements with.

Returns: Index of matching element or -1 if not found.

◆ FindIndex() [2/3]

template<typename T >

int System::Collections::Generic::List< T >::FindIndex	(	int	startIndex,
		System::Predicate< T >	match
	)

inline

Looks for element adhering to specific predicate.

Parameters

startIndex	Index to start search from.
match	Predicate to check elements with.

Returns: Index of matching element or -1 if not found.

◆ FindIndex() [3/3]

template<typename T >

int System::Collections::Generic::List< T >::FindIndex ( System::Predicate< T > match )

inline

Looks for element adhering to specific predicate.

Parameters

match Predicate to check elements with.

Returns: Index of matching element or -1 if not found.

◆ FindLast()

template<typename T >

T System::Collections::Generic::List< T >::FindLast ( System::Predicate< T > match )

inline

Looks for last element adhering to specific predicate.

Parameters

match Predicate to check elements with.

Returns: Value of matching element or nullptr if not found.

◆ ForEach()

template<typename T >

void System::Collections::Generic::List< T >::ForEach ( System::Action< T > action )

inline

Applies action to all elements in list.

Parameters

action Action to apply.

◆ get_Capacity()

template<typename T >

int System::Collections::Generic::List< T >::get_Capacity ( ) const

inline

Gets current list capacity.

Returns: Capacity (not size) of the list.

◆ get_Count()

template<typename T >

int System::Collections::Generic::List< T >::get_Count ( ) const

inlineoverridevirtual

Gets number of elements in current list.

Returns: Actual number of elements.

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

◆ GetEnumerator()

template<typename T >

IEnumeratorPtr System::Collections::Generic::List< T >::GetEnumerator ( )

inlineoverridevirtual

Gets enumerator to iterate through list elements.

Returns: Pointer to newly created enumerator.

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

◆ GetRange()

template<typename T >

ThisPtr System::Collections::Generic::List< T >::GetRange	(	int	index,
		int	count
	)

inline

Creates slice of list.

Parameters

index	Range start index.
count	Range size.

Returns: List containing a slice of current list.

◆ idx_get()

template<typename T >

T System::Collections::Generic::List< T >::idx_get ( int index ) const

inlineoverridevirtual

Gets element at specific position.

Parameters

index Index to get element from.

Returns: Copy of element at specified position.

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

◆ idx_set()

template<typename T >

void System::Collections::Generic::List< T >::idx_set	(	int	index,
		T	value
	)

inlineoverridevirtual

Sets element at specific position.

Parameters

index	Index to set element at.
value	Value to set to specified position.

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

◆ IndexOf() [1/2]

template<typename T >

int System::Collections::Generic::List< T >::IndexOf ( const T & item ) const

inlineoverridevirtual

Gets first index of specific item.

Parameters

item	Item to look for.

Returns: Index of first occurance of specified item or -1 if not found.

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

◆ IndexOf() [2/2]

template<typename T >

int System::Collections::Generic::List< T >::IndexOf	(	const T &	item,
		int	index
	)		const

inline

Looks for specific item in list.

Parameters

item	Item to look for.
index	Index to start lookup at.

Returns: Index of first instance of specified item or -1 if not found.

◆ Insert()

template<typename T >

void System::Collections::Generic::List< T >::Insert	(	int	index,
		const T &	item
	)

inlineoverridevirtual

Inserts item at specified position.

Parameters

index	Index to insert item into.
item	Item to insert.

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

◆ InsertRange()

template<typename T >

void System::Collections::Generic::List< T >::InsertRange	(	int	index,
		IEnumerablePtr	collection
	)

inline

Inserts data range at specific position.

Parameters

index	Index to insert data at.
collection	Collection of elements to insert.

Exceptions

ArgumentOutOfRangeException	if index is less than zero.
ArgumentNullException	if collection is nullptr.

◆ LastIndexOf() [1/3]

template<typename T >

int32_t System::Collections::Generic::List< T >::LastIndexOf ( const T & item ) const

inline

Searches for the specified object and returns the zero-based index of the last occurrence within the entire list.

Parameters

item	The object to locate in the list

Returns: The zero-based index of the last occurrence of item within the entire the List, if found; otherwise, -1.

◆ LastIndexOf() [2/3]

template<typename T >

int32_t System::Collections::Generic::List< T >::LastIndexOf	(	const T &	item,
		int32_t	index
	)		const

inline

Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List that extends from the first element to the specified index.

Parameters

item	The object to locate in the list
index	The zero-based starting index of the backward search.

Returns: The zero-based index of the last occurrence of item within the range of elements in the List that extends from the first element to index, if found; otherwise, -1.

◆ LastIndexOf() [3/3]

template<typename T >

int32_t System::Collections::Generic::List< T >::LastIndexOf	(	const T &	item,
		int32_t	index,
		int32_t	count
	)		const

inline

Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List that contains the specified number of elements and ends at the specified index.

Parameters

item	The object to locate in the List
index	The zero-based starting index of the backward search.
count	The number of elements in the section to search.

Returns: The zero-based index of the last occurrence of item within the range of elements in the List that contains count number of elements and ends at index, if found; otherwise, -1.

◆ operator[]() [1/2]

template<typename T >

vector_t::reference System::Collections::Generic::List< T >::operator[] ( int index )

inline

Accessor function.

Parameters

index Index to get element from.

Returns: Reference to element at specified position.

◆ operator[]() [2/2]

template<typename T >

vector_t::const_reference System::Collections::Generic::List< T >::operator[] ( int index ) const

inline

Accessor function.

Parameters

index Index to get element from.

Returns: Const reference to element at specified position.

◆ rbegin() [1/2]

template<typename T >

const_reverse_iterator System::Collections::Generic::List< T >::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 list (first in reverse).

◆ rbegin() [2/2]

template<typename T >

reverse_iterator System::Collections::Generic::List< T >::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 list (first in reverse).

◆ Remove()

template<typename T >

bool System::Collections::Generic::List< T >::Remove ( const T & item )

inlineoverridevirtual

Removes first instance of specific item from list.

Parameters

item	Item to remove.

Returns: True if item was found and removed, false otherwise.

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

◆ RemoveAll()

template<typename T >

int System::Collections::Generic::List< T >::RemoveAll ( Predicate< T > match )

inline

Removes all elements matching specific predicate.

Parameters

match Predicate to check elements with.

Returns: Number of removed elements.

◆ RemoveAt()

template<typename T >

void System::Collections::Generic::List< T >::RemoveAt ( int index )

inlineoverridevirtual

Removes item at specified position.

Parameters

index Index to delete item at.

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

◆ RemoveRange()

template<typename T >

void System::Collections::Generic::List< T >::RemoveRange	(	int	index,
		int	count
	)

inline

Removes slice of list.

Parameters

index	Slice beginning position.
count	Number of elements to remove.

◆ rend() [1/2]

template<typename T >

const_reverse_iterator System::Collections::Generic::List< T >::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 list (last in reverse).

◆ rend() [2/2]

template<typename T >

reverse_iterator System::Collections::Generic::List< T >::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 list (last in reverse).

◆ Reverse() [1/2]

template<typename T >

void System::Collections::Generic::List< T >::Reverse ( )

inline

Reverses elements order of the whole list.

◆ Reverse() [2/2]

template<typename T >

void System::Collections::Generic::List< T >::Reverse	(	int	index,
		int	count
	)

inline

Reverses elements order of the list slice.

Parameters

index	Slice beginning index.
count	Slice size.

◆ set_Capacity()

template<typename T >

void System::Collections::Generic::List< T >::set_Capacity ( int capacity )

inline

Sets list capacity.

Parameters

capacity Capacity to set (can't be less than current size).

◆ Sort() [1/4]

template<typename T >

void System::Collections::Generic::List< T >::Sort ( )

inline

Sorts elements in the list using default comparator.

◆ Sort() [2/4]

template<typename T >

void System::Collections::Generic::List< T >::Sort	(	Comparison< T >	comparison,
		bool
	)

inline

Sorts elements in the list.

Parameters

comparison Comparison to use.

◆ Sort() [3/4]

template<typename T >

void System::Collections::Generic::List< T >::Sort ( const SharedPtr< System::Collections::Generic::IComparer< T > > & comparator )

inline

Sorts elements in the list.

Parameters

comparator Comparator to use.

◆ Sort() [4/4]

template<typename T >

void System::Collections::Generic::List< T >::Sort	(	int	index,
		int	count,
		SharedPtr< System::Collections::Generic::IComparer< T > >	comparator
	)

inline

Sorts elements in the list slice.

Parameters

index	Slice beginning index.
count	Slice size.
comparator	Comparator to use.

◆ ToArray()

template<typename T >

ArrayPtr< T > System::Collections::Generic::List< T >::ToArray ( ) const

inline

Converst list to array.

Returns: Newly created array with copies of all elements.

◆ TrimExcess()

template<typename T >

void System::Collections::Generic::List< T >::TrimExcess ( )

inline

Makes list capacity to fit its size.

◆ TrueForAll()

template<typename T >

bool System::Collections::Generic::List< T >::TrueForAll ( System::Predicate< T > match )

inline

Determines whether every element in the collection matches the conditions defined by the specified predicate.

Parameters

match Predicate to check elements with.

Returns: True if every element matches the conditions, false otherwise.

◆ virtualizeBeginConstIterator()

template<typename T >

System::Details::VirtualizedIteratorBase< T > * System::Collections::Generic::List< T >::virtualizeBeginConstIterator ( ) const

inlineoverridevirtual

Gets the implementation of begin const iterator for the current container.

Returns: Pointer to the newly created iterator kernel object.

Reimplemented from System::Collections::Generic::IEnumerable< T >.

◆ virtualizeBeginIterator()

template<typename T >

System::Details::VirtualizedIteratorBase< T > * System::Collections::Generic::List< T >::virtualizeBeginIterator ( )

inlineoverridevirtual

Gets the implementation of begin iterator for the current container.

Returns: Pointer to the newly created iterator kernel object.

Reimplemented from System::Collections::Generic::IEnumerable< T >.

◆ virtualizeEndConstIterator()

template<typename T >

System::Details::VirtualizedIteratorBase< T > * System::Collections::Generic::List< T >::virtualizeEndConstIterator ( ) const

inlineoverridevirtual

Gets the implementation of end const iterator for the current container.

Returns: Pointer to the newly created iterator kernel object.

Reimplemented from System::Collections::Generic::IEnumerable< T >.

◆ virtualizeEndIterator()

template<typename T >

System::Details::VirtualizedIteratorBase< T > * System::Collections::Generic::List< T >::virtualizeEndIterator ( )

inlineoverridevirtual

Gets the implementation of end iterator for the current container.

Returns: Pointer to the newly created iterator kernel object.

Reimplemented from System::Collections::Generic::IEnumerable< T >.

Member Data Documentation

◆ m_data

template<typename T >

vector_t System::Collections::Generic::List< T >::m_data

protected

Underlting data structure.

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseType

◆ const_iterator

◆ const_reverse_iterator

◆ IEnumerablePtr

◆ IEnumeratorPtr

◆ iterator

◆ reverse_iterator

◆ ThisPtr

◆ ValueType

◆ vector_t

Constructor & Destructor Documentation

◆ List() [1/3]

◆ List() [2/3]

◆ List() [3/3]

◆ ~List()

Member Function Documentation

◆ _add_range()

◆ Add()

◆ AddInitializer()

◆ AddRange()

◆ AsReadOnly()

◆ begin() [1/2]

◆ begin() [2/2]

◆ BinarySearch() [1/3]

◆ BinarySearch() [2/3]

◆ BinarySearch() [3/3]

◆ cbegin()

◆ cend()

◆ Clear()

◆ Contains()

◆ ConvertAll()

◆ CopyTo() [1/3]

◆ CopyTo() [2/3]

◆ CopyTo() [3/3]

◆ crbegin()

◆ crend()

◆ data() [1/2]

◆ data() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ Exists()

◆ Find()

◆ FindAll()

◆ FindIndex() [1/3]

◆ FindIndex() [2/3]

◆ FindIndex() [3/3]

◆ FindLast()

◆ ForEach()

◆ get_Capacity()

◆ get_Count()

◆ GetEnumerator()

◆ GetRange()

◆ idx_get()

◆ idx_set()

◆ IndexOf() [1/2]

◆ IndexOf() [2/2]

◆ Insert()

◆ InsertRange()

◆ LastIndexOf() [1/3]

◆ LastIndexOf() [2/3]

◆ LastIndexOf() [3/3]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ Remove()

◆ RemoveAll()

◆ RemoveAt()

◆ RemoveRange()

◆ rend() [1/2]

◆ rend() [2/2]