Référence de la classe Castor::list

Fonctions d'aide pour std::list. Plus de détails...

Liste de tous les membres

Fonctions membres publiques
template<class T >
std::list< T >::iterator	find (std::list< T > const &p_list, T const &tKey)
	Cherche un élément dans une liste et retourne son itérateur.
template<class T >
std::list< T >::reverse_iterator	rfind (std::list< T > &p_list, T const &tKey)
	Cherche un élément dans une liste et retourne son itérateur inversé.
template<class T >
std::list< T > ::const_reverse_iterator	rfind (std::list< T > const &p_list, T const &tKey)
	Cherche un élément dans une liste et retourne son itérateur inversé.
Fonctions membres publiques statiques
template<typename T >
static bool	has (std::list< T > const &p_list, T const &p_tValue)
	Dit si la liste contient l'élément donné.
template<typename T >
static T *	get_or_null (std::list< T * > const &p_list, const std::size_t p_uiIndex)
	Dit si la liste contient l'élément donné.
template<typename T >
static bool	erase_at (std::list< T > &p_list, T const &p_tKey)
	Efface la valeur donnée de la liste.
template<typename T >
static bool	erase_at (std::list< T > &p_list, std::size_t p_uiIndex, T &p_tResult)
	Efface la valeur à l'index donné de la liste.
template<typename T >
static bool	erase_first (std::list< T > &p_list, T &p_tResult)
	Efface la première valeur de la liste.
template<typename T >
static bool	erase_last (std::list< T > &p_list, T &p_tResult)
	Efface la dernière valeur de la liste.
template<typename T >
static bool	delete_at (std::list< T * > &p_list, T *p_pKey)
	Efface et désalloue la valeur donnée de la liste.
template<typename T >
static bool	delete_at (std::list< T * > &p_list, std::size_t p_uiIndex)
	Efface et désalloue la valeur à l'index donné de la liste.
template<typename T >
static bool	delete_first (std::list< T * > &p_list)
	Efface et désalloue la première valeur de la liste.
template<typename T >
static bool	delete_last (std::list< T * > &p_list)
	Efface et désalloue la dernière valeur de la liste.

---

Description détaillée

Fonctions d'aide pour std::list.

Auteur:

Sylvain DOREMUS

---

Documentation des fonctions membres

template<typename T >

static bool Castor::list::delete_at	(	std::list< T * > &	p_list,
		T *	p_pKey
	)			[inline, static]

Efface et désalloue la valeur donnée de la liste.

Remarques:

Utilise list::erase_at

Paramètres:

[in]	p_list	La liste
[in]	p_pKey	La valeur à rechercher

Renvoie:

true si la valeur a été enlevée, false sinon

Voici le graphe d'appel pour cette fonction :

template<typename T >

static bool Castor::list::delete_at	(	std::list< T * > &	p_list,
		std::size_t	p_uiIndex
	)			[inline, static]

Efface et désalloue la valeur à l'index donné de la liste.

Remarques:

Uses list::erase_at

Paramètres:

[in]	p_list	La liste
[in]	p_uiIndex	L'index de la valeur

Renvoie:

true si la valeur a été enlevée, false sinon

Voici le graphe d'appel pour cette fonction :

template<typename T >

static bool Castor::list::delete_first

(

std::list< T * > &

p_list

)

[inline, static]

Efface et désalloue la première valeur de la liste.

Remarques:

Uses list::delete_at

Paramètres:

[in]

p_list

La liste

Renvoie:

true si la valeur a été enlevée, false sinon

Voici le graphe d'appel pour cette fonction :

template<typename T >

static bool Castor::list::delete_last

(

std::list< T * > &

p_list

)

[inline, static]

Efface et désalloue la dernière valeur de la liste.

Remarques:

Uses list::delete_at

Paramètres:

[in]

p_list

La liste

Renvoie:

true si la valeur a été enlevée, false sinon

Voici le graphe d'appel pour cette fonction :

