]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Clarify a comment for Utilities::generate_normal_random_number(). 6256/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Tue, 17 Apr 2018 16:11:08 +0000 (10:11 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Tue, 17 Apr 2018 16:11:08 +0000 (10:11 -0600)
include/deal.II/base/utilities.h

index 051662d6ee5a4e5325e94cfc076503067c8b87c2..d55fab21c7ac6ed7fca2d26e95dd3b43ccf2e2da 100644 (file)
@@ -263,6 +263,7 @@ namespace Utilities
   /**
    * Generate a random number from a normalized Gaussian probability
    * distribution centered around @p a and with standard deviation @p sigma.
+   * The returned number will be different every time the function is called.
    *
    * This function is reentrant, i.e., it can safely be called from multiple
    * threads at the same time. In addition, each thread will get the same
@@ -278,8 +279,8 @@ namespace Utilities
    * @note Like the system function rand(), this function produces the same
    * sequence of random numbers every time a program is started. This is an
    * important property for debugging codes, but it makes it impossible to
-   * really verify statistics properties of a code. For rand(), you can call
-   * srand() to "seed" the random number generator to get different sequences
+   * really verify statistical properties of a code. For `rand()`, you can call
+   * `srand()` to "seed" the random number generator to get different sequences
    * of random numbers every time a program is called. However, this function
    * does not allow seeding the random number generator. If you need this, as
    * above, use one of the C++ or BOOST facilities.

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.