Arcane  v3.14.10.0
Documentation utilisateur
Chargement...
Recherche...
Aucune correspondance
Fonctions membres publiques | Liste de tous les membres
Référence de la classe Arcane::IRandomNumberGeneratorabstract
StandardService

Interface pour un générateur de nombre aléatoire. Plus de détails...

#include <arcane/core/IRandomNumberGenerator.h>

+ Graphe de collaboration de Arcane::IRandomNumberGenerator:

Fonctions membres publiques

virtual bool initSeed ()=0
 Méthode permettant d'initialiser le service.
 
virtual bool initSeed (ByteArrayView seed)=0
 Méthode permettant d'initialiser le service.
 
virtual ByteConstArrayView viewSeed ()=0
 Méthode permettant de récupérer une vue constante sur la graine actuelle.
 
virtual ByteUniqueArray emptySeed ()=0
 Méthode permettant de récupérer une graine vide de bonne taille.
 
virtual Integer neededSizeOfSeed ()=0
 Méthode permettant de connaitre la taille de seed nécessaire pour l'implémentation.
 
virtual bool isLeapSeedSupported ()=0
 Méthode permettant de savoir si les sauts sont permis sur le générateur de graines.
 
virtual ByteUniqueArray generateRandomSeed (Integer leap=0)=0
 Méthode permettant de générer une graine "enfant" à partir d'une graine "parent".
 
virtual ByteUniqueArray generateRandomSeed (ByteArrayView parent_seed, Integer leap=0)=0
 Méthode permettant de générer une graine "enfant" à partir d'une graine "parent".
 
virtual bool isLeapNumberSupported ()=0
 Méthode permettant de savoir si les sauts sont permis sur le générateur de nombres.
 
virtual Real generateRandomNumber (Integer leap=0)=0
 Méthode permettant de générer un nombre aléatoire avec la graine en mémoire.
 
virtual Real generateRandomNumber (ByteArrayView seed, Integer leap=0)=0
 Méthode permettant de générer un nombre aléatoire avec la graine transmise en paramètre.
 

Description détaillée

Interface pour un générateur de nombre aléatoire.

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

Documentation des fonctions membres

◆ emptySeed()

virtual ByteUniqueArray Arcane::IRandomNumberGenerator::emptySeed ( )
pure virtual

Méthode permettant de récupérer une graine vide de bonne taille.

Renvoie
ByteUniqueArray La graine vide.

◆ generateRandomNumber() [1/2]

virtual Real Arcane::IRandomNumberGenerator::generateRandomNumber ( ByteArrayView  seed,
Integer  leap = 0 
)
pure virtual

Méthode permettant de générer un nombre aléatoire avec la graine transmise en paramètre.

Cette méthode n'utilise pas la graine en mémoire mais la graine en paramètre. Si la graine en paramètre n'a pas la bonne taille, une erreur sera émise.

Paramètres
seed[IN/OUT] La graine.
leapLe saut à effectuer (0 = le nombre n+1+0 / 1 = le nombre n+1+1).
Renvoie
Real Le nombre généré (entre 0 et 1).

◆ generateRandomNumber() [2/2]

virtual Real Arcane::IRandomNumberGenerator::generateRandomNumber ( Integer  leap = 0)
pure virtual

Méthode permettant de générer un nombre aléatoire avec la graine en mémoire.

Paramètres
leapLe saut à effectuer (0 = le nombre n+1+0 / 1 = le nombre n+1+1).
Renvoie
Real Le nombre généré (entre 0 et 1).

◆ generateRandomSeed() [1/2]

virtual ByteUniqueArray Arcane::IRandomNumberGenerator::generateRandomSeed ( ByteArrayView  parent_seed,
Integer  leap = 0 
)
pure virtual

Méthode permettant de générer une graine "enfant" à partir d'une graine "parent".

Cette méthode n'utilise pas la graine en mémoire mais la graine en paramètre. Si la graine en paramètre n'a pas la bonne taille, une erreur sera émise.

Paramètres
parent_seed[IN/OUT] La graine "parent".
leapLe saut à effectuer (0 = la graine n+1+0 / 1 = la graine n+1+1).
Renvoie
ByteUniqueArray La nouvelle graine généré à partir de la graine "parent".

◆ generateRandomSeed() [2/2]

virtual ByteUniqueArray Arcane::IRandomNumberGenerator::generateRandomSeed ( Integer  leap = 0)
pure virtual

Méthode permettant de générer une graine "enfant" à partir d'une graine "parent".

Paramètres
leapLe saut à effectuer (0 = la graine n+1+0 / 1 = la graine n+1+1).
Renvoie
ByteUniqueArray La nouvelle graine généré à partir de la graine en mémoire.

◆ initSeed() [1/2]

virtual bool Arcane::IRandomNumberGenerator::initSeed ( )
pure virtual

Méthode permettant d'initialiser le service.

Avec la graine en option (ou la graine par défaut si l'on est en mode singleton).

Renvoie
true Si l'initialisation a bien eu lieu.
false Si l'initialisation n'a pas eu lieu.

◆ initSeed() [2/2]

virtual bool Arcane::IRandomNumberGenerator::initSeed ( ByteArrayView  seed)
pure virtual

Méthode permettant d'initialiser le service.

Si la graine n'a pas la bonne taille, false sera retourné.

Paramètres
seedLa graine d'origine.
Renvoie
true Si l'initialisation a bien eu lieu.
false Si l'initialisation n'a pas eu lieu.

◆ isLeapNumberSupported()

virtual bool Arcane::IRandomNumberGenerator::isLeapNumberSupported ( )
pure virtual

Méthode permettant de savoir si les sauts sont permis sur le générateur de nombres.

Renvoie
true Si oui.
false Si non.

◆ isLeapSeedSupported()

virtual bool Arcane::IRandomNumberGenerator::isLeapSeedSupported ( )
pure virtual

Méthode permettant de savoir si les sauts sont permis sur le générateur de graines.

Renvoie
true Si oui.
false Si non.

◆ neededSizeOfSeed()

virtual Integer Arcane::IRandomNumberGenerator::neededSizeOfSeed ( )
pure virtual

Méthode permettant de connaitre la taille de seed nécessaire pour l'implémentation.

Renvoie
Integer La taille de seed nécessaire (en octet).

◆ viewSeed()

virtual ByteConstArrayView Arcane::IRandomNumberGenerator::viewSeed ( )
pure virtual

Méthode permettant de récupérer une vue constante sur la graine actuelle.

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