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

Classe permettant de manipuler facilement une graine. Plus de détails...

#include <arcane/core/IRandomNumberGenerator.h>

Graphe de collaboration de Arcane::RNGSeedHelper:

Fonctions membres publiques
	RNGSeedHelper (ByteArrayView av)
	Constructeur de la classe.
template<class T >
	RNGSeedHelper (T *var)
	Constructeur de classe.
template<class T >
bool	setValue (T value_in)
	Méthode permettant de définir une valeur dans la graine.
template<class T >
bool	value (T &value_out, bool without_size_check=true) const
	Méthode permettant de récupérer la valeur de la graine.
template<class T >
bool	value (T *value_out, bool without_size_check=true) const
	Méthode permettant de récupérer la valeur de la graine.
Integer	sizeOfSeed () const
	Méthode permettant de récupérer la taille de la graine.
ByteConstArrayView	constView () const
	Méthode permettant de récupérer une vue constante.
ByteArrayView	view ()
	Méthode permettant de récupérer une vue.
template<class T >
RNGSeedHelper &	operator= (T new_value)
	Opérateur de copie depuis une valeur de graine.
ByteUniqueArray	copy ()
	Méthode permettant de récupérer une copie du tableau de Byte.

Attributs protégés
ByteArrayView	m_seed

Description détaillée

Classe permettant de manipuler facilement une graine.

Une graine est représentée par un tableau de Byte. Cette classe utilise un ArrayView de ce tableau.

Cette classe permet de définir une valeur dans le tableau et de récupérer cette valeur (autres autres choses).

Cette classe ne stocke pas le tableau mais uniquement un ArrayView de ce tableau.

Définition à la ligne 45 du fichier IRandomNumberGenerator.h.

Documentation des constructeurs et destructeur

RNGSeedHelper() [1/2]

Arcane::RNGSeedHelper::RNGSeedHelper ( ByteArrayView  av )

inline

Constructeur de la classe.

Paramètres

av	Un ArrayView de tableau représentant une graine.

Définition à la ligne 54 du fichier IRandomNumberGenerator.h.

RNGSeedHelper() [2/2]

template<class T >

Arcane::RNGSeedHelper::RNGSeedHelper ( T *  var )

inline

Constructeur de classe.

Paramètres du template

T	Un type de base.

Paramètres

var	Un pointeur vers la graine (attention, ne fait pas une copie de la valeur !)

Définition à la ligne 67 du fichier IRandomNumberGenerator.h.

Documentation des fonctions membres

constView()

ByteConstArrayView Arcane::RNGSeedHelper::constView ( ) const

inline

Méthode permettant de récupérer une vue constante.

Renvoie

ByteConstArrayView La vue.

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

Référencé par Arcane::PDESRandomNumberGeneratorService::viewSeed().

copy()

ByteUniqueArray Arcane::RNGSeedHelper::copy ( )

inline

Méthode permettant de récupérer une copie du tableau de Byte.

Renvoie

ByteUniqueArray La copie du tableau de Byte.

Définition à la ligne 189 du fichier IRandomNumberGenerator.h.

Référencé par Arcane::PDESRandomNumberGeneratorService::generateRandomSeed(), et Arcane::PDESRandomNumberGeneratorService::generateRandomSeed().

operator=()

template<class T >

RNGSeedHelper & Arcane::RNGSeedHelper::operator= ( T  new_value )

inline

Opérateur de copie depuis une valeur de graine.

Paramètres du template

T	Le type de la graine.

Paramètres

value

La valeur de la graine.

Renvoie

RNGSeedHelper& La graine destination.

Définition à la ligne 177 du fichier IRandomNumberGenerator.h.

setValue()

template<class T >

bool Arcane::RNGSeedHelper::setValue ( T  value_in )

inline

Méthode permettant de définir une valeur dans la graine.

Paramètres du template

T	Le type de valeur.

Paramètres

value_in

La futur valeur de la graine.

Renvoie

true Si la valeur a pu être attribuée.

false Si la valeur n'a pas pu être attribuée.

Définition à la ligne 85 du fichier IRandomNumberGenerator.h.

sizeOfSeed()

Integer Arcane::RNGSeedHelper::sizeOfSeed ( ) const

inline

Méthode permettant de récupérer la taille de la graine.

Renvoie

Integer La taille de la graine (en octet).

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

value() [1/2]

template<class T >

bool Arcane::RNGSeedHelper::value ( T &  value_out, bool  without_size_check = true  ) const

inline

Méthode permettant de récupérer la valeur de la graine.

Paramètres du template

T	Le type de la graine.

Paramètres

value_out	[OUT] La valeur de la graine.
without_size_check	Si le rognage de la valeur est autorisé.

Renvoie

true Si la valeur a pu être récupérée.

false Si la valeur n'a pas pu être récupérée ou si le tableau a une taille nulle.

Définition à la ligne 108 du fichier IRandomNumberGenerator.h.

value() [2/2]

template<class T >

bool Arcane::RNGSeedHelper::value ( T *  value_out, bool  without_size_check = true  ) const

inline

Méthode permettant de récupérer la valeur de la graine.

Paramètres du template

T	Le type de la graine.

Paramètres

value_out	[OUT] La valeur de la graine.
without_size_check	Si le rognage de la valeur est autorisé.

Renvoie

true Si la valeur a pu être récupérée.

false Si la valeur n'a pas pu être récupérée ou si le tableau a une taille nulle.

Définition à la ligne 129 du fichier IRandomNumberGenerator.h.

view()

ByteArrayView Arcane::RNGSeedHelper::view ( )

inline

Méthode permettant de récupérer une vue.

Renvoie

ByteArrayView La vue.

Définition à la ligne 164 du fichier IRandomNumberGenerator.h.

Documentation des données membres

m_seed

ByteArrayView Arcane::RNGSeedHelper::m_seed

protected

Définition à la ligne 195 du fichier IRandomNumberGenerator.h.

---

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

• IRandomNumberGenerator.h