Changeset 4293 for trunk/psLib/src/dataManip/psRandom.h

Timestamp:

Jun 16, 2005, 2:11:08 PM (21 years ago)

Author:

drobbin

Message:

* empty log message *

File:

• trunk/psLib/src/dataManip/psRandom.h (modified) (2 diffs)

trunk/psLib/src/dataManip/psRandom.h

@@ -10 +10 @@
 *  @author GLG, MHPCC
 *
-*  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2005-06-08 23:40:45 $
+*  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
+*  @date $Date: 2005-06-17 00:11:05 $
 *
 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -33 +33 @@
  */
 
+/** Enumeration containing a flag for psRandom types.  */
 typedef enum {
-    PS_RANDOM_TAUS    ///< A maximally equidistributed combined Tausworthe generator.
+    PS_RANDOM_TAUS                     ///< A maximally equidistributed combined Tausworthe generator.
 } psRandomType;
 
+/** Data structure for psRandom.
+ *  Contains information on the psRandom type and GNU Scientific Library random number generator.
+ */
 typedef struct
 {
-    psRandomType type; ///< The type of RNG
-    gsl_rng *gsl; ///< The RNG itself
+    psRandomType type;                 ///< The type of RNG
+    gsl_rng *gsl;                      ///< The RNG itself
 }
 psRandom;
 
-psRandom *psRandomAlloc(psRandomType type,
-                        psU64 seed);
+/** Allocates a psRandom struct.
+ *  
+ *  @return psRandom*:    A new psRandom structure.
+ */
+psRandom *psRandomAlloc(
+    psRandomType type,                 ///< The type of RNG
+    psU64 seed                         ///< Known value with which to seed the RNG
+);
 
-void psRandomReset(psRandom *rand,
-                   psU64 seed);
+/** Resets an existing psRandom struct.
+ *  
+ *  @return void
+ */
+void psRandomReset(
+    psRandom *rand,                    ///< Existing psRandom struct to reset
+    psU64 seed                         ///< Known value with which to seed the RNG
+);
 
-psF64 psRandomUniform(const psRandom *r);
-psF64 psRandomGaussian(const psRandom *r);
-psF64 psRandomPoisson(const psRandom *r, psF64 mean);
+/** Random number generator based on a uniform distribution on [0,1).
+ *  Uses gsl_rng_uniform.
+ *  
+ *  @return psF64:     Random number.
+ */
+psF64 psRandomUniform(
+    const psRandom *r                  ///< psRandom struct for RNG
+);
+
+/** Random number generator based on a Gaussian deviate, N(0,1).
+ *  Uses gsl_ran_gaussian.
+ *  
+ *  @return psF64:     Random number.
+ */
+psF64 psRandomGaussian(
+    const psRandom *r                  ///< psRandom struct for RNG
+);
+
+/** Random number generator based on a Poisson distribution with the given mean.
+ *  Uses gsl_ran_poisson.
+ *  
+ *  @return psF64:     Random number.
+ */
+psF64 psRandomPoisson(
+    const psRandom *r,                 ///< psRandom struct for RNG
+    psF64 mean                         ///< Mean value
+);
 
 /* \} */// End of MathGroup Functions