Référence de la classe Arcane::Real3

Classe gérant un vecteur de réel de dimension 3. Plus de détails...

#include <arcane/utils/Real3.h>

Graphe d'héritage de Arcane::Real3:

Graphe de collaboration de Arcane::Real3:

Fonctions membres publiques
constexpr __host__ __device__	Real3 ()
	Construit le vecteur nul.
constexpr __host__ __device__	Real3 (Real ax, Real ay, Real az)
	Construit le triplet (ax,ay,az)
	Real3 (const Real3 &f)=default
	Construit un triplet identique à f.
constexpr __host__ __device__	Real3 (const Real3POD &f)
	Construit un triplet identique à f.
constexpr __host__ __device__	Real3 (Real v)
	Construit l'instance avec le triplet (v,v,v).
constexpr __host__ __device__	Real3 (const Real2 &f)
	Construit un triplet identique à f.
Real3 &	operator= (const Real3 &f)=default
	Opérateur de recopie.
constexpr __host__ __device__ Real3 &	operator= (Real v)
	Affecte à l'instance le triplet (v,v,v).
constexpr __host__ __device__ Real3	copy () const
	Retourne une copie du triplet.
constexpr __host__ __device__ Real3 &	reset ()
	Réinitialise le triplet avec les constructeurs par défaut.
constexpr __host__ __device__ Real3 &	assign (Real ax, Real ay, Real az)
	Affecte à l'instance le triplet (ax,ay,az)
constexpr __host__ __device__ Real3 &	assign (Real3 f)
	Copie le triplet f.
__host__ __device__ Real3	absolute () const
	Valeur absolue composante par composante.
std::istream &	assign (std::istream &i)
	Lit un triplet sur le flot i Le triplet est lu sous la forme de trois valeur de type #value_type.
std::ostream &	print (std::ostream &o) const
	Ecrit le triplet sur le flot o lisible par un assign()
std::ostream &	printXyz (std::ostream &o) const
	Ecrit le triplet sur le flot o sous la forme (x,y,z)
constexpr __host__ __device__ Real3 &	add (Real3 b)
	Ajoute b au triplet.
constexpr __host__ __device__ Real3 &	sub (Real3 b)
	Soustrait b au triplet.
constexpr __host__ __device__ Real3 &	mul (Real3 b)
	Multiple chaque composante du triplet par la composant correspondant de b.
constexpr __host__ __device__ Real3 &	div (Real3 b)
	Divise chaque composante du triplet par la composant correspondant de b.
constexpr __host__ __device__ Real3 &	addSame (Real b)
	Ajoute b à chaque composante du triplet.
constexpr __host__ __device__ Real3 &	subSame (Real b)
	Soustrait b à chaque composante du triplet.
constexpr __host__ __device__ Real3 &	mulSame (Real b)
	Multiplie chaque composante du triplet par b.
constexpr __host__ __device__ Real3 &	divSame (Real b)
	Divise chaque composante du triplet par b.
constexpr __host__ __device__ Real3 &	operator+= (Real3 b)
	Ajoute b au triplet.
constexpr __host__ __device__ Real3 &	operator-= (Real3 b)
	Soustrait b au triplet.
constexpr __host__ __device__ Real3 &	operator*= (Real3 b)
	Multiple chaque composante du triplet par la composant correspondant de b.
constexpr __host__ __device__ void	operator*= (Real b)
	Multiple chaque composante du triplet par le réel b.
constexpr __host__ __device__ Real3 &	operator/= (Real3 b)
	Divise chaque composante du triplet par la composant correspondant de b.
constexpr __host__ __device__ void	operator/= (Real b)
	Divise chaque composante du triplet par le réel b.
constexpr __host__ __device__ Real3	operator+ (Real3 b) const
	Créé un triplet qui vaut ce triplet ajouté à b.
constexpr __host__ __device__ Real3	operator- (Real3 b) const
	Créé un triplet qui vaut b soustrait de ce triplet.
constexpr __host__ __device__ Real3	operator- () const
	Créé un triplet opposé au triplet actuel.
constexpr __host__ __device__ Real3	operator* (Real3 b) const
	Créé un triplet qui vaut ce triplet dont chaque composant a été multipliée par la composante correspondante de b.
constexpr __host__ __device__ Real3	operator/ (Real3 b) const
	Créé un triplet qui vaut ce triplet dont chaque composant a été divisée par la composante correspondante de b.
