Asposecpplib
System::Collections::Generic::Stack< T > Class Template Reference

Stack class forward declaration. More...

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

Classes

class  Enumerator
 Enumerator to iterate through stack. 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
 Value type. More...
 
typedef std::list< T, ASPOSE_COLLECTION_ALLOCATOR_TYPE > stack_t
 Underlying data type. More...
 
typedef SharedPtr< IEnumerable< T > > IEnumerablePtr
 Collection containing elements of same type. More...
 
typedef SharedPtr< IEnumerator< T > > IEnumeratorPtr
 Enumerator type. 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 Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

 Stack ()
 Constructs empty stack. More...
 
 Stack (int capacity)
 Constructs empty stack. More...
 
 Stack (IEnumerablePtr collection)
 Copy constructor. More...
 
IEnumeratorPtr GetEnumerator () override
 Gets enumerator to iterate through current stack. More...
 
virtual int get_Count () const
 Gets number of elements in stack. More...
 
virtual void Clear ()
 Deletes all elements from stack. More...
 
virtual bool Contains (const T &item) const
 Checks if specific item is present in container; uses operator == for comparison. More...
 
void Push (const T &item)
 Puts element of top of the stack. More...
 
Pop ()
 Gets element from top of the stack. More...
 
Peek ()
 Gets element from stack top, but keeps it in stack. More...
 
stack_tdata ()
 Internal data structure accessor. More...
 
const stack_tdata () const
 Internal data structure accessor. More...
 
virtual ArrayPtr< T > ToArray ()
 Converts stack to array. More...
 
void AddRange (IEnumerablePtr collection)
 Puts elements into stack. 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)
 
- 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...
 

Protected Types

typedef SharedPtr< Stack< T > > ThisPtr
 Pointer type. More...
 
typedef stack_t::reverse_iterator queueIt_t
 Iterator type. More...
 

Protected Member Functions

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

Protected Attributes

stack_t m_data
 Underlying 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::Stack< T >

Stack class forward declaration.

Stack class wrapping std::list. 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/stack.h>
#include <system/smart_ptr.h>
using namespace System;
void PrintItems(const SmartPtr<IEnumerable<int>> &stack) {
for (const auto item: stack) {
std::cout << item << ' ';
}
std::cout << std::endl;
}
int main() {
// Create the Stack-class instance.
auto stack = MakeObject<Stack<int>>();
// Fill the stack.
stack->Push(1);
stack->Push(2);
stack->Push(3);
// Print the last item of the stack. The Peek method doesn't remove an item from the stack.
std::cout << stack->Peek() << std::endl;
PrintItems(stack);
// Print the last item of the stack. The Pop method removes an item from the stack.
std::cout << stack->Pop() << std::endl;
PrintItems(stack);
return 0;
}
/*
This code example produces the following output:
3
3 2 1
3
2 1
*/
Definition: algorithms.h:10
Definition: db_command.h:9
Template Parameters
TElement type.

Member Typedef Documentation

◆ IEnumerablePtr

template<typename T >
typedef SharedPtr<IEnumerable<T> > System::Collections::Generic::Stack< T >::IEnumerablePtr

Collection containing elements of same type.

◆ IEnumeratorPtr

template<typename T >
typedef SharedPtr<IEnumerator<T> > System::Collections::Generic::Stack< T >::IEnumeratorPtr

Enumerator type.

◆ queueIt_t

template<typename T >
typedef stack_t::reverse_iterator System::Collections::Generic::Stack< T >::queueIt_t
protected

Iterator type.

◆ stack_t

template<typename T >
typedef std::list<T, ASPOSE_COLLECTION_ALLOCATOR_TYPE> System::Collections::Generic::Stack< T >::stack_t

Underlying data type.

◆ ThisPtr

template<typename T >
typedef SharedPtr<Stack<T> > System::Collections::Generic::Stack< T >::ThisPtr
protected

Pointer type.

◆ ValueType

template<typename T >
typedef T System::Collections::Generic::Stack< T >::ValueType

Value type.

Constructor & Destructor Documentation

◆ Stack() [1/3]

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

Constructs empty stack.

◆ Stack() [2/3]

template<typename T >
System::Collections::Generic::Stack< T >::Stack ( int  capacity)
inline

Constructs empty stack.

Parameters
capacityNumber of elements to reserve; ignored.
Exceptions
ArgumentOutOfRangeExceptionif capacity is less than zero.

◆ Stack() [3/3]

template<typename T >
System::Collections::Generic::Stack< T >::Stack ( IEnumerablePtr  collection)
inline

Copy constructor.

Parameters
collectionCollection to copy elements from.
Exceptions
ArgumentNullExceptionif collection is nullptr.

◆ ~Stack()

template<typename T >
System::Collections::Generic::Stack< T >::~Stack ( )
overrideprotecteddefault

Destructor.

Member Function Documentation

◆ AddRange()

template<typename T >
void System::Collections::Generic::Stack< T >::AddRange ( IEnumerablePtr  collection)
inline

Puts elements into stack.

Parameters
collectionContainer of elements to push into stack.
Exceptions
ArgumentNullExceptionif collection is nullptr.

◆ Clear()

template<typename T >
virtual void System::Collections::Generic::Stack< T >::Clear ( )
inlinevirtual

Deletes all elements from stack.

◆ Contains()

template<typename T >
virtual bool System::Collections::Generic::Stack< T >::Contains ( const T &  item) const
inlinevirtual

Checks if specific item is present in container; uses operator == for comparison.

Parameters
itemItem to look for.
Returns
True if item is found, false otherwise.

◆ data() [1/2]

template<typename T >
stack_t& System::Collections::Generic::Stack< T >::data ( )
inline

Internal data structure accessor.

Returns
Reference to internal data structure.

◆ data() [2/2]

template<typename T >
const stack_t& System::Collections::Generic::Stack< T >::data ( ) const
inline

Internal data structure accessor.

Returns
Const reference to internal data structure.

◆ get_Count()

template<typename T >
virtual int System::Collections::Generic::Stack< T >::get_Count ( ) const
inlinevirtual

Gets number of elements in stack.

Returns
Actual elements count.

◆ GetEnumerator()

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

Gets enumerator to iterate through current stack.

Returns
Newly created enumerator to iterate through current stack.

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

◆ Peek()

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

Gets element from stack top, but keeps it in stack.

Returns
Top element of the stack.

◆ Pop()

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

Gets element from top of the stack.

Returns
Popped element.

◆ Push()

template<typename T >
void System::Collections::Generic::Stack< T >::Push ( const T &  item)
inline

Puts element of top of the stack.

Parameters
itemElement to push into stack.

◆ ToArray()

template<typename T >
virtual ArrayPtr<T> System::Collections::Generic::Stack< T >::ToArray ( )
inlinevirtual

Converts stack to array.

Returns
Newly created element with copies of all elements in stack.

Member Data Documentation

◆ m_data

template<typename T >
stack_t System::Collections::Generic::Stack< T >::m_data
protected

Underlying data structure.