A class that defines a rounding precision based on a number of fraction places and optionally significant digits to be used when formatting numbers in NumberFormatter. More...
#include <numberformatter.h>
Public Member Functions | |
| Precision | withSignificantDigits (int32_t minSignificantDigits, int32_t maxSignificantDigits, UNumberRoundingPriority priority) const |
| Override maximum fraction digits with maximum significant digits depending on the magnitude of the number. | |
| Precision | withMinDigits (int32_t minSignificantDigits) const |
| Ensure that no less than this number of significant digits are retained when rounding according to fraction rules. | |
| Precision | withMaxDigits (int32_t maxSignificantDigits) const |
| Ensure that no more than this number of significant digits are retained when rounding according to fraction rules. | |
Friends | |
| class | Precision |
Detailed Description
A class that defines a rounding precision based on a number of fraction places and optionally significant digits to be used when formatting numbers in NumberFormatter.
To create a FractionPrecision, use one of the factory methods on Precision.
- Stable:
- ICU 60
Definition at line 838 of file numberformatter.h.
Member Function Documentation
| Precision icu::number::FractionPrecision::withMaxDigits | ( | int32_t | maxSignificantDigits | ) | const |
Ensure that no more than this number of significant digits are retained when rounding according to fraction rules.
For example, with integer rounding, the number 123.4 becomes "123". However, with maximum figures set to 2, 123.4 becomes "120" instead.
This setting does not affect the number of trailing zeros. For example, with fixed fraction of 2, 123.4 would become "120.00".
This is equivalent to `withSignificantDigits(1, maxSignificantDigits, STRICT)`.
- Parameters:
-
maxSignificantDigits Round the number to no more than this number of significant figures.
- Returns:
- A precision for chaining or passing to the NumberFormatter precision() setter.
- Stable:
- ICU 60
| Precision icu::number::FractionPrecision::withMinDigits | ( | int32_t | minSignificantDigits | ) | const |
Ensure that no less than this number of significant digits are retained when rounding according to fraction rules.
For example, with integer rounding, the number 3.141 becomes "3". However, with minimum figures set to 2, 3.141 becomes "3.1" instead.
This setting does not affect the number of trailing zeros. For example, 3.01 would print as "3", not "3.0".
This is equivalent to `withSignificantDigits(1, minSignificantDigits, RELAXED)`.
- Parameters:
-
minSignificantDigits The number of significant figures to guarantee.
- Returns:
- A precision for chaining or passing to the NumberFormatter precision() setter.
- Stable:
- ICU 60
| Precision icu::number::FractionPrecision::withSignificantDigits | ( | int32_t | minSignificantDigits, |
| int32_t | maxSignificantDigits, | ||
| UNumberRoundingPriority | priority | ||
| ) | const |
Override maximum fraction digits with maximum significant digits depending on the magnitude of the number.
See UNumberRoundingPriority.
- Parameters:
-
minSignificantDigits Pad trailing zeros to achieve this minimum number of significant digits. maxSignificantDigits Round the number to achieve this maximum number of significant digits. priority How to disambiguate between fraction digits and significant digits.
- Returns:
- A precision for chaining or passing to the NumberFormatter precision() setter.
- Stable:
- ICU 69
The documentation for this class was generated from the following file:
