Référence du modèle de la classe Arcane::random::TMrg32k3a< RealType, val >

#include <arcane/core/random/TMrg32k3a.h>

Graphe de collaboration de Arcane::random::TMrg32k3a< RealType, val >:

Types publics
typedef RealType	result_type
typedef RealType	state_type

Fonctions membres publiques
	TMrg32k3a (Int32 x0=1)
	Constructeur avec initialisation du tableau de graines à partir de la valeur x0. L'appel à la méthode seed(x0) est réalisé.
	TMrg32k3a (state_type *state)
	Constructeur avec initialisation du tableau de graines à partir du tableau state. state doit être un tableau de six éléments.
void	seed (Int32 x0)
	Initialisation du tableau de graines à partir de la valeur x0. Le tableau de graines de ce générateur est composé de six éléments.
RealType	getState (Integer i) const
	Méthode qui retourne l'état du générateur pour l'index i. L'état complet du générateur est donnée par les valeurs d'index i comprises entre 0 et 5 ( 0 < i <=5 ).
RealType	operator() ()
	Surdéfinition de l'opérateur () qui retourne la valeur pseudo aléatoire du générateur. L'état du générateur est modifié.
result_type	min () const
	Retourne la valeur minimum possible d'une séquence.
result_type	max () const
	Retourne la valeur maximum possible d'une séquence.
bool	validation (RealType x) const
	Fonction de validation (je ne sais pas trop a quoi elle sert!)
bool	operator== (const TMrg32k3a &rhs) const
	Surdéfinition de l'opérateur ==.

Fonctions membres publiques statiques
static RealType	apply (state_type *state)
	Retourne la valeur pseudo aléatoire à partir de l'état state. L'état du générateur state doit être composé de six éléments.

Attributs publics statiques
static const bool	has_fixed_range = true
static const Int32	min_value =0
static const Int32	max_value =1

Attributs privés
state_type	_state [6]

Description détaillée

template<typename RealType, Int32 val>
class Arcane::random::TMrg32k3a< RealType, val >

Patron de classe TMrg32k3a. Il permet de définir des classes de générateurs de type Mrg32k3a. Les nombres pseudo-aléatoires générés sont de
type RealType. L'état du générateur est caractérisé par six valeurs de type RealType et peut être géré en interne par le membre private _state[i] 0<i<=5.

La génération d'une séquence de nombres pseudo-aléatoires s'effectue :

• soit par l'appel successif de l'opérateur (). Dans ce cas, la graine peut
  etre initialisée par les différentes méthodes seed ou lors de l'appel au constructeur. L'état du générateur est géré en interne par l'intermédiaire du membre private _state[i] (0<i<=5). Ses composantes i sont accessibles
  via la méthode getState(i).
• soit par l'appel de la méthode apply(value). L'état du générateur est géré à l'extérieur de la classe. Les méthodes seed et getState n'ont pas de sens dans cette utilisation.

Définition à la ligne 49 du fichier TMrg32k3a.h.

Documentation des définitions de type membres

result_type

template<typename RealType, Int32 val>

typedef RealType Arcane::random::TMrg32k3a< RealType, val >::result_type

Définition à la ligne 52 du fichier TMrg32k3a.h.

state_type

template<typename RealType, Int32 val>

typedef RealType Arcane::random::TMrg32k3a< RealType, val >::state_type

Définition à la ligne 53 du fichier TMrg32k3a.h.

Documentation des constructeurs et destructeur

TMrg32k3a() [1/2]

template<typename RealType, Int32 val>

Arcane::random::TMrg32k3a< RealType, val >::TMrg32k3a ( Int32 x0 = 1 )

inlineexplicit

Constructeur avec initialisation du tableau de graines à partir de la valeur x0. L'appel à la méthode seed(x0) est réalisé.

Auteur

Patrick Rathouit

Date

28/07/2006

Définition à la ligne 65 du fichier TMrg32k3a.h.

TMrg32k3a() [2/2]

template<typename RealType, Int32 val>

Arcane::random::TMrg32k3a< RealType, val >::TMrg32k3a ( state_type * state )

inlineexplicit

Constructeur avec initialisation du tableau de graines à partir du tableau state. state doit être un tableau de six éléments.

Auteur

Patrick Rathouit

Date

28/07/2006

Définition à la ligne 77 du fichier TMrg32k3a.h.

Documentation des fonctions membres

apply()

template<typename RealType, Int32 val>

static RealType Arcane::random::TMrg32k3a< RealType, val >::apply ( state_type * state )

inlinestatic

Retourne la valeur pseudo aléatoire à partir de l'état state. L'état du générateur state doit être composé de six éléments.

Auteur

Patrick Rathouit

Date

28/07/2006

Définition à la ligne 131 du fichier TMrg32k3a.h.

Référencé par Arcane::random::TMrg32k3a< Real, 0 >::operator()().

Voici le graphe des appelants de cette fonction :

getState()

template<typename RealType, Int32 val>

RealType Arcane::random::TMrg32k3a< RealType, val >::getState ( Integer i ) const

inline

Méthode qui retourne l'état du générateur pour l'index i. L'état complet du générateur est donnée par les valeurs d'index i comprises entre 0 et 5 ( 0 < i <=5 ).

Auteur

Patrick Rathouit

Date

28/07/2006

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

max()

template<typename RealType, Int32 val>

result_type Arcane::random::TMrg32k3a< RealType, val >::max ( ) const

inline

Retourne la valeur maximum possible d'une séquence.

Auteur

Patrick Rathouit

Date

28/07/2006

Définition à la ligne 161 du fichier TMrg32k3a.h.

min()

template<typename RealType, Int32 val>

result_type Arcane::random::TMrg32k3a< RealType, val >::min ( ) const

inline

Retourne la valeur minimum possible d'une séquence.

Auteur

Patrick Rathouit

Date

28/07/2006

Définition à la ligne 153 du fichier TMrg32k3a.h.

operator()()

template<typename RealType, Int32 val>

RealType Arcane::random::TMrg32k3a< RealType, val >::operator() ( )

inline

Surdéfinition de l'opérateur () qui retourne la valeur pseudo aléatoire du générateur. L'état du générateur est modifié.

Auteur

Patrick Rathouit

Date

28/07/2006

Définition à la ligne 117 du fichier TMrg32k3a.h.

operator==()

template<typename RealType, Int32 val>

bool Arcane::random::TMrg32k3a< RealType, val >::operator== ( const TMrg32k3a< RealType, val > & rhs ) const

inline

Surdéfinition de l'opérateur ==.

Auteur

Patrick Rathouit

Date

28/07/2006

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

seed()

template<typename RealType, Int32 val>

void Arcane::random::TMrg32k3a< RealType, val >::seed ( Int32 x0 )

inline

Initialisation du tableau de graines à partir de la valeur x0. Le tableau de graines de ce générateur est composé de six éléments.

Auteur

Patrick Rathouit

Date

28/07/2006

Définition à la ligne 90 du fichier TMrg32k3a.h.

Référencé par Arcane::random::TMrg32k3a< Real, 0 >::TMrg32k3a().

Voici le graphe des appelants de cette fonction :

validation()

template<typename RealType, Int32 val>

bool Arcane::random::TMrg32k3a< RealType, val >::validation ( RealType x ) const

inline

Fonction de validation (je ne sais pas trop a quoi elle sert!)

Auteur

Patrick Rathouit

Date

28/07/2006

Définition à la ligne 169 du fichier TMrg32k3a.h.

Documentation des données membres

_state

template<typename RealType, Int32 val>

state_type Arcane::random::TMrg32k3a< RealType, val >::_state[6]

private

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

has_fixed_range

template<typename RealType, Int32 val>

const bool Arcane::random::TMrg32k3a< RealType, val >::has_fixed_range = true

static

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

max_value

template<typename RealType, Int32 val>

const Int32 Arcane::random::TMrg32k3a< RealType, val >::max_value =1

static

Définition à la ligne 56 du fichier TMrg32k3a.h.

min_value

template<typename RealType, Int32 val>

const Int32 Arcane::random::TMrg32k3a< RealType, val >::min_value =0

static

Définition à la ligne 55 du fichier TMrg32k3a.h.

---

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

• TMrg32k3a.h