aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/api/randomseed.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 19:25:29 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 20:05:33 -0400
commit0c2b3c667bf157dc2344e3dbc2aae0e11e37387b (patch)
tree3008ee192c80f17f640ebdeb870442e78415ce6b /docs/source/lang/api/randomseed.rst
parentd4b576fcadecf66b7b754af7d204bb6f3b4a9830 (diff)
downloadlibrambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.tar.gz
librambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.zip
Remove reST documentation, attendant updates.
The documentation covers topics not specifically relevant to libmaple, so it doesn't make sense for it to be part of the libmaple source distribution. Delete the docs/ tree, and prepare libmaple for use with the new leaflabs-docs repo, which will contain the docs from now on. * README: update to reflect this change * support/doxygen/Doxyfile: This is the old docs/Doxyfile * Makefile: Add a doxygen target * wirish/comm/HardwareSerial.h: fix reference to docs/. The comment informing maintainers that the HardwareSerial interface is documented by hand refers to the docs/ tree, which no longer exists. Update it to refer to the separate leaflabs-docs repository. * support/scripts/copy-to-ide: No longer build the documentation
Diffstat (limited to 'docs/source/lang/api/randomseed.rst')
-rw-r--r--docs/source/lang/api/randomseed.rst60
1 files changed, 0 insertions, 60 deletions
diff --git a/docs/source/lang/api/randomseed.rst b/docs/source/lang/api/randomseed.rst
deleted file mode 100644
index ca7b75f..0000000
--- a/docs/source/lang/api/randomseed.rst
+++ /dev/null
@@ -1,60 +0,0 @@
-.. highlight:: cpp
-
-.. _lang-randomseed:
-
-randomSeed()
-============
-
-``randomSeed()`` initializes the `pseudorandom number generator
-<http://en.wikipedia.org/wiki/Pseudorandom_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.
-
-
-Library Documentation
----------------------
-
-.. doxygenfunction:: randomSeed
-
-Discussion
-----------
-
-If it is important for a sequence of values generated by
-:ref:`random() <lang-random>` to differ, on subsequent executions of a
-sketch, use ``randomSeed()`` to initialize the random number generator
-with a fairly random input, such as :ref:`analogRead()
-<lang-analogread>` on an unconnected pin.
-
-Conversely, it can occasionally be useful to use pseudorandom
-sequences that repeat exactly. This can be accomplished by calling
-``randomSeed()`` with a fixed number, before starting the random
-sequence.
-
-Example
--------
-
-The following sketch initializes the random seed based on an :ref:`ADC
-<adc>` reading of pin 0. If this pin is unconnected, the Sketch
-should print different values to the :ref:`serial monitor
-<ide-serial-monitor>` each time it is run::
-
- long randNumber;
-
- void setup() {
- pinMode(0, INPUT_ANALOG);
- randomSeed(analogRead(0));
- }
-
- void loop() {
- randNumber = random(300);
- SerialUSB.println(randNumber);
-
- delay(50);
- }
-
-See Also
---------
-
-- :ref:`random() <lang-random>`
-
-.. include:: /arduino-cc-attribution.txt