xref: /aosp_15_r20/external/pigweed/pw_numeric/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1.. _module-pw_numeric:
2
3==========
4pw_numeric
5==========
6.. pigweed-module::
7   :name: pw_numeric
8
9``pw_numeric`` is a collection of mathematical utilities optimized for embedded
10systems.
11
12**What belongs in this module?**
13
14Any standalone mathematical, numerical, or statisitical utilities that are
15optimized for embedded belong in ``pw_numeric``. This encompasses a broad area,
16but since the C++ standard library provides many mathematical utilities already,
17this module is not anticipated to be too large. If the module does grow
18substantially, some features may be moved to other modules (e.g.
19``pw_statistics``).
20
21**What does NOT belong in this module?**
22
23- Features available in the C++ standard library (``<cmath>``, ``<numeric>``,
24  ``<bit>``, etc.) should not be duplicated.
25- Pseudo-random number generation belongs in :ref:`module-pw_random`.
26- Data integrity checking belongs in :ref:`module-pw_checksum`.
27- Bit / byte manipulation belong in :ref:`module-pw_bytes`.
28
29-----------------
30C++ API reference
31-----------------
32
33pw_numeric/integer_division.h
34=============================
35.. doxygenfunction:: pw::IntegerDivisionRoundNearest
36