aboutsummaryrefslogtreecommitdiffstats
path: root/source/lang/randomseed.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-11-28 11:23:33 -0500
committerMarti Bolivar <mbolivar@mit.edu>2010-11-28 11:23:33 -0500
commitd9cbd78e29d42e70bb46641dd43ee0772c8c975f (patch)
tree80a67cba4468dbcd89b3cd23ad56695b1f146c66 /source/lang/randomseed.rst
parent546b34076d230b617ba86defb6b90cd934b01878 (diff)
downloadlibrambutan-d9cbd78e29d42e70bb46641dd43ee0772c8c975f.tar.gz
librambutan-d9cbd78e29d42e70bb46641dd43ee0772c8c975f.zip
reorganized all the arduino/ docs into a lang/ subdirectory since
they're properly CC attributed now.
Diffstat (limited to 'source/lang/randomseed.rst')
-rw-r--r--source/lang/randomseed.rst73
1 files changed, 73 insertions, 0 deletions
diff --git a/source/lang/randomseed.rst b/source/lang/randomseed.rst
new file mode 100644
index 0000000..3dcf4db
--- /dev/null
+++ b/source/lang/randomseed.rst
@@ -0,0 +1,73 @@
+.. _lang-randomseed:
+
+randomSeed(seed)
+================
+
+Description
+-----------
+
+randomSeed() initializes the pseudo-random number generator,
+causing it to start at an arbitrary point in its random sequence.
+This sequence, while very long, and random, is always the same.
+
+
+
+If it is important for a sequence of values generated by random()
+to differ, on subsequent executions of a sketch, use randomSeed()
+to initialize the random number generator with a fairly random
+input, such as analogRead() on an unconnected pin.
+
+
+
+Conversely, it can occasionally be useful to use pseudo-random
+sequences that repeat exactly. This can be accomplished by calling
+randomSeed() with a fixed number, before starting the random
+sequence.
+
+
+
+Parameters
+----------
+
+long, int - pass a number to generate the seed.
+
+
+
+Returns
+-------
+
+no returns
+
+
+
+Example
+-------
+
+::
+
+ long randNumber;
+
+ void setup(){
+ Serial.begin(9600);
+ randomSeed(analogRead(0));
+ }
+
+ void loop(){
+ randNumber = random(300);
+ Serial.println(randNumber);
+
+ delay(50);
+ }
+
+
+
+See also
+--------
+
+
+- `random <http://arduino.cc/en/Reference/Random>`_
+
+
+
+
+.. include:: cc-attribution.txt