constexpr __host__ __device__ bool	operator== (Real3 b) const
	Compare composant pas composante l'instance courante à b.
constexpr __host__ __device__ bool	operator!= (Real3 b) const
	Compare deux triplets. Pour la notion d'égalité, voir operator==()
constexpr __host__ __device__ Real	squareNormL2 () const
	Retourne la norme L2 au carré du triplet \(x^2+y^2+z^2\).
__host__ __device__ Real	normL2 () const
	Retourne la norme L2 du triplet \(\sqrt{x^2+y^2+z^2}\).
constexpr __host__ __device__ Real	abs2 () const
	Retourne la norme au carré du triplet \(x^2+y^2+z^2\).
__host__ __device__ Real	abs () const
	Retourne la norme du triplet \(\sqrt{x^2+y^2+z^2}\).
constexpr __host__ __device__ bool	isNearlyZero () const
Real3 &	normalize ()
Fonctions membres publiques hérités de Arcane::Real3POD
__host__ __device__ Real	operator[] (Integer i) const
__host__ __device__ Real	operator() (Integer i) const
__host__ __device__ Real &	operator[] (Integer i)
__host__ __device__ Real &	operator() (Integer i)
__host__ __device__ void	setComponent (Integer i, Real value)
	Positionne la i-ème composante à value.

Fonctions membres publiques statiques
constexpr __host__ static __device__ Real3	null ()
constexpr __host__ static __device__ Real3	zero ()

Amis
constexpr __host__ __device__ Real3	operator* (Real sca, Real3 vec)
	Multiplication par un scalaire.
constexpr __host__ __device__ Real3	operator* (Real3 vec, Real sca)
	Multiplication par un scalaire.
constexpr __host__ __device__ Real3	operator/ (Real3 vec, Real sca)
	Division par un scalaire.
constexpr __host__ __device__ bool	operator< (Real3 v1, Real3 v2)
	Opérateur de comparaison.
std::ostream &	operator<< (std::ostream &o, Real3 t)
	Ecrit le triplet t sur le flot o.
std::istream &	operator>> (std::istream &i, Real3 &t)
	Lit le triplet t à partir du flot o.

Fonctions associées
(Notez que ce ne sont pas des fonctions membres)
template<typename Type >
std::istream &	operator>> (std::istream &i, BuiltInProxy< Type > &t)
	Lit le triplet t à partir du flot o.
std::ostream &	operator<< (std::ostream &o, Real3Proxy t)
	Ecrit le triplet t sur le flot o.
std::istream &	operator>> (std::istream &i, Real3Proxy &t)
	Lit le triplet t à partir du flot o.
std::ostream &	operator<< (std::ostream &o, Real3x3Proxy t)
	Ecrit le triplet t sur le flot o.
std::istream &	operator>> (std::istream &i, Real3x3Proxy &t)
	Lit le triplet t à partir du flot o.

Membres hérités additionnels
Attributs publics hérités de Arcane::Real3POD
Real	x
	première composante du triplet
Real	y
	deuxième composante du triplet
Real	z
	troisième composante du triplet

Description détaillée

Classe gérant un vecteur de réel de dimension 3.

Le vecteur comprend trois composantes x, y et z qui sont du type Real.

Real3 value (1.0,2.3,4.5); // Créé un triplet (x=1.0, y=2.3, z=4.5)
cout << value.x;           // Imprime le composant x 
value.y += 3.2;            // Ajoute 3.2 à la composante \b y

ou de maniere equivalente

Real3 value (1.0,2.3,4.5); // Créé un triplet (x=1.0, y=2.3, z=4.5)
cout << value[0];          // Imprime le composant x 
value[1] += 3.2;           // Ajoute 3.2 à la composante \b y

Définition à la ligne 130 du fichier Real3.h.

Documentation des constructeurs et destructeur

Real3() [1/5]

constexpr __host__ __device__ Arcane::Real3::Real3 ( )

inlineconstexpr

Construit le vecteur nul.

Définition à la ligne 136 du fichier Real3.h.

Real3() [2/5]

constexpr __host__ __device__ Arcane::Real3::Real3 ( Real  ax, Real  ay, Real  az  )

inlineconstexpr

Construit le triplet (ax,ay,az)

Définition à la ligne 144 du fichier Real3.h.

Real3() [3/5]

constexpr __host__ __device__ Arcane::Real3::Real3 ( const Real3POD &  f )

inlineexplicitconstexpr

Construit un triplet identique à f.

Définition à la ligne 154 du fichier Real3.h.

Références Arcane::Real3POD::x, Arcane::Real3POD::y, et Arcane::Real3POD::z.

Real3() [4/5]

constexpr __host__ __device__ Arcane::Real3::Real3 ( Real  v )

inlineexplicitconstexpr

Construit l'instance avec le triplet (v,v,v).

Définition à la ligne 163 du fichier Real3.h.

Real3() [5/5]

constexpr __host__ __device__ Arcane::Real3::Real3 ( const Real2 &  f )

inlineexplicitconstexpr

Construit un triplet identique à f.

Définition à la ligne 170 du fichier Real3.h.

Références Arcane::Real2POD::x, et Arcane::Real2POD::y.

Documentation des fonctions membres

abs()

__host__ __device__ Real Arcane::Real3::abs ( ) const

inline

Retourne la norme du triplet \(\sqrt{x^2+y^2+z^2}\).

Définition à la ligne 526 du fichier Real3.h.

abs2()

constexpr __host__ __device__ Real Arcane::Real3::abs2 ( ) const

inlineconstexpr

Retourne la norme au carré du triplet \(x^2+y^2+z^2\).

Définition à la ligne 416 du fichier Real3.h.

absolute()

__host__ __device__ Real3 Arcane::Real3::absolute ( ) const

inline

Valeur absolue composante par composante.

Définition à la ligne 221 du fichier Real3.h.

add()

constexpr __host__ __device__ Real3 & Arcane::Real3::add ( Real3  b )

inlineconstexpr

Ajoute b au triplet.

Définition à la ligne 234 du fichier Real3.h.

addSame()

constexpr __host__ __device__ Real3 & Arcane::Real3::addSame ( Real  b )

inlineconstexpr

Ajoute b à chaque composante du triplet.

Définition à la ligne 266 du fichier Real3.h.

assign() [1/3]

constexpr __host__ __device__ Real3 & Arcane::Real3::assign ( Real  ax, Real  ay, Real  az  )

inlineconstexpr

Affecte à l'instance le triplet (ax,ay,az)

Définition à la ligne 204 du fichier Real3.h.

Référencé par Arcane::Real3Proxy::assign().

assign() [2/3]

constexpr __host__ __device__ Real3 & Arcane::Real3::assign ( Real3  f )

inlineconstexpr

Copie le triplet f.

Définition à la ligne 212 du fichier Real3.h.

Références Arcane::Real3POD::x, Arcane::Real3POD::y, et Arcane::Real3POD::z.

assign() [3/3]

std::istream & Arcane::Real3::assign

(

std::istream &

i

)

Lit un triplet sur le flot i Le triplet est lu sous la forme de trois valeur de type #value_type.

Définition à la ligne 28 du fichier Real3.cc.

Références Arcane::Real3POD::x, Arcane::Real3POD::y, et Arcane::Real3POD::z.

copy()

constexpr __host__ __device__ Real3 Arcane::Real3::copy ( ) const

inlineconstexpr

Retourne une copie du triplet.

Définition à la ligne 196 du fichier Real3.h.

div()

constexpr __host__ __device__ Real3 & Arcane::Real3::div ( Real3  b )

inlineconstexpr

Divise chaque composante du triplet par la composant correspondant de b.

Définition à la ligne 258 du fichier Real3.h.

divSame()

constexpr __host__ __device__ Real3 & Arcane::Real3::divSame ( Real  b )

inlineconstexpr

Divise chaque composante du triplet par b.

Définition à la ligne 290 du fichier Real3.h.

isNearlyZero()

constexpr __host__ __device__ bool Arcane::Real3::isNearlyZero ( ) const

inlineconstexpr

Définition à la ligne 502 du fichier Real3.h.

mul()

constexpr __host__ __device__ Real3 & Arcane::Real3::mul ( Real3  b )

inlineconstexpr

Multiple chaque composante du triplet par la composant correspondant de b.

Définition à la ligne 250 du fichier Real3.h.

mulSame()

constexpr __host__ __device__ Real3 & Arcane::Real3::mulSame ( Real  b )

inlineconstexpr

Multiplie chaque composante du triplet par b.

Définition à la ligne 282 du fichier Real3.h.

normalize()

