System::Array< Ty, Ay > Class Template Reference

Dynamic array template class.

#include <Container.hpp>

Inheritance diagram for System::Array< Ty, Ay >:

List of all members.

Public Member Functions
size_type	size () const
	Returns the size of the array.
size_type	capacity () const
	Returns the capacity of the array.
iterator	begin ()
	Returns an iterator at the beginning of the array.
const_iterator	begin () const
	Returns a constant iterator at the beginning of the array.
reverse_iterator	rbegin ()
	Returns a reverse iterator at the end of the array.
const_reverse_iterator	rbegin () const
	Returns a constant reverse iterator at the end of the array.
iterator	end ()
	Returns an iterator at the end of the array.
const_iterator	end () const
	Returns a constant iterator at the end of the array.
reverse_iterator	rend ()
	Returns a reverse iterator at the beginning of the array.
reference	front ()
	Returns a reference to the first element of the array.
const_reference	front () const
	Returns a constant reference to the first element of the array.
reference	back ()
	Retruns a reference to the last element of the array.
const_reference	back () const
	Returns a constant reference to the last element of the array.
reference	operator[] (size_type Index)
	Returns a reference to the element at the specified index.
const_reference	operator[] (size_type Index) const
	Returns a constant reference to the element at the specified index.
VOID	push_back (const_reference Value)
	Adds an element with the specified value at the back of the array.
VOID	pop_back ()
	Erases the last element of the array.
template<class Func>
VOID	transform (Func Function)
	Transform every element in the array using the specified function.
template<class ValTy>
iterator	find (CONST ValTy &Value)
	Finds an element with the specified Value within the array.
template<class ValTy>
const_reference	find (CONST ValTy &Value) const
	Finds an element with the specified Value within the array.
template<class InputIterator, class Type>
InputIterator	find (InputIterator First, InputIterator Last, CONST Type &Value)
	Finds an element with the specified Value within the array.
template<class PredTy>
iterator	findif (PredTy Predicate)
	Finds an element that when passed to the predicate function returns true.
template<class PredTy>
const_iterator	findif (PredTy Predicate) const
	Finds an element that when passed to the predicate function returns true.
template<class InputIterator, class PredTy>
InputIterator	findif (InputIterator First, InputIterator Last, PredTy Predicate)
	Finds an element that when passed to the predicate function returns true.
VOID	resize (size_type Count)
	Resizes the array to the specified count.
VOID	resize (size_type Count, const_reference Value)
	Resizes the array to the specified count, and fills the new elements with the specified value.
iterator	insert (iterator Where, const_reference Value)
	Inserts an element with the specified value at the specified position.
VOID	insert (iterator Where, size_type Count, const_reference Value)
	Inserts a number of elements with the specified value at the specified position.
template<class InputIterator>
iterator	insert (iterator Where, InputIterator First, InputIterator Last)
	Inserts a group of elements at the specified position.
VOID	assign (size_type Count, const_reference Value)
	Assigns the array with a number of elements initialized with the specified value.
template<class InputIterator>
VOID	assign (InputIterator First, InputIterator Last)
	Assigns the array with a number of elements.
template<class Func>
Func	foreach (Func Function)
	Performs an operation on each element in the array.
template<class InputIterator, class Func>
Func	foreach (InputIterator First, InputIterator Last, Func Function)
	Performs an operation on each element in the array.
iterator	erase (iterator Where)
	Erases an element at the specified position.
iterator	erase (iterator First, iterator Last)
	Erases all elements between the two specified iterators.
VOID	clear ()
	Clears the entire array of all elements.
BOOL	empty ()
	Returns whether or not the array is empty.

template<class Ty, class Ay>
class System::Array< Ty, Ay >

---

Member Function Documentation

template<class Ty, class Ay>

size_type System::Array< Ty, Ay >::size

(

)

const [inline]

Returns:

The size of the array.

Reimplemented in System::CharacterArray< CharTy >.

template<class Ty, class Ay>

size_type System::Array< Ty, Ay >::capacity

(

)

const [inline]

Returns:

The capacity of the array.

template<class Ty, class Ay>

iterator System::Array< Ty, Ay >::begin

(

)

[inline]

Returns:

An iterator at the beginning of the array.

template<class Ty, class Ay>

const_iterator System::Array< Ty, Ay >::begin

(

)

const [inline]

Returns:

