c705279bae
This change ony concerns directives that appear in the document body. The guidelines for inserting version directives: * Baseline version is CMake 3.0, i.e. directives start at 3.1. * Always use `.. versionadded::` directive, avoid ad-hoc version references. Exception: policy pages. * For new command signatures, put `versionadded` on a separate line after the signature. * For a group of new signatures in a new document section, a single version note at the beginning of the section is sufficient. * For new options, put `versionadded` on a separate line before option description. * If all the option descriptions in the list are short one-liners, it's fine to put `versionadded` on the same line as the description. * If multiple option descriptions in close proximity would have the same ..versionadded directive, consider adding a single directive after the list, mentioning all added options. * For compact value lists and sub-option lists, put a single `versionadded` directive after the list mentioning all additions. * When a change is described in a single paragraph, put `versionadded` into that paragraph. * When only part of the paragraph has changed, separate the changed part if it doesn't break the flow. Otherwise, write a follow-up clarification paragraph and apply version directive to that. * When multiple version directives are close by, order earlier additions before later additions. * Indent related lists and code blocks to include them in the scope of `versionadded` directive. Issue: #19715
39 lines
1.2 KiB
ReStructuredText
39 lines
1.2 KiB
ReStructuredText
math
|
|
----
|
|
|
|
Evaluate a mathematical expression.
|
|
|
|
.. code-block:: cmake
|
|
|
|
math(EXPR <variable> "<expression>" [OUTPUT_FORMAT <format>])
|
|
|
|
Evaluates a mathematical ``<expression>`` and sets ``<variable>`` to the
|
|
resulting value. The result of the expression must be representable as a
|
|
64-bit signed integer.
|
|
|
|
The mathematical expression must be given as a string (i.e. enclosed in
|
|
double quotation marks). An example is ``"5 * (10 + 13)"``.
|
|
Supported operators are ``+``, ``-``, ``*``, ``/``, ``%``, ``|``, ``&``,
|
|
``^``, ``~``, ``<<``, ``>>``, and ``(...)``; they have the same meaning
|
|
as in C code.
|
|
|
|
.. versionadded:: 3.13
|
|
Hexadecimal numbers are recognized when prefixed with ``0x``, as in C code.
|
|
|
|
.. versionadded:: 3.13
|
|
The result is formatted according to the option ``OUTPUT_FORMAT``,
|
|
where ``<format>`` is one of
|
|
|
|
``HEXADECIMAL``
|
|
Hexadecimal notation as in C code, i. e. starting with "0x".
|
|
``DECIMAL``
|
|
Decimal notation. Which is also used if no ``OUTPUT_FORMAT`` option
|
|
is specified.
|
|
|
|
For example
|
|
|
|
.. code-block:: cmake
|
|
|
|
math(EXPR value "100 * 0xA" OUTPUT_FORMAT DECIMAL) # value is set to "1000"
|
|
math(EXPR value "100 * 0xA" OUTPUT_FORMAT HEXADECIMAL) # value is set to "0x3e8"
|