Real3 & Arcane::Real3::normalize ( )

inline

Définition à la ligne 496 du fichier Real3.h.

normL2()

__host__ __device__ Real Arcane::Real3::normL2 ( ) const

inline

Retourne la norme L2 du triplet \(\sqrt{x^2+y^2+z^2}\).

Définition à la ligne 520 du fichier Real3.h.

null()

constexpr __host__ static __device__ Real3 Arcane::Real3::null ( )

inlinestaticconstexpr

Définition à la ligne 190 du fichier Real3.h.

operator!=()

constexpr __host__ __device__ bool Arcane::Real3::operator!= ( Real3  b ) const

inlineconstexpr

Compare deux triplets. Pour la notion d'égalité, voir operator==()

Valeurs retournées

true	si les deux triplets sont différents,
false	sinon.

Définition à la ligne 402 du fichier Real3.h.

operator*()

constexpr __host__ __device__ Real3 Arcane::Real3::operator* ( Real3  b ) const

inlineconstexpr

Créé un triplet qui vaut ce triplet dont chaque composant a été multipliée par la composante correspondante de b.

Définition à la ligne 329 du fichier Real3.h.

operator*=() [1/2]

constexpr __host__ __device__ void Arcane::Real3::operator*= ( Real  b )

inlineconstexpr

Multiple chaque composante du triplet par le réel b.

Définition à la ligne 304 du fichier Real3.h.

operator*=() [2/2]

constexpr __host__ __device__ Real3 & Arcane::Real3::operator*= ( Real3  b )

inlineconstexpr

Multiple chaque composante du triplet par la composant correspondant de b.

Définition à la ligne 302 du fichier Real3.h.

operator+()

constexpr __host__ __device__ Real3 Arcane::Real3::operator+ ( Real3  b ) const

inlineconstexpr

Créé un triplet qui vaut ce triplet ajouté à b.

Définition à la ligne 320 du fichier Real3.h.

operator+=()

constexpr __host__ __device__ Real3 & Arcane::Real3::operator+= ( Real3  b )

inlineconstexpr

Ajoute b au triplet.

Définition à la ligne 298 du fichier Real3.h.

operator-() [1/2]

constexpr __host__ __device__ Real3 Arcane::Real3::operator- ( ) const

inlineconstexpr

Créé un triplet opposé au triplet actuel.

Définition à la ligne 324 du fichier Real3.h.

operator-() [2/2]

constexpr __host__ __device__ Real3 Arcane::Real3::operator- ( Real3  b ) const

inlineconstexpr

Créé un triplet qui vaut b soustrait de ce triplet.

Définition à la ligne 322 du fichier Real3.h.

operator-=()

constexpr __host__ __device__ Real3 & Arcane::Real3::operator-= ( Real3  b )

inlineconstexpr

Soustrait b au triplet.

Définition à la ligne 300 du fichier Real3.h.

operator/()

constexpr __host__ __device__ Real3 Arcane::Real3::operator/ ( Real3  b ) const

inlineconstexpr

Créé un triplet qui vaut ce triplet dont chaque composant a été divisée par la composante correspondante de b.

Définition à la ligne 334 du fichier Real3.h.

operator/=() [1/2]

constexpr __host__ __device__ void Arcane::Real3::operator/= ( Real  b )

inlineconstexpr

Divise chaque composante du triplet par le réel b.

Définition à la ligne 313 du fichier Real3.h.

operator/=() [2/2]

constexpr __host__ __device__ Real3 & Arcane::Real3::operator/= ( Real3  b )

inlineconstexpr

Divise chaque composante du triplet par la composant correspondant de b.

Définition à la ligne 311 du fichier Real3.h.

operator=()

constexpr __host__ __device__ Real3 & Arcane::Real3::operator= ( Real  v )

inlineconstexpr

Affecte à l'instance le triplet (v,v,v).

Définition à la ligne 182 du fichier Real3.h.

operator==()

constexpr __host__ __device__ bool Arcane::Real3::operator== ( Real3  b ) const

inlineconstexpr

Compare composant pas composante l'instance courante à b.

Valeurs retournées

true	si this.x==b.x et this.y==b.y et this.z==b.z.
false	sinon.

Définition à la ligne 391 du fichier Real3.h.

print()

std::ostream & Arcane::Real3::print

(

std::ostream &

o

)

const

Ecrit le triplet sur le flot o lisible par un assign()