A constant iterator at the beginning of the array.

template<class Ty, class Ay>

reverse_iterator System::Array< Ty, Ay >::rbegin

(

)

[inline]

Returns:

A reverse iterator at the end of the array.

Reimplemented in System::CharacterArray< CharTy >.

template<class Ty, class Ay>

const_reverse_iterator System::Array< Ty, Ay >::rbegin

(

)

const [inline]

Returns:

A constant reverse iterator at the end of the array.

Reimplemented in System::CharacterArray< CharTy >.

template<class Ty, class Ay>

iterator System::Array< Ty, Ay >::end

(

)

[inline]

Returns:

An iterator at the end of the array.

Reimplemented in System::CharacterArray< CharTy >.

template<class Ty, class Ay>

const_reverse_iterator System::Array< Ty, Ay >::end

(

)

const [inline]

Returns a constant reverse iterator at the beginning of the array.

Returns:

A constant iterator at the end of the array.

A constant reverse iterator at the beginning of the array.

Reimplemented in System::CharacterArray< CharTy >.

template<class Ty, class Ay>

reverse_iterator System::Array< Ty, Ay >::rend

(

)

[inline]

Returns:

A reverse iterator at the beginning of the array.

template<class Ty, class Ay>

reference System::Array< Ty, Ay >::front

(

)

[inline]

Returns:

A reference to the first element of the array.

template<class Ty, class Ay>

const_reference System::Array< Ty, Ay >::front

(

)

const [inline]

Returns:

A constant reference to the first element of the array.

template<class Ty, class Ay>

reference System::Array< Ty, Ay >::back

(

)

[inline]

Returns:

A reference to the last element of the array.

Reimplemented in System::CharacterArray< CharTy >.

template<class Ty, class Ay>

const_reference System::Array< Ty, Ay >::back

(

)

const [inline]

Returns:

A constant reference to the last element of the array.

Reimplemented in System::CharacterArray< CharTy >.

template<class Ty, class Ay>

reference System::Array< Ty, Ay >::operator[]

(

size_type

Index

)

[inline]

Parameters:

Index

The index of the element to return a reference of.

Returns:

A reference of the element at the specified index.

template<class Ty, class Ay>

const_reference System::Array< Ty, Ay >::operator[]

(

size_type

index

)

const [inline]

Parameters:

Index

The index of the element to return a constant reference of.

Returns:

A constant reference of the element at the specified index.

template<class Ty, class Ay>

VOID System::Array< Ty, Ay >::push_back

(

const_reference

Value

)

[inline]

Parameters:

Value

The value of the element to add.

template<class Ty, class Ay>

template<class Func>

VOID System::Array< Ty, Ay >::transform

(

Func

Function

)

[inline]

Parameters:

Function

The function used to transform an element.

Reimplemented in System::CharacterArray< CharTy >.

template<class Ty, class Ay>

template<class ValTy>

iterator System::Array< Ty, Ay >::find

(

CONST ValTy &

Value

)

[inline]

Parameters:

Value

The value of the element to search for.

Returns:

An iterator at a matching element, or the end of the array if none are found.

Reimplemented in System::CharacterArray< CharTy >.

template<class Ty, class Ay>

template<class ValTy>

const_iterator System::Array< Ty, Ay >::find

(

CONST ValTy &

Value

)

const [inline]

Parameters:

Value

The value of the element to search for.

Returns:

A constant iterator at a matching element, or the end of the array if none are found.

Reimplemented in System::CharacterArray< CharTy >.

template<class Ty, class Ay>

template<class InputIterator, class Type>

InputIterator System::Array< Ty, Ay >::find	(	InputIterator	First,
		InputIterator	Last,
		CONST Type &	Value
	)			[inline]

Parameters:

	First	The element to start the search at.
	Last	The element to end the search at.
	Value	The value of the element to search for.

Returns:

An iterator at a matching element, or at the last element of the search if none are found.

template<class Ty, class Ay>

template<class PredTy>

iterator System::Array< Ty, Ay >::findif

(

PredTy

Predicate

)

[inline]

Parameters:

Predicate

The function to use to search for an element.

Returns:

An iterator at a matching element, or the end of the array if none are found.

Reimplemented in System::CharacterArray< CharTy >.

template<class Ty, class Ay>

template<class PredTy>

const_iterator System::Array< Ty, Ay >::findif

