aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/arduino/min.rst
blob: fdd7a5f4f39c6780b9fea3a40a7117666e501367 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
.. _arduino-min:

min(x, y)
=========

Description
-----------

Calculates the minimum of two numbers.



Parameters
----------

x: the first number, any data type



y: the second number, any data type



Returns
-------

The smaller of the two numbers.



Examples
--------

::

    sensVal = min(sensVal, 100); // assigns sensVal to the smaller of sensVal or 100
                                 // ensuring that it never gets above 100.

Note
----

Perhaps counter-intuitively, max() is often used to constrain the
lower end of a variable's range, while min() is used to constrain
the upper end of the range.



Warning
-------

Because of the way the min() function is implemented, avoid using
other functions inside the brackets, it may lead to incorrect
results



::

    min(a++, 100);   // avoid this - yields incorrect results
    
    a++;
    min(a, 100);    // use this instead - keep other math outside the function



See also
--------


-  `max <http://arduino.cc/en/Reference/Max>`_\ ()
-  `constrain <http://arduino.cc/en/Reference/Constrain>`_\ ()