Changeset 913 in Sophya for trunk/SophyaLib/BaseTools/srandgen.c

Timestamp:

Apr 13, 2000, 5:58:41 PM (25 years ago)

Author:

ansari

Message:

Documentation + Modifs mineures (namespace, etc..) - Reza 13/4/2000

File:

• trunk/SophyaLib/BaseTools/srandgen.c (modified) (7 diffs)

trunk/SophyaLib/BaseTools/srandgen.c

@@ -35 +35 @@
 */
 
+/*! \defgroup RandGen
+    Random number generators */
+
+/*! \ingroup  SysTools
+    \fn frand01
+    Returns a random number (float) with flat distribution between 0 ... 1
+*/
+/*! \ingroup  SysTools
+    \fn drand01
+    Returns a random number (double) with flat distribution between 0 ... 1
+*/
+/*! \ingroup  SysTools
+    \fn frandpm1() 
+    Returns a random number (float) with flat distribution between -1 ... 1
+*/
+/*! \ingroup  SysTools
+    \fn drandpm1() 
+    Returns a random number (double) with flat distribution between -1 ... 1  
+*/
+
 /*=========================================================================*/
 /*
@@ -43 +63 @@
 --
 */
+
+/*! \ingroup  SysTools
+    Fast initialisation of the random number generator \c (drand48) 
+    using a \c long type value (cf \c srand48 )
+*/
 void Ini_Ranf_Quick(long seed_val, int lp)
 {
@@ -57 +82 @@
         48 bits (cf seed48).
 --
+*/
+/*! \ingroup  SysTools
+    complete initialisation of the random number generator \c (drand48) 
+    using a \c using 48 bits (cf \c seed48 )
 */
 void Ini_Ranf(unsigned short seed_16v[3], int lp)
@@ -73 +102 @@
         de 48 bits (cf seed48).
 --
+*/
+/*! \ingroup  SysTools
+    Returns the status (48 bits) of the random number generator \c (drand48) 
+    (cf \c seed48 )
 */
 void Get_Ranf(unsigned short seed_16v[3], int lp)
@@ -102 +135 @@
 --
 */
+/*! \ingroup  SysTools
+    Automatic initialisation using the present time
+*/
 void Auto_Ini_Ranf(int lp)
 {
@@ -151 +187 @@
 --
 */
+/*! \ingroup  SysTools
+    Normal (Gaussian) random number generator (Mean=0., Sigma=1.)
+*/
 float NorRand(void)
 {
@@ -190 +229 @@
         Generation aleatoire gaussienne de centre "am" et de sigma "s".
 --
+*/
+/*! \ingroup  SysTools
+    Normal (Gaussian) random number generator with the specified mean
+    (\c am ) and sigma (\c s )
 */
 double GauRnd(double am, double s)