Définition à la ligne 38 du fichier Real3.cc.

Références Arcane::Real3POD::x, Arcane::Real3POD::y, et Arcane::Real3POD::z.

Référencé par Arcane::Real3Proxy::print().

printXyz()

std::ostream & Arcane::Real3::printXyz

(

std::ostream &

o

)

const

Ecrit le triplet sur le flot o sous la forme (x,y,z)

Définition à la ligne 48 du fichier Real3.cc.

Références Arcane::Real3POD::x, Arcane::Real3POD::y, et Arcane::Real3POD::z.

Référencé par Arcane::Real3Proxy::printXyz().

reset()

constexpr __host__ __device__ Real3 & Arcane::Real3::reset ( )

inlineconstexpr

Réinitialise le triplet avec les constructeurs par défaut.

Définition à la ligne 198 du fichier Real3.h.

squareNormL2()

constexpr __host__ __device__ Real Arcane::Real3::squareNormL2 ( ) const

inlineconstexpr

Retourne la norme L2 au carré du triplet \(x^2+y^2+z^2\).

Définition à la ligne 408 du fichier Real3.h.

sub()

constexpr __host__ __device__ Real3 & Arcane::Real3::sub ( Real3  b )

inlineconstexpr

Soustrait b au triplet.

Définition à la ligne 242 du fichier Real3.h.

subSame()

constexpr __host__ __device__ Real3 & Arcane::Real3::subSame ( Real  b )

inlineconstexpr

Soustrait b à chaque composante du triplet.

Définition à la ligne 274 du fichier Real3.h.

zero()

constexpr __host__ static __device__ Real3 Arcane::Real3::zero ( )

inlinestaticconstexpr

Définition à la ligne 191 du fichier Real3.h.

Documentation des fonctions amies et associées

operator* [1/2]

constexpr __host__ __device__ Real3 operator* ( Real  sca, Real3  vec  )

friend

Multiplication par un scalaire.

Définition à la ligne 337 du fichier Real3.h.

operator* [2/2]

constexpr __host__ __device__ Real3 operator* ( Real3  vec, Real  sca  )

friend

Multiplication par un scalaire.

Définition à la ligne 343 du fichier Real3.h.

operator/

constexpr __host__ __device__ Real3 operator/ ( Real3  vec, Real  sca  )

friend

Division par un scalaire.

Définition à la ligne 349 du fichier Real3.h.

operator<

constexpr __host__ __device__ bool operator< ( Real3  v1, Real3  v2  )

friend

Opérateur de comparaison.

Cet opérateur permet de trier les Real3 pour les utiliser par exemple dans les std::set

Définition à la ligne 362 du fichier Real3.h.

operator<< [1/3]

std::ostream & operator<< ( std::ostream &  o, Real3  t  )

friend

Ecrit le triplet t sur le flot o.

Définition à la ligne 374 du fichier Real3.h.

operator<<() [2/3]

std::ostream & operator<< ( std::ostream &  o, Real3Proxy  t  )

related

Ecrit le triplet t sur le flot o.

Définition à la ligne 283 du fichier Real3Proxy.h.

operator<<() [3/3]

std::ostream & operator<< ( std::ostream &  o, Real3x3Proxy  t  )

related

Ecrit le triplet t sur le flot o.

Définition à la ligne 157 du fichier Real3x3Proxy.h.

operator>>() [1/4]

template<typename Type >

std::istream & operator>> ( std::istream &  i, BuiltInProxy< Type > &  t  )

related

Lit le triplet t à partir du flot o.

Définition à la ligne 140 du fichier BuiltInProxy.h.

operator>> [2/4]

std::istream & operator>> ( std::istream &  i, Real3 &  t  )

friend

Lit le triplet t à partir du flot o.

Définition à la ligne 380 du fichier Real3.h.

operator>>() [3/4]

std::istream & operator>> ( std::istream &  i, Real3Proxy &  t  )

related

Lit le triplet t à partir du flot o.

Définition à la ligne 293 du fichier Real3Proxy.h.

operator>>() [4/4]

std::istream & operator>> ( std::istream &  i, Real3x3Proxy &  t  )

related

Lit le triplet t à partir du flot o.

Définition à la ligne 167 du fichier Real3x3Proxy.h.

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• Real3.h
• BuiltInProxy.h
• Real3.cc
• Real3Proxy.h
• Real3x3Proxy.h