Commit b705a22e authored by Jason Swails's avatar Jason Swails
Browse files

Add notes in the doxygen comments about setRandomNumberSeed resulting in a

"truly" random seed being generated from the wall clock upon Context creation.
parent 601a696f
...@@ -114,6 +114,9 @@ public: ...@@ -114,6 +114,9 @@ public:
* the other hand, no guarantees are made about the behavior of simulations that use the same seed. * the other hand, no guarantees are made about the behavior of simulations that use the same seed.
* In particular, Platforms are permitted to use non-deterministic algorithms which produce different * In particular, Platforms are permitted to use non-deterministic algorithms which produce different
* results on successive runs, even if those runs were initialized identically. * results on successive runs, even if those runs were initialized identically.
*
* If seed is set to 0 (which is the default value assigned), a new seed is generated from the system
* clock when a Context is created from this Force.
*/ */
void setRandomNumberSeed(int seed) { void setRandomNumberSeed(int seed) {
randomNumberSeed = seed; randomNumberSeed = seed;
......
...@@ -99,6 +99,9 @@ public: ...@@ -99,6 +99,9 @@ public:
* the other hand, no guarantees are made about the behavior of simulations that use the same seed. * the other hand, no guarantees are made about the behavior of simulations that use the same seed.
* In particular, Platforms are permitted to use non-deterministic algorithms which produce different * In particular, Platforms are permitted to use non-deterministic algorithms which produce different
* results on successive runs, even if those runs were initialized identically. * results on successive runs, even if those runs were initialized identically.
*
* If seed is set to 0 (which is the default value assigned), a new seed is generated from the system
* clock when a Context is created from this Force.
*/ */
void setRandomNumberSeed(int seed) { void setRandomNumberSeed(int seed) {
randomNumberSeed = seed; randomNumberSeed = seed;
......
...@@ -444,6 +444,9 @@ public: ...@@ -444,6 +444,9 @@ public:
* the other hand, no guarantees are made about the behavior of simulations that use the same seed. * the other hand, no guarantees are made about the behavior of simulations that use the same seed.
* In particular, Platforms are permitted to use non-deterministic algorithms which produce different * In particular, Platforms are permitted to use non-deterministic algorithms which produce different
* results on successive runs, even if those runs were initialized identically. * results on successive runs, even if those runs were initialized identically.
*
* If seed is set to 0 (which is the default value assigned), a new seed is generated from the system
* clock when a Context is created from this Force.
*/ */
void setRandomNumberSeed(int seed) { void setRandomNumberSeed(int seed) {
randomNumberSeed = seed; randomNumberSeed = seed;
......
...@@ -99,6 +99,9 @@ public: ...@@ -99,6 +99,9 @@ public:
* the other hand, no guarantees are made about the behavior of simulations that use the same seed. * the other hand, no guarantees are made about the behavior of simulations that use the same seed.
* In particular, Platforms are permitted to use non-deterministic algorithms which produce different * In particular, Platforms are permitted to use non-deterministic algorithms which produce different
* results on successive runs, even if those runs were initialized identically. * results on successive runs, even if those runs were initialized identically.
*
* If seed is set to 0 (which is the default value assigned), a new seed is generated from the system
* clock when a Context is created from this Force.
*/ */
void setRandomNumberSeed(int seed) { void setRandomNumberSeed(int seed) {
randomNumberSeed = seed; randomNumberSeed = seed;
......
...@@ -167,6 +167,9 @@ public: ...@@ -167,6 +167,9 @@ public:
* the other hand, no guarantees are made about the behavior of simulations that use the same seed. * the other hand, no guarantees are made about the behavior of simulations that use the same seed.
* In particular, Platforms are permitted to use non-deterministic algorithms which produce different * In particular, Platforms are permitted to use non-deterministic algorithms which produce different
* results on successive runs, even if those runs were initialized identically. * results on successive runs, even if those runs were initialized identically.
*
* If seed is set to 0 (which is the default value assigned), a new seed is generated from the system
* clock when a Context is created from this Force.
*/ */
void setRandomNumberSeed(int seed) { void setRandomNumberSeed(int seed) {
randomNumberSeed = seed; randomNumberSeed = seed;
......
...@@ -123,6 +123,9 @@ public: ...@@ -123,6 +123,9 @@ public:
* the other hand, no guarantees are made about the behavior of simulations that use the same seed. * the other hand, no guarantees are made about the behavior of simulations that use the same seed.
* In particular, Platforms are permitted to use non-deterministic algorithms which produce different * In particular, Platforms are permitted to use non-deterministic algorithms which produce different
* results on successive runs, even if those runs were initialized identically. * results on successive runs, even if those runs were initialized identically.
*
* If seed is set to 0 (which is the default value assigned), a new seed is generated from the system
* clock when a Context is created from this Force.
*/ */
void setRandomNumberSeed(int seed) { void setRandomNumberSeed(int seed) {
randomNumberSeed = seed; randomNumberSeed = seed;
......
...@@ -220,6 +220,9 @@ public: ...@@ -220,6 +220,9 @@ public:
* the other hand, no guarantees are made about the behavior of simulations that use the same seed. * the other hand, no guarantees are made about the behavior of simulations that use the same seed.
* In particular, Platforms are permitted to use non-deterministic algorithms which produce different * In particular, Platforms are permitted to use non-deterministic algorithms which produce different
* results on successive runs, even if those runs were initialized identically. * results on successive runs, even if those runs were initialized identically.
*
* If seed is set to 0 (which is the default value assigned), a new seed is generated from the system
* clock when a Context is created from this Force.
*/ */
void setRandomNumberSeed(int seed) { void setRandomNumberSeed(int seed) {
randomNumberSeed = seed; randomNumberSeed = seed;
......
...@@ -121,6 +121,9 @@ public: ...@@ -121,6 +121,9 @@ public:
* the other hand, no guarantees are made about the behavior of simulations that use the same seed. * the other hand, no guarantees are made about the behavior of simulations that use the same seed.
* In particular, Platforms are permitted to use non-deterministic algorithms which produce different * In particular, Platforms are permitted to use non-deterministic algorithms which produce different
* results on successive runs, even if those runs were initialized identically. * results on successive runs, even if those runs were initialized identically.
*
* If seed is set to 0 (which is the default value assigned), a new seed is generated from the system
* clock when a Context is created from this Force.
*/ */
void setRandomNumberSeed(int seed) { void setRandomNumberSeed(int seed) {
randomNumberSeed = seed; randomNumberSeed = seed;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment