aboutsummaryrefslogtreecommitdiffstats
path: root/source/lang/abs.rst
blob: 0f71d9b5025d0071a3b97f578357dfab84d68a54 (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
.. highlight:: cpp

.. _lang-abs:

abs()
======

(Macro) computes the absolute value of a number.

Syntax
------

::

   abs(x)

Parameters
----------

**x**: the number.

Returns
-------

**x**: if **x** is greater than or equal to 0.

**-x**: if **x** is less than 0.

Warning
-------

Because of the way ``abs()`` is implemented, avoid using other
functions or causing side effects inside the parentheses, as it may
lead to incorrect results::

    abs(a++);   // avoid this - yields incorrect results

    abs(a);       // use this instead -
    a++;          // keep other operations outside abs()


Arduino Compatibility
---------------------

Maple's implementation of ``abs()`` is compatible with Arduino.


.. include:: cc-attribution.txt