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

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

Liste de tous les membres

Fonctions membres publiques statiques
template<typename T , typename U >
static bool	has (std::map< T, U > const &p_map, T const &p_key)
	Dit si le map contient un élément à la clef donnée.
template<typename T , typename U >
static U *	find_or_null (std::map< T, U * > const &p_map, T const &p_key)
	Récupère la valeur à la clef donnée.
template<typename T , typename U >
static U	find_or_null (std::map< T, U > const &p_map, T const &p_key)
	Donne l'élément dans le map donné correspondant à la clef donnée.
template<typename T , typename U >
static bool	erase_at (std::map< T, U > &p_map, T const &p_key, U &p_tResult)
	Enlève l'élément à la clef donnée, ne le désalloue pas.
template<typename T , typename U >
static void	erase_at (std::map< T, U > &p_map, typename std::map< T, U >::iterator &p_where)
	Efface la valeur à l'index donné du map.
template<typename T , typename U >
static bool	erase_first (std::map< T, U > &p_map, U &p_tResult)
	Efface la première valeur du map.
template<typename T , typename U >
static bool	erase_last (std::map< T, U > &p_map, U &p_tResult)
	Efface la dernière valeur du map.
template<typename T , typename U >
static bool	delete_at (std::map< T, U * > &p_map, T const &p_tKey)
	Efface et désalloue la valeur donnée du map.
template<typename T , typename U >
static bool	delete_first (std::map< T, U * > &p_map)
	Efface et désalloue la première valeur du map.
template<typename T , typename U >
static bool	delete_last (std::map< T, U * > &p_map)
	Efface et désalloue la dernière valeur du map.
template<typename T , typename U >
static std::map< T, U >	intersects (std::map< T, U > const &p_mapA, std::map< T, U > const &p_mapB)
	Crée et retourne l'intersection entre 2 maps.

---

Description détaillée

Fonctions d'aide pour std::map.

Auteur:

Sylvain DOREMUS

---

Documentation des fonctions membres

template<typename T , typename U >

static bool Castor::map::delete_at	(	std::map< T, U * > &	p_map,
		T const &	p_tKey
	)			[inline, static]

Efface et désalloue la valeur donnée du map.

Remarques:

Utilise map::erase_at
La valeur est désallouée seulement si elle a été effacée

Paramètres:

[in]	p_map	Le map
[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 , typename U >

static bool Castor::map::delete_first

(

std::map< T, U * > &

p_map

)

[inline, static]

Efface et désalloue la première valeur du map.

Remarques:

Uses map::erase_first
La valeur est désallouée seulement si elle a été effacée

Paramètres:

[in]

p_map

Le map

Renvoie:

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

Voici le graphe d'appel pour cette fonction :

template<typename T , typename U >

static bool Castor::map::delete_last

(

std::map< T, U * > &

p_map

)

[inline, static]

Efface et désalloue la dernière valeur du map.

Remarques:

Uses map::erase_last
La valeur est désallouée seulement si elle a été effacée

Paramètres:

[in]

p_map

Le map

Renvoie:

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

Voici le graphe d'appel pour cette fonction :

template<typename T , typename U >

static bool Castor::map::erase_at	(	std::map< T, U > &	p_map,
		T const &	p_key,
		U &	p_tResult
	)			[inline, static]

Enlève l'élément à la clef donnée, ne le désalloue pas.

Paramètres:

[in]	p_map	Le map à modifier
[in]	p_key	La clef de l'élément à enlever
[out]	p_tResult	Reçoit la valeur enlevée du map

Renvoie:

true si l'élément était dans le map

Voici le graphe d'appel pour cette fonction :

template<typename T , typename U >

static void Castor::map::erase_at	(	std::map< T, U > &	p_map,
		typename std::map< T, U >::iterator &	p_where
	)			[inline, static]

Efface la valeur à l'index donné du map.

Paramètres:

[in]	p_map	Le map
[in]	p_where	L'itérateur sur la valeur

template<typename T , typename U >

static bool Castor::map::erase_first	(	std::map< T, U > &	p_map,
		U &	p_tResult
	)			[inline, static]

Efface la première valeur du map.

Paramètres:

[in]	p_map	Le map
[out]	p_tResult	Reçoit la valeur enlevée du map

Renvoie:

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

Voici le graphe d'appel pour cette fonction :

template<typename T , typename U >

static bool Castor::map::erase_last	(	std::map< T, U > &	p_map,
		U &	p_tResult
	)			[inline, static]

Efface la dernière valeur du map.

Paramètres:

[in]	p_map	Le map
[out]	p_tResult	Reçoit la valeur enlevée du map

Renvoie:

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

Voici le graphe d'appel pour cette fonction :

template<typename T , typename U >

static U* Castor::map::find_or_null	(	std::map< T, U * > const &	p_map,
		T const &	p_key
	)			[inline, static]

Récupère la valeur à la clef donnée.

Paramètres:

[in]	p_map	Le map
[in]	p_key	La clef de la valeur

Renvoie:

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

template<typename T , typename U >

static U Castor::map::find_or_null	(	std::map< T, U > const &	p_map,
		T const &	p_key
	)			[inline, static]

Donne l'élément dans le map donné correspondant à la clef donnée.

Paramètres:

[in]	p_map	Le map contenant des éléments
[in]	p_key	L'élément à trouver

Renvoie:

L'élément trouvé, valeur par défaut si non trouvé

template<typename T , typename U >

static bool Castor::map::has	(	std::map< T, U > const &	p_map,
		T const &	p_key
	)			[inline, static]

Dit si le map contient un élément à la clef donnée.

Paramètres:

[in]	p_map	Le map
[in]	p_key	La valeur à rechercher

Renvoie:

true si p_tValue est dans p_map, false sinon

template<typename T , typename U >

static std::map< T, U > Castor::map::intersects	(	std::map< T, U > const &	p_mapA,
		std::map< T, U > const &	p_mapB
	)			[inline, static]

Crée et retourne l'intersection entre 2 maps.

Remarques:

L'intersection est l'ensemble d'éléments communs aux 2 maps

Paramètres:

[in]

p_mapA,p_mapB

Les maps

Renvoie:

L'intersection, si elle existe

---

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

• include/CastorUtils/Map.hpp