aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/max.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/lang/max.rst')
-rw-r--r--docs/source/lang/max.rst65
1 files changed, 0 insertions, 65 deletions
diff --git a/docs/source/lang/max.rst b/docs/source/lang/max.rst
deleted file mode 100644
index d38eebe..0000000
--- a/docs/source/lang/max.rst
+++ /dev/null
@@ -1,65 +0,0 @@
-.. highlight:: cpp
-
-.. _lang-max:
-
-max()
-=====
-
-(Macro) Calculates the maximum of two numbers.
-
-Syntax
-------
-
-::
-
- max(x, y)
-
-Parameters
-----------
-
-**x**: the first number; may be any number or numeric expression.
-
-**y**: the second number; may be any number or numeric expression.
-
-
-Returns
--------
-
-The larger of the two parameter values.
-
-Example
--------
-
-::
-
- sensVal = max(senVal, 20); // assigns sensVal to the larger of sensVal or 20
- // (effectively ensuring that it is at least 20)
-
-.. note:: Perhaps counter-intuitively, max() is often used to
- constrain the lower end of a variable's range, while :ref:`min()
- <lang-min>` is used to constrain the upper end of the range.
-
-Warning
--------
-
-Because of the way ``max()`` is implemented, avoid using other
-functions inside the parentheses. It may lead to incorrect results::
-
- max(a--, 0); // avoid this - yields incorrect results
-
- a--; // use this instead -
- max(a, 0); // keep other operations outside max()
-
-Arduino Compatibility
----------------------
-
-The Maple version of ``max()`` is compatible with Arduino.
-
-See Also
---------
-
-- :ref:`min() <lang-min>`
-- :ref:`constrain() <lang-constrain>`
-
-
-.. include:: cc-attribution.txt