Référence de la classe Castor::Policy< UbPixel > (modèle)

Politique pour les UbPixel. Plus de détails...

Liste de tous les membres

Fonctions membres publiques statiques
static value_type	zero ()
static value_type	unit ()
static void	init (value_type &p_a)
	Initialise La variable donnée à la valeur neutre.
static bool	is_null (value_type const &p_a)
	Teste si le param donné est égal à la valeur neutre.
static value_type	negate (value_type const &p_a)
static value_type	ass_negate (value_type &p_a)
static value_type	stick (value_type &p_a)
	Si un Pixel est un type flottant, arrondit le paramètre, sinon ne fait rien.
template<typename Ty >
static value_type	convert (Ty const &p_value)
	Convertit un param d'un type donné vers un Pixel template de cette classe.
template<typename Ty >
static bool	equals (value_type const &p_a, Ty const &p_b)
	Teste l'égalité entre 2 params de type différent, utilise std::numeric_limits::epsilon pour faire le test.
template<typename Ty >
static value_type	add (value_type const &p_a, Ty const &p_b)
	Additionne 2 param de type différent, retourne le résultat.
template<typename Ty >
static value_type	substract (value_type const &p_a, Ty const &p_b)
	Soustrait 2 param de type différent, retourne le résultat.
template<typename Ty >
static value_type	multiply (value_type const &p_a, Ty const &p_b)
	Multiplie 2 param de type différent, retourne le résultat.
template<typename Ty >
static value_type	divide (value_type const &p_a, Ty const &p_b)
	Divise 2 param de type différent, retourne le résultat.
template<typename Ty >
static value_type	ass_add (value_type &p_a, Ty const &p_b)
	Additionne 2 param de type différent, retourne le résultat.
template<typename Ty >
static value_type	ass_substract (value_type &p_a, Ty const &p_b)
	Soustrait 2 param de type différent, retourne le résultat.
template<typename Ty >
static value_type	ass_multiply (value_type &p_a, Ty const &p_b)
	Multiplie 2 param de type différent, retourne le résultat.
template<typename Ty >
static value_type	ass_divide (value_type &p_a, Ty const &p_b)
	Divise 2 param de type différent, retourne le résultat.
template<typename Ty >
static value_type	assign (value_type &p_a, Ty const &p_b)
	Convertit le second param et affecte le résultat au premier.

---

Description détaillée

template<>
class Castor::Policy< UbPixel >

Politique pour les UbPixel.

Auteur:

Sylvain DOREMUS

Version:

0.6.1.0

Date:

19/10/2011

---

Documentation des fonctions membres

template<typename Ty >

static value_type Castor::Policy< UbPixel >::add	(	value_type const &	p_a,
		Ty const &	p_b
	)			[inline, static]

Additionne 2 param de type différent, retourne le résultat.

Paramètres:

[in]	p_a	Le premier param
[in]	p_b	Le second param, converti dans un Pixel de p_a avant l'addition

Renvoie:

Le résultat de l'addition

template<typename Ty >

static value_type Castor::Policy< UbPixel >::ass_add	(	value_type &	p_a,
		Ty const &	p_b
	)			[inline, static]

Additionne 2 param de type différent, retourne le résultat.

Remarques:

Le premier param reçoit le résultat

Paramètres:

[in,out]	p_a	Le premier param, reçoit le résultat
[in]	p_b	Le second param, converti dans un Pixel de p_a avant l'addition

Renvoie:

La référence sur le premier param

Voici le graphe d'appel pour cette fonction :

template<typename Ty >

static value_type Castor::Policy< UbPixel >::ass_divide	(	value_type &	p_a,
		Ty const &	p_b
	)			[inline, static]

Divise 2 param de type différent, retourne le résultat.

Remarques:

Le premier param reçoit le résultat

Paramètres:

[in,out]	p_a	Le premier param, reçoit le résultat
[in]	p_b	Le second param, converti dans un Pixel de p_a avant la division

Renvoie:

La référence sur le premier param

Voici le graphe d'appel pour cette fonction :

template<typename Ty >

static value_type Castor::Policy< UbPixel >::ass_multiply	(	value_type &	p_a,
		Ty const &	p_b
	)			[inline, static]

Multiplie 2 param de type différent, retourne le résultat.

Remarques:

Le premier param reçoit le résultat

Paramètres:

[in,out]	p_a	Le premier param, reçoit le résultat
[in]	p_b	Le second param, converti dans un Pixel de p_a avant la multiplication

Renvoie:

La référence sur le premier param

Voici le graphe d'appel pour cette fonction :

static value_type Castor::Policy< UbPixel >::ass_negate

