aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/arduino/cos.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-10-25 21:15:28 -0400
committerMarti Bolivar <mbolivar@mit.edu>2010-11-17 12:44:28 -0500
commit95783b750fda95f5f4c1fac00ab24da03b31b517 (patch)
tree2b0bf89c101aa58af5796fbe76c7ec98eebbb0a5 /docs/source/arduino/cos.rst
parent3a9a119e9a8ce72c0e1b8fa4d3904bdf84ce355c (diff)
downloadlibrambutan-95783b750fda95f5f4c1fac00ab24da03b31b517.tar.gz
librambutan-95783b750fda95f5f4c1fac00ab24da03b31b517.zip
arduino language reference nearing completion, properly CC-BY-SA 3.0 attributed
Diffstat (limited to 'docs/source/arduino/cos.rst')
-rw-r--r--docs/source/arduino/cos.rst31
1 files changed, 14 insertions, 17 deletions
diff --git a/docs/source/arduino/cos.rst b/docs/source/arduino/cos.rst
index 7fed4bb..6b1406a 100644
--- a/docs/source/arduino/cos.rst
+++ b/docs/source/arduino/cos.rst
@@ -3,31 +3,28 @@
cos(rad)
========
-Description
------------
+Calculate the cosine of an angle (in radians).
-Calculates the cos of an angle (in radians). The result will be
-between -1 and 1.
+Library Documentation
+---------------------
-Parameters
-----------
+.. doxygenfunction:: cos
-rad: the angle in radians (*float*)
+Arduino Compatibility
+---------------------
+The Maple ``cos()`` implementation is compatible with Arduino.
-Returns
--------
-
-The cos of the angle ("double")
-
-
+Note that the Maple implementation comes from `newlib
+<http://sourceware.org/newlib/>`_\ , while Arduino's is that of
+`avr-libc <http://avr-libc.nongnu.org/>`_\ .
See also
--------
-- `sin <http://arduino.cc/en/Reference/Sin>`_\ ()
-- `tan <http://arduino.cc/en/Reference/Tan>`_\ ()
-- `float <http://arduino.cc/en/Reference/Float>`_
-- `double <http://arduino.cc/en/Reference/Double>`_
+- :ref:`sin() <arduino-sin>`
+- :ref:`tan() <arduino-tan>`
+- :ref:`float <arduino-float>`
+- :ref:`double <arduino-double>`