(

PredTy

Predicate

)

const [inline]

Parameters:

Predicate

The function to use to search for an element.

Returns:

A constant iterator at a matching element, or the end of the array if none are found.

Reimplemented in System::CharacterArray< CharTy >.

template<class Ty, class Ay>

template<class InputIterator, class PredTy>

InputIterator System::Array< Ty, Ay >::findif	(	InputIterator	First,
		InputIterator	Last,
		PredTy	Predicate
	)			[inline]

Parameters:

	First	The element to start the search at.
	Last	The element to end the search at.
	Predicate	The function to use to search for an element.

Returns:

An iterator at a matching element, or at the last element of the search if none are found.

template<class Ty, class Ay>

VOID System::Array< Ty, Ay >::resize

(

size_type

Count

)

[inline]

Parameters:

Count

The new size of the array.

template<class Ty, class Ay>

VOID System::Array< Ty, Ay >::resize	(	size_type	Count,
		const_reference	Value
	)			[inline]

Parameters:

	Count	The new size of the array.
	Value	The value to initialize the new elements with.

template<class Ty, class Ay>

iterator System::Array< Ty, Ay >::insert	(	iterator	Where,
		const_reference	Value
	)			[inline]

Parameters:

	Where	An iterator pointing to the element at which to perform the insertion.
	Value	A value to initialize the new element with.

Returns:

An iterator at the new element.

template<class Ty, class Ay>

iterator System::Array< Ty, Ay >::insert	(	iterator	Where,
		size_type	Count,
		const_reference	Value
	)			[inline]

Parameters:

	Where	An iterator pointing to the element at which to perform the insertion.
	Count	The number of elements to insert.
	Value	A value to initialize the new elements with.

Returns:

An iterator at the new elements.

template<class Ty, class Ay>

template<class InputIterator>

iterator System::Array< Ty, Ay >::insert	(	iterator	Where,
		InputIterator	First,
		InputIterator	Last
	)			[inline]

Parameters:

	Where	An iterator pointing to the element at which to perform the insertion.
	First	An iterator pointing to the start of the input elements.
	Last	An iterator pointing to the end of the input elements.

Returns:

An iterator at the new elements.

Reimplemented in System::CharacterArray< CharTy >.

template<class Ty, class Ay>

VOID System::Array< Ty, Ay >::assign	(	size_type	Count,
		const_reference	Value
	)			[inline]

Parameters:

	Count	The number of elements to assign.
	Value	A value to initialize the new elements with.

template<class Ty, class Ay>

template<class InputIterator>

VOID System::Array< Ty, Ay >::assign	(	InputIterator	First,
		InputIterator	Last
	)			[inline]

Parameters:

	First	An iterator pointing to the start of the input elements.
	Last	An iterator pointing to the end of the input elements.

template<class Ty, class Ay>

template<class Func>

Func System::Array< Ty, Ay >::foreach

(

Func

Function

)

[inline]

Parameters:

Function

The function performing the operations on the elements.

Returns:

The specified function used to perform the operations.

template<class Ty, class Ay>

template<class InputIterator, class Func>

Func System::Array< Ty, Ay >::foreach	(	InputIterator	First,
		InputIterator	Last,
		Func	Function
	)			[inline]

Parameters:

	Fisrt	The element to start from.
	Last	The element to stop before.
	Function	The function performing the operations on the elements.

Returns:

The specified function used to perform the operations.

template<class Ty, class Ay>

iterator System::Array< Ty, Ay >::erase

(

iterator

Where

)

[inline]

Parameters:

Where

An iterator pointing to the element to erase.

Returns:

An iterator pointing to an element after the erased element.

Reimplemented in System::CharacterArray< CharTy >.

template<class Ty, class Ay>

iterator System::Array< Ty, Ay >::erase	(	iterator	First,
		iterator	Last
	)			[inline]

Parameters:

	First	The element to begin the removal at.
	Last	The element to end the removal at.

Returns:

An iterator pointing to an element after the last erased element.

Reimplemented in System::CharacterArray< CharTy >.

template<class Ty, class Ay>

BOOL System::Array< Ty, Ay >::empty

(

)

[inline]

Returns:

A boolean value indicating whether or not the array is empty.

Reimplemented in System::CharacterArray< CharTy >.

---

The documentation for this class was generated from the following file:

• Container.hpp

---