System::CharacterArray< CharTy > Class Template Reference

A character array based on array, which string manipulation functions.

#include <String.hpp>

Inheritance diagram for System::CharacterArray< CharTy >:

List of all members.

Public Member Functions
size_type	size () const
	Returns the size 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.
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 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.
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.
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.
size_type	length () const
	Returns the length of the array.
const_pointer	c_str () const
	Returns a pointer to the string buffer.
const_pointer	data () const
	Returns a pointer to the string buffer.

template<class CharTy>
class System::CharacterArray< CharTy >

---

Member Function Documentation

template<class CharTy>

size_type System::CharacterArray< CharTy >::size

(

)

const [inline]

Returns:

The size of the array.

Reimplemented from System::Array< CharTy >.

template<class CharTy>

reverse_iterator System::CharacterArray< CharTy >::rbegin

(

)

[inline]

Returns:

A reverse iterator at the end of the array.

Reimplemented from System::Array< CharTy >.

template<class CharTy>

const_reverse_iterator System::CharacterArray< CharTy >::rbegin

(

)

const [inline]

Returns:

A constant reverse iterator at the end of the array.

Reimplemented from System::Array< CharTy >.

template<class CharTy>

iterator System::CharacterArray< CharTy >::end

(

)

[inline]

Returns:

An iterator at the end of the array.

Reimplemented from System::Array< CharTy >.

template<class CharTy>

const_iterator System::CharacterArray< CharTy >::end

(

)

const [inline]

Returns:

A constant iterator at the end of the array.

Reimplemented from System::Array< CharTy >.

template<class CharTy>

reference System::CharacterArray< CharTy >::back

(

)

[inline]

Returns:

A reference to the last element of the array.

Reimplemented from System::Array< CharTy >.

template<class CharTy>

const_reference System::CharacterArray< CharTy >::back

(

)

const [inline]

Returns:

A constant reference to the last element of the array.

Reimplemented from System::Array< CharTy >.

template<class CharTy>

reference System::CharacterArray< CharTy >::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 CharTy>

const_reference System::CharacterArray< CharTy >::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 CharTy>

VOID System::CharacterArray< CharTy >::push_back

(

const_reference

Value

)

[inline]

Parameters:

Value

The value of the element to add.

template<class CharTy>

template<class Func>

VOID System::CharacterArray< CharTy >::transform

(

Func

Function

)

[inline]

Parameters:

Function

The function used to transform an element.

Reimplemented from System::Array< CharTy >.

template<class CharTy>

template<class ValTy>

iterator System::CharacterArray< CharTy >::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 from System::Array< CharTy >.

template<class CharTy>

template<class ValTy>

const_iterator System::CharacterArray< CharTy >::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 from System::Array< CharTy >.

template<class CharTy>

template<class PredTy>

iterator System::CharacterArray< CharTy >::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 from System::Array< CharTy >.

template<class CharTy>

template<class PredTy>

const_iterator System::CharacterArray< CharTy >::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 from System::Array< CharTy >.

template<class CharTy>

VOID System::CharacterArray< CharTy >::resize

(

size_type

Count

)

[inline]

Parameters:

Count

The new size of the array.

template<class CharTy>

VOID System::CharacterArray< CharTy >::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 CharTy>

iterator System::CharacterArray< CharTy >::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 CharTy>

iterator System::CharacterArray< CharTy >::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 CharTy>

template<class InputIterator>

iterator System::CharacterArray< CharTy >::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 from System::Array< CharTy >.

template<class CharTy>

VOID System::CharacterArray< CharTy >::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 CharTy>

iterator System::CharacterArray< CharTy >::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 from System::Array< CharTy >.

template<class CharTy>

iterator System::CharacterArray< CharTy >::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 from System::Array< CharTy >.

template<class CharTy>

BOOL System::CharacterArray< CharTy >::empty

(

)

[inline]

Returns:

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

Reimplemented from System::Array< CharTy >.

template<class CharTy>

size_type System::CharacterArray< CharTy >::length

(

)

const [inline]

Returns:

The length of the array.

template<class CharTy>

const_pointer System::CharacterArray< CharTy >::c_str

(

)

const [inline]

Returns:

A pointer to the string buffer.

template<class CharTy>

const_pointer System::CharacterArray< CharTy >::data

(

)

const [inline]

Returns:

A pointer to the string buffer.

---

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

• String.hpp

---