The math.h File Reference
C++ header file with declarations for the µTest++ mathematical utilities. More...
Included Headers
#include <array>Namespaces Index
| namespace | micro_os_plus |
The primary namespace for the µOS++ framework. More... | |
| namespace | micro_os_plus::micro_test_plus |
Primary namespace for the µTest++ testing framework. More... | |
| namespace | micro_os_plus::micro_test_plus::math |
Mathematical utilities for the µTest++ testing framework. More... | |
Functions Index
| constexpr T | abs (const T t) |
Computes the absolute value of a given comparable value. More... | |
| constexpr T | den (void) |
Computes the decimal part of a number represented as an array of characters. More... | |
| constexpr T | den_size (Value_T value) |
Computes the number of decimal places of a value, up to 7 digits. More... | |
| constexpr T | den_size (void) |
Computes the number of decimal places in a number represented as an array of characters. More... | |
| constexpr const T & | min_value (const T &lhs, const T &rhs) |
Computes the minimum of two comparable values. More... | |
| constexpr T | num (void) |
Computes the integral value of a number represented as an array of characters. More... | |
| constexpr T | pow (const T base, const Exp_T exp) |
Generic exponentiation function to compute the power of a base raised to an exponent. More... | |
Description
C++ header file with declarations for the µTest++ mathematical utilities.
This header provides the declarations for the mathematical utility templates used within the µTest++ framework. It defines interfaces for a suite of constexpr mathematical functions, including absolute value, minimum value selection, exponentiation, and compile-time parsing of numeric values from character sequences.
These utilities are designed to be lightweight and suitable for embedded environments, supporting both integral and floating-point types, and enabling expressive, type-safe, and efficient compile-time computations. Special attention is given to constexpr compatibility and minimal reliance on the standard library, ensuring portability and performance across a wide range of platforms.
All definitions reside within the micro_os_plus::micro_test_plus::math namespace, ensuring clear separation from user code and minimising the risk of naming conflicts.
The header files are organised within the include/micro-os-plus/micro-test-plus folder to maintain a structured and modular codebase.
This file is intended solely for internal use within the framework and should not be included directly by user code.
Functions
abs()
| nodiscardconstexpr |
Computes the absolute value of a given comparable value.
This function template provides a generic, constexpr implementation for obtaining the absolute value of any type that supports comparison and unary negation.
The function returns the non-negative value of the input. If the input is less than the default-constructed value of its type (typically zero), the negated value is returned; otherwise, the original value is returned.
This utility is designed to be lightweight and suitable for embedded environments, where standard library alternatives may be unavailable, less efficient, or not constexpr.
- Template Parameters
T The type of the input value. Must support comparison and unary negation.
- Parameters
t The value for which the absolute value is to be computed.
- Returns
The absolute value of the input.
Definition at line 96 of file math-inlines.h.
den()
| nodiscardconstexpr |
Computes the decimal part of a number represented as an array of characters.
This function template performs compile-time extraction of the decimal (fractional) part from a sequence of characters, typically provided as a template parameter pack.
The function expects the character sequence to represent a numeric value, where all characters are either digits, a dot (.), or an apostrophe (‘``). Parsing begins after the first dot, accumulating the decimal digits as an integer value, each weighted by its decimal position.
This utility is particularly useful for user-defined literals and other compile-time constant expressions, enabling efficient and type-safe conversion from character sequences to the decimal part of numeric values.
- Template Parameters
T The target integral type for the result. Cs The character pack representing the numeric value.
- Parameters
None.
- Returns
The parsed decimal part as an integral value of type
T.
Definition at line 200 of file math-inlines.h.
den_size()
| nodiscardconstexpr |
Computes the number of decimal places of a value, up to 7 digits.
This function template determines, at compile time, the number of decimal (fractional) digits present in a floating-point value, up to a maximum of seven digits of precision.
The function repeatedly multiplies the input value by ten, incrementing a counter until the fractional part is less than a defined precision threshold (1e-7). This approach provides a robust means of estimating decimal precision for values where exact representation is not possible due to floating-point limitations.
This utility is particularly useful for user-defined literals and compile-time constant expressions, enabling efficient and type-safe determination of decimal precision from floating-point values.
- Template Parameters
T The integral type for the result. Value_T The type of the input value, typically a floating-point type.
- Parameters
value The value whose decimal precision is to be determined.
- Returns
The number of decimal places, as a value of type
T, up to a maximum of seven.
Definition at line 269 of file math-inlines.h.
den_size()
| nodiscardconstexpr |
Computes the number of decimal places in a number represented as an array of characters.
This function template determines, at compile time, the number of decimal (fractional) digits present in a numeric value represented by a character sequence, typically provided as a template parameter pack.
The function expects the character sequence to represent a numeric value, where all characters are either digits, a dot (.), or an apostrophe (‘``). It locates the first dot and counts the number of digits that follow, returning the count as the number of decimal places.
This utility is particularly useful for user-defined literals and other compile-time constant expressions, enabling efficient and type-safe determination of decimal precision from character sequences.
- Template Parameters
T The integral type for the result. Cs The character pack representing the numeric value.
- Parameters
None.
- Returns
The number of decimal places as a value of type
T.
Definition at line 233 of file math-inlines.h.
min_value()
| nodiscardconstexpr |
Computes the minimum of two comparable values.
This function template provides a generic, constexpr implementation for determining the minimum of two values of any type that supports comparison.
The function returns a reference to the lesser of the two input values, as determined by the < operator. If the second argument is less than the first, it is returned; otherwise, the first argument is returned.
This utility is designed to be lightweight and suitable for embedded environments, where standard library alternatives may be unavailable, less efficient, or not constexpr.
- Template Parameters
T The type of the input values. Must support comparison via the <operator.
- Parameters
lhs The first value to compare. rhs The second value to compare.
- Returns
A reference to the minimum of the two input values.
Definition at line 117 of file math-inlines.h.
num()
| nodiscardconstexpr |
Computes the integral value of a number represented as an array of characters.
This function template performs compile-time parsing of a numeric value from a sequence of characters, typically provided as a template parameter pack.
The function assumes that all characters are either digits, a dot (.), or an apostrophe (‘``). Parsing stops at the first dot, allowing the function to extract only the integral part of the number.
This utility is particularly useful for user-defined literals and other compile-time constant expressions, enabling efficient and type-safe conversion from character sequences to integral values.
- Template Parameters
T The target integral type for the result. Cs The character pack representing the numeric value.
- Parameters
None.
- Returns
The parsed integral value of type
T.
Definition at line 160 of file math-inlines.h.
pow()
| nodiscardconstexpr |
Generic exponentiation function to compute the power of a base raised to an exponent.
This function template provides a constexpr implementation for raising a base value to a given exponent, supporting any types that allow multiplication and subtraction.
The function recursively multiplies the base by itself exponent times. If the exponent is zero, the function returns one (the multiplicative identity for the type).
This utility is designed to be lightweight and suitable for embedded environments, where standard library alternatives may be unavailable, less efficient, or not constexpr.
- Template Parameters
T The type of the base value. Must support multiplication and construction from an integer. Exp_T The type of the exponent. Must support subtraction and comparison to zero.
- Parameters
base The base value to be raised to the power of exp.exp The exponent value.
- Returns
The result of raising
baseto the power ofexp.
Definition at line 138 of file math-inlines.h.
File Listing
The file content with the documentation metadata removed is:
Generated via docusaurus-plugin-doxygen by Doxygen 1.14.0.