template<typename T >

static bool Castor::list::erase_at	(	std::list< T > &	p_list,
		std::size_t	p_uiIndex,
		T &	p_tResult
	)			[inline, static]

Efface la valeur à l'index donné de la liste.

Paramètres:

[in]	p_list	La liste
[in]	p_uiIndex	L'index de la valeur
[out]	p_tResult	Reçoit la valeur enlevée de la liste

Renvoie:

true si la valeur a été enlevée, false sinon

template<typename T >

static bool Castor::list::erase_at	(	std::list< T > &	p_list,
		T const &	p_tKey
	)			[inline, static]

Efface la valeur donnée de la liste.

Remarques:

Utilise std::remove

Paramètres:

[in]	p_list	La liste
[in]	p_tKey	La valeur à rechercher

Renvoie:

true si la valeur a été enlevée, false sinon

Voici le graphe d'appel pour cette fonction :

template<typename T >

static bool Castor::list::erase_first	(	std::list< T > &	p_list,
		T &	p_tResult
	)			[inline, static]

Efface la première valeur de la liste.

Paramètres:

[in]	p_list	La liste
[out]	p_tResult	Reçoit la valeur enlevée de la liste

Renvoie:

true si la valeur a été enlevée, false sinon

Voici le graphe d'appel pour cette fonction :

template<typename T >

static bool Castor::list::erase_last	(	std::list< T > &	p_list,
		T &	p_tResult
	)			[inline, static]

Efface la dernière valeur de la liste.

Paramètres:

[in]	p_list	La liste
[out]	p_tResult	Reçoit la valeur enlevée de la liste

Renvoie:

true si la valeur a été enlevée, false sinon

Voici le graphe d'appel pour cette fonction :

template<class T >

std::list< T >::iterator Castor::list::find	(	std::list< T > const &	p_list,
		T const &	tKey
	)			[inline]

Cherche un élément dans une liste et retourne son itérateur.

Paramètres:

[in]	p_list	La liste
[in]	tKey	La valeur

Renvoie:

Un itérateur sur la valeur trouvée, p_list.end() si non-trouvé

Voici le graphe d'appel pour cette fonction :

template<typename T >

static T* Castor::list::get_or_null	(	std::list< T * > const &	p_list,
		const std::size_t	p_uiIndex
	)			[inline, static]

Dit si la liste contient l'élément donné.

Paramètres:

[in]	p_list	La liste
[in]	p_uiIndex	L'index de la valeur

Renvoie:

Un pointeur sur la valeur trouvée, nullptr si non-trouvée

template<typename T >

static bool Castor::list::has	(	std::list< T > const &	p_list,
		T const &	p_tValue
	)			[inline, static]

Dit si la liste contient l'élément donné.

Remarques:

Utilise std::find

Paramètres:

[in]	p_list	La liste
[in]	p_tValue	La valeur à rechercher

Renvoie:

true si p_tValue est dans p_list, false sinon

template<class T >

std::list< T >::const_reverse_iterator Castor::list::rfind	(	std::list< T > const &	p_list,
		T const &	tKey
	)			[inline]

Cherche un élément dans une liste et retourne son itérateur inversé.

Paramètres:

[in]	p_list	La liste
[in]	tKey	La valeur

Renvoie:

Un itérateur sur la valeur trouvée, p_list.rend() si non-trouvé

Voici le graphe d'appel pour cette fonction :

template<class T >

std::list< T >::reverse_iterator Castor::list::rfind	(	std::list< T > &	p_list,
		T const &	tKey
	)			[inline]

Cherche un élément dans une liste et retourne son itérateur inversé.

Paramètres:

[in]	p_list	La liste
[in]	tKey	La valeur

Renvoie:

Un itérateur sur la valeur trouvée, p_list.rend() si non-trouvé

Voici le graphe d'appel pour cette fonction :

---

La documentation de cette classe a été générée à partir du fichier suivant :

• include/CastorUtils/List.hpp