(

value_type &

p_a

)

[inline, static]

Paramètres:

[in,out]

p_a

La valeur à négativer, reçoit la valeur négativée

Renvoie:

Référence sur le paramètre

Voici le graphe d'appel pour cette fonction :

template<typename Ty >

static value_type Castor::Policy< UbPixel >::ass_substract	(	value_type &	p_a,
		Ty const &	p_b
	)			[inline, static]

Soustrait 2 param de type différent, retourne le résultat.

Remarques:

Le premier param reçoit le résultat

Paramètres:

[in,out]	p_a	Le premier param, reçoit le résultat
[in]	p_b	Le second param, converti dans un Pixel de p_a avant la soustraction

Renvoie:

La référence sur le premier param

Voici le graphe d'appel pour cette fonction :

template<typename Ty >

static value_type Castor::Policy< UbPixel >::assign	(	value_type &	p_a,
		Ty const &	p_b
	)			[inline, static]

Convertit le second param et affecte le résultat au premier.

Paramètres:

[in,out]	p_a	Le premier param, reçoit le second param converti
[in]	p_b	Le second param

Renvoie:

La référence sur le premier param

template<typename Ty >

static value_type Castor::Policy< UbPixel >::convert

(

Ty const &

p_value

)

[inline, static]

Convertit un param d'un type donné vers un Pixel template de cette classe.

Paramètres:

[in]

p_value

La valeur à convertir

Renvoie:

La valeur convertie (static_cast)

template<typename Ty >

static value_type Castor::Policy< UbPixel >::divide	(	value_type const &	p_a,
		Ty const &	p_b
	)			[inline, static]

Divise 2 param de type différent, retourne le résultat.

Paramètres:

[in]	p_a	Le premier param
[in]	p_b	Le second param, converti dans un Pixel de p_a avant la division

Renvoie:

Le résultat de la division

template<typename Ty >

static bool Castor::Policy< UbPixel >::equals	(	value_type const &	p_a,
		Ty const &	p_b
	)			[inline, static]

Teste l'égalité entre 2 params de type différent, utilise std::numeric_limits::epsilon pour faire le test.

Paramètres:

[in]	p_a	Le premier param, dont un Pixel est pris comme argument template de std::numeric_limits
[in]	p_b	Le second param, converti dans un Pixel de \ p_a avant la comparaison

Renvoie:

Le résultat de la comparaison

static void Castor::Policy< UbPixel >::init

(

value_type &

p_a

)

[inline, static]

Initialise La variable donnée à la valeur neutre.

Paramètres:

[in]

p_a

La variable à initialiser

Voici le graphe d'appel pour cette fonction :

static bool Castor::Policy< UbPixel >::is_null

(

value_type const &

p_a

)

[inline, static]

Teste si le param donné est égal à la valeur neutre.

Paramètres:

[in]

p_a

La valeur à tester

Renvoie:

Le résultat du test

Voici le graphe d'appel pour cette fonction :

template<typename Ty >

static value_type Castor::Policy< UbPixel >::multiply	(	value_type const &	p_a,
		Ty const &	p_b
	)			[inline, static]

Multiplie 2 param de type différent, retourne le résultat.

Paramètres:

[in]	p_a	Le premier param
[in]	p_b	Le second param, converti dans un Pixel de p_a avant la multiplication

Renvoie:

Le résultat de la multiplication

static value_type Castor::Policy< UbPixel >::negate

(

value_type const &

p_a

)

[inline, static]

Paramètres:

[in]

p_a

La valeur à négativer

Renvoie:

La valeur négativée du param (opposé de la valeur, relativement à la valeur neutre)

static value_type Castor::Policy< UbPixel >::stick

(

value_type &

p_a

)

[inline, static]

Si un Pixel est un type flottant, arrondit le paramètre, sinon ne fait rien.

Paramètres:

[in]

p_a

La valeur à arrondir

template<typename Ty >

static value_type Castor::Policy< UbPixel >::substract	(	value_type const &	p_a,
		Ty const &	p_b
	)			[inline, static]

Soustrait 2 param de type différent, retourne le résultat.

Paramètres:

[in]	p_a	Le premier param
[in]	p_b	Le second param, converti dans un Pixel de p_a avant la soustraction

Renvoie:

Le résultat de la soustraction

static value_type Castor::Policy< UbPixel >::unit

(

)

[inline, static]

Renvoie:

La valeur unitaire pour un Pixel

static value_type Castor::Policy< UbPixel >::zero

(

)

[inline, static]

Renvoie:

La valeur neutre pour un Pixel

---

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

• include/CastorUtils/Pixel.hpp