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

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

Graphe de collaboration de Arcane::random::TKiss< UIntType, val >:

Types publics
typedef UIntType	result_type
typedef UIntType	state_type

Fonctions membres publiques
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.
	TKiss (UIntType x0=30903, UIntType y0=30903, UIntType z0=30903, UIntType w0=30903, UIntType carry0=0)
	Constructeur avec initialisation du tableau de graines à partir des valeurs des arguments.
void	seed (UIntType *state)
	Initialisation du tableau de graines à partir de l'état state. L'état du générateur state doit être composé de cinq éléments.
void	seed (UIntType x0)
	Initialisation du tableau de graines à partir de la valeur x0. Le tableau de graines de ce générateur est composé de cinq éléments. Les quatre premiers éléments prennent la valeur x0. Le cinquième élément prend la valeur nulle.
void	seed (UIntType x0, UIntType y0, UIntType z0, UIntType w0, UIntType carry0)
	Initialisation du tableau de graines à partir des valeurs des arguments.
UIntType	getState (Integer i) const
	Méthode qui retourne la composante i del'état du générateur. L'état complet du générateur est donnée par les valeurs d'index i comprises entre 0 et 4 ( 0 < i <= 4 ).
UIntType	operator() ()
	Surdéfinition de l'opérateur () qui retourne la valeur pseudo aléatoire. L'état du générateur est modifié.
bool	validation (UIntType x) const
	Fonction de validation (je ne sais pas trop a quoi elle sert!)
bool	operator== (const TKiss &rhs) const
	Surdéfinition de l'opérateur ==.

Attributs publics statiques
static const bool	has_fixed_range = true
static const result_type	min_value = 0
static const result_type	max_value = 4294967295U

Attributs privés
state_type	_state [5]

Description détaillée

template<typename UIntType, UIntType val>
class Arcane::random::TKiss< UIntType, val >

Patron de classe Kiss. Il permet de définir des classes de générateurs de type Kiss. Les nombres pseudo-aléatoires générés sont de type UIntType. La génération de ces nombres s'effectue par l'appel de l'opérateur (). L'état du genérateur est défini par un membre private _state[i] de la classe qui est un tableau de cinq éléments (0<i<=4). La graine (état state[i] 0<i<=4 initial du générateur appelé également tableau de graines) est initialisée par l'appel au constructeur ou les différentes méthodes seed existantes.

Définition à la ligne 41 du fichier TKiss.h.

Documentation des définitions de type membres

result_type

template<typename UIntType, UIntType val>

typedef UIntType Arcane::random::TKiss< UIntType, val >::result_type

Définition à la ligne 44 du fichier TKiss.h.

state_type

template<typename UIntType, UIntType val>

typedef UIntType Arcane::random::TKiss< UIntType, val >::state_type

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

Documentation des constructeurs et destructeur

TKiss()

template<typename UIntType, UIntType val>

Arcane::random::TKiss< UIntType, val >::TKiss ( UIntType x0 = 30903, UIntType y0 = 30903, UIntType z0 = 30903, UIntType w0 = 30903, UIntType carry0 = 0 )

inlineexplicit

Constructeur avec initialisation du tableau de graines à partir des valeurs des arguments.

Auteur

Patrick Rathouit

Date

28/07/2006

Définition à la ligne 73 du fichier TKiss.h.

Documentation des fonctions membres

getState()

template<typename UIntType, UIntType val>

UIntType Arcane::random::TKiss< UIntType, val >::getState ( Integer i ) const

inline

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

Auteur

Patrick Rathouit

Date

28/07/2006

Définition à la ligne 124 du fichier TKiss.h.

max()

template<typename UIntType, UIntType val>

result_type Arcane::random::TKiss< UIntType, val >::max ( ) const

inline

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

Auteur

Patrick Rathouit

Date

28/07/2006

Définition à la ligne 64 du fichier TKiss.h.

min()

template<typename UIntType, UIntType val>

result_type Arcane::random::TKiss< UIntType, val >::min ( ) const

inline

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

Auteur

Patrick Rathouit

Date

28/07/2006

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

operator()()

template<typename UIntType, UIntType val>

UIntType Arcane::random::TKiss< UIntType, val >::operator() ( )

inline

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

Auteur

Patrick Rathouit

Date

28/07/2006

Définition à la ligne 133 du fichier TKiss.h.

operator==()

template<typename UIntType, UIntType val>

bool Arcane::random::TKiss< UIntType, val >::operator== ( const TKiss< UIntType, val > & rhs ) const

inline

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

Auteur

Patrick Rathouit

Date

28/07/2006

Définition à la ligne 162 du fichier TKiss.h.

seed() [1/3]

template<typename UIntType, UIntType val>

void Arcane::random::TKiss< UIntType, val >::seed ( UIntType * state )

inline

Initialisation du tableau de graines à partir de l'état state. L'état du générateur state doit être composé de cinq éléments.

Auteur

Patrick Rathouit

Date

28/07/2006

Définition à la ligne 89 du fichier TKiss.h.

seed() [2/3]

template<typename UIntType, UIntType val>

void Arcane::random::TKiss< UIntType, val >::seed ( UIntType x0 )

inline

Initialisation du tableau de graines à partir de la valeur x0.
Le tableau de graines de ce générateur est composé de cinq éléments. Les quatre premiers éléments prennent la valeur x0. Le cinquième élément prend la valeur nulle.

Auteur

Patrick Rathouit

Date

28/07/2006

Définition à la ligne 101 du fichier TKiss.h.

seed() [3/3]

template<typename UIntType, UIntType val>

void Arcane::random::TKiss< UIntType, val >::seed ( UIntType x0, UIntType y0, UIntType z0, UIntType w0, UIntType carry0 )

inline

Initialisation du tableau de graines à partir des valeurs des arguments.

Auteur

Patrick Rathouit

Date

28/07/2006

Définition à la ligne 113 du fichier TKiss.h.

validation()

template<typename UIntType, UIntType val>

bool Arcane::random::TKiss< UIntType, val >::validation ( UIntType 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 154 du fichier TKiss.h.

Documentation des données membres

_state

template<typename UIntType, UIntType val>

state_type Arcane::random::TKiss< UIntType, val >::_state[5]

private

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

has_fixed_range

template<typename UIntType, UIntType val>

const bool Arcane::random::TKiss< UIntType, val >::has_fixed_range = true

static

Définition à la ligne 46 du fichier TKiss.h.

max_value

template<typename UIntType, UIntType val>

const result_type Arcane::random::TKiss< UIntType, val >::max_value = 4294967295U

static

Définition à la ligne 48 du fichier TKiss.h.

min_value

template<typename UIntType, UIntType val>

const result_type Arcane::random::TKiss< UIntType, val >::min_value = 0

static

Définition à la ligne 47 du fichier TKiss.h.

---

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

• TKiss.h