1// © 2017 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3
4#include "unicode/utypes.h"
5
6#if !UCONFIG_NO_FORMATTING
7
8#include "uassert.h"
9#include "unicode/numberformatter.h"
10#include "number_types.h"
11#include "number_decimalquantity.h"
12#include "double-conversion.h"
13#include "number_roundingutils.h"
14#include "putilimp.h"
15
16using namespace icu;
17using namespace icu::number;
18using namespace icu::number::impl;
19
20
21using double_conversion::DoubleToStringConverter;
22
23namespace {
24
25int32_t getRoundingMagnitudeFraction(int maxFrac) {
26 if (maxFrac == -1) {
27 return INT32_MIN;
28 }
29 return -maxFrac;
30}
31
32int32_t getRoundingMagnitudeSignificant(const DecimalQuantity &value, int maxSig) {
33 if (maxSig == -1) {
34 return INT32_MIN;
35 }
36 int magnitude = value.isZeroish() ? 0 : value.getMagnitude();
37 return magnitude - maxSig + 1;
38}
39
40int32_t getDisplayMagnitudeFraction(int minFrac) {
41 if (minFrac == 0) {
42 return INT32_MAX;
43 }
44 return -minFrac;
45}
46
47int32_t getDisplayMagnitudeSignificant(const DecimalQuantity &value, int minSig) {
48 int magnitude = value.isZeroish() ? 0 : value.getMagnitude();
49 return magnitude - minSig + 1;
50}
51
52}
53
54
55MultiplierProducer::~MultiplierProducer() = default;
56
57
58digits_t roundingutils::doubleFractionLength(double input, int8_t* singleDigit) {
59 char buffer[DoubleToStringConverter::kBase10MaximalLength + 1];
60 bool sign; // unused; always positive
61 int32_t length;
62 int32_t point;
63 DoubleToStringConverter::DoubleToAscii(
64 input,
65 DoubleToStringConverter::DtoaMode::SHORTEST,
66 0,
67 buffer,
68 sizeof(buffer),
69 &sign,
70 &length,
71 &point
72 );
73
74 if (singleDigit == nullptr) {
75 // no-op
76 } else if (length == 1) {
77 *singleDigit = buffer[0] - '0';
78 } else {
79 *singleDigit = -1;
80 }
81
82 return static_cast<digits_t>(length - point);
83}
84
85
86Precision Precision::unlimited() {
87 return Precision(RND_NONE, {}, kDefaultMode);
88}
89
90FractionPrecision Precision::integer() {
91 return constructFraction(0, 0);
92}
93
94FractionPrecision Precision::fixedFraction(int32_t minMaxFractionPlaces) {
95 if (minMaxFractionPlaces >= 0 && minMaxFractionPlaces <= kMaxIntFracSig) {
96 return constructFraction(minMaxFractionPlaces, minMaxFractionPlaces);
97 } else {
98 return {U_NUMBER_ARG_OUTOFBOUNDS_ERROR};
99 }
100}
101
102FractionPrecision Precision::minFraction(int32_t minFractionPlaces) {
103 if (minFractionPlaces >= 0 && minFractionPlaces <= kMaxIntFracSig) {
104 return constructFraction(minFractionPlaces, -1);
105 } else {
106 return {U_NUMBER_ARG_OUTOFBOUNDS_ERROR};
107 }
108}
109
110FractionPrecision Precision::maxFraction(int32_t maxFractionPlaces) {
111 if (maxFractionPlaces >= 0 && maxFractionPlaces <= kMaxIntFracSig) {
112 return constructFraction(0, maxFractionPlaces);
113 } else {
114 return {U_NUMBER_ARG_OUTOFBOUNDS_ERROR};
115 }
116}
117
118FractionPrecision Precision::minMaxFraction(int32_t minFractionPlaces, int32_t maxFractionPlaces) {
119 if (minFractionPlaces >= 0 && maxFractionPlaces <= kMaxIntFracSig &&
120 minFractionPlaces <= maxFractionPlaces) {
121 return constructFraction(minFractionPlaces, maxFractionPlaces);
122 } else {
123 return {U_NUMBER_ARG_OUTOFBOUNDS_ERROR};
124 }
125}
126
127Precision Precision::fixedSignificantDigits(int32_t minMaxSignificantDigits) {
128 if (minMaxSignificantDigits >= 1 && minMaxSignificantDigits <= kMaxIntFracSig) {
129 return constructSignificant(minMaxSignificantDigits, minMaxSignificantDigits);
130 } else {
131 return {U_NUMBER_ARG_OUTOFBOUNDS_ERROR};
132 }
133}
134
135Precision Precision::minSignificantDigits(int32_t minSignificantDigits) {
136 if (minSignificantDigits >= 1 && minSignificantDigits <= kMaxIntFracSig) {
137 return constructSignificant(minSignificantDigits, -1);
138 } else {
139 return {U_NUMBER_ARG_OUTOFBOUNDS_ERROR};
140 }
141}
142
143Precision Precision::maxSignificantDigits(int32_t maxSignificantDigits) {
144 if (maxSignificantDigits >= 1 && maxSignificantDigits <= kMaxIntFracSig) {
145 return constructSignificant(1, maxSignificantDigits);
146 } else {
147 return {U_NUMBER_ARG_OUTOFBOUNDS_ERROR};
148 }
149}
150
151Precision Precision::minMaxSignificantDigits(int32_t minSignificantDigits, int32_t maxSignificantDigits) {
152 if (minSignificantDigits >= 1 && maxSignificantDigits <= kMaxIntFracSig &&
153 minSignificantDigits <= maxSignificantDigits) {
154 return constructSignificant(minSignificantDigits, maxSignificantDigits);
155 } else {
156 return {U_NUMBER_ARG_OUTOFBOUNDS_ERROR};
157 }
158}
159
160IncrementPrecision Precision::increment(double roundingIncrement) {
161 if (roundingIncrement > 0.0) {
162 return constructIncrement(roundingIncrement, 0);
163 } else {
164 return {U_NUMBER_ARG_OUTOFBOUNDS_ERROR};
165 }
166}
167
168CurrencyPrecision Precision::currency(UCurrencyUsage currencyUsage) {
169 return constructCurrency(currencyUsage);
170}
171
172Precision FractionPrecision::withMinDigits(int32_t minSignificantDigits) const {
173 if (fType == RND_ERROR) { return *this; } // no-op in error state
174 if (minSignificantDigits >= 1 && minSignificantDigits <= kMaxIntFracSig) {
175 return constructFractionSignificant(*this, minSignificantDigits, -1);
176 } else {
177 return {U_NUMBER_ARG_OUTOFBOUNDS_ERROR};
178 }
179}
180
181Precision FractionPrecision::withMaxDigits(int32_t maxSignificantDigits) const {
182 if (fType == RND_ERROR) { return *this; } // no-op in error state
183 if (maxSignificantDigits >= 1 && maxSignificantDigits <= kMaxIntFracSig) {
184 return constructFractionSignificant(*this, -1, maxSignificantDigits);
185 } else {
186 return {U_NUMBER_ARG_OUTOFBOUNDS_ERROR};
187 }
188}
189
190// Private method on base class
191Precision Precision::withCurrency(const CurrencyUnit &currency, UErrorCode &status) const {
192 if (fType == RND_ERROR) { return *this; } // no-op in error state
193 U_ASSERT(fType == RND_CURRENCY);
194 const char16_t *isoCode = currency.getISOCurrency();
195 double increment = ucurr_getRoundingIncrementForUsage(isoCode, fUnion.currencyUsage, &status);
196 int32_t minMaxFrac = ucurr_getDefaultFractionDigitsForUsage(
197 isoCode, fUnion.currencyUsage, &status);
198 if (increment != 0.0) {
199 return constructIncrement(increment, minMaxFrac);
200 } else {
201 return constructFraction(minMaxFrac, minMaxFrac);
202 }
203}
204
205// Public method on CurrencyPrecision subclass
206Precision CurrencyPrecision::withCurrency(const CurrencyUnit &currency) const {
207 UErrorCode localStatus = U_ZERO_ERROR;
208 Precision result = Precision::withCurrency(currency, localStatus);
209 if (U_FAILURE(localStatus)) {
210 return {localStatus};
211 }
212 return result;
213}
214
215Precision IncrementPrecision::withMinFraction(int32_t minFrac) const {
216 if (fType == RND_ERROR) { return *this; } // no-op in error state
217 if (minFrac >= 0 && minFrac <= kMaxIntFracSig) {
218 return constructIncrement(fUnion.increment.fIncrement, minFrac);
219 } else {
220 return {U_NUMBER_ARG_OUTOFBOUNDS_ERROR};
221 }
222}
223
224FractionPrecision Precision::constructFraction(int32_t minFrac, int32_t maxFrac) {
225 FractionSignificantSettings settings;
226 settings.fMinFrac = static_cast<digits_t>(minFrac);
227 settings.fMaxFrac = static_cast<digits_t>(maxFrac);
228 settings.fMinSig = -1;
229 settings.fMaxSig = -1;
230 PrecisionUnion union_;
231 union_.fracSig = settings;
232 return {RND_FRACTION, union_, kDefaultMode};
233}
234
235Precision Precision::constructSignificant(int32_t minSig, int32_t maxSig) {
236 FractionSignificantSettings settings;
237 settings.fMinFrac = -1;
238 settings.fMaxFrac = -1;
239 settings.fMinSig = static_cast<digits_t>(minSig);
240 settings.fMaxSig = static_cast<digits_t>(maxSig);
241 PrecisionUnion union_;
242 union_.fracSig = settings;
243 return {RND_SIGNIFICANT, union_, kDefaultMode};
244}
245
246Precision
247Precision::constructFractionSignificant(const FractionPrecision &base, int32_t minSig, int32_t maxSig) {
248 FractionSignificantSettings settings = base.fUnion.fracSig;
249 settings.fMinSig = static_cast<digits_t>(minSig);
250 settings.fMaxSig = static_cast<digits_t>(maxSig);
251 PrecisionUnion union_;
252 union_.fracSig = settings;
253 return {RND_FRACTION_SIGNIFICANT, union_, kDefaultMode};
254}
255
256IncrementPrecision Precision::constructIncrement(double increment, int32_t minFrac) {
257 IncrementSettings settings;
258 // Note: For number formatting, fIncrement is used for RND_INCREMENT but not
259 // RND_INCREMENT_ONE or RND_INCREMENT_FIVE. However, fIncrement is used in all
260 // three when constructing a skeleton.
261 settings.fIncrement = increment;
262 settings.fMinFrac = static_cast<digits_t>(minFrac);
263 // One of the few pre-computed quantities:
264 // Note: it is possible for minFrac to be more than maxFrac... (misleading)
265 int8_t singleDigit;
266 settings.fMaxFrac = roundingutils::doubleFractionLength(increment, &singleDigit);
267 PrecisionUnion union_;
268 union_.increment = settings;
269 if (singleDigit == 1) {
270 // NOTE: In C++, we must return the correct value type with the correct union.
271 // It would be invalid to return a RND_FRACTION here because the methods on the
272 // IncrementPrecision type assume that the union is backed by increment data.
273 return {RND_INCREMENT_ONE, union_, kDefaultMode};
274 } else if (singleDigit == 5) {
275 return {RND_INCREMENT_FIVE, union_, kDefaultMode};
276 } else {
277 return {RND_INCREMENT, union_, kDefaultMode};
278 }
279}
280
281CurrencyPrecision Precision::constructCurrency(UCurrencyUsage usage) {
282 PrecisionUnion union_;
283 union_.currencyUsage = usage;
284 return {RND_CURRENCY, union_, kDefaultMode};
285}
286
287
288RoundingImpl::RoundingImpl(const Precision& precision, UNumberFormatRoundingMode roundingMode,
289 const CurrencyUnit& currency, UErrorCode& status)
290 : fPrecision(precision), fRoundingMode(roundingMode), fPassThrough(false) {
291 if (precision.fType == Precision::RND_CURRENCY) {
292 fPrecision = precision.withCurrency(currency, status);
293 }
294}
295
296RoundingImpl RoundingImpl::passThrough() {
297 return {};
298}
299
300bool RoundingImpl::isSignificantDigits() const {
301 return fPrecision.fType == Precision::RND_SIGNIFICANT;
302}
303
304int32_t
305RoundingImpl::chooseMultiplierAndApply(impl::DecimalQuantity &input, const impl::MultiplierProducer &producer,
306 UErrorCode &status) {
307 // Do not call this method with zero, NaN, or infinity.
308 U_ASSERT(!input.isZeroish());
309
310 // Perform the first attempt at rounding.
311 int magnitude = input.getMagnitude();
312 int multiplier = producer.getMultiplier(magnitude);
313 input.adjustMagnitude(multiplier);
314 apply(input, status);
315
316 // If the number rounded to zero, exit.
317 if (input.isZeroish() || U_FAILURE(status)) {
318 return multiplier;
319 }
320
321 // If the new magnitude after rounding is the same as it was before rounding, then we are done.
322 // This case applies to most numbers.
323 if (input.getMagnitude() == magnitude + multiplier) {
324 return multiplier;
325 }
326
327 // If the above case DIDN'T apply, then we have a case like 99.9 -> 100 or 999.9 -> 1000:
328 // The number rounded up to the next magnitude. Check if the multiplier changes; if it doesn't,
329 // we do not need to make any more adjustments.
330 int _multiplier = producer.getMultiplier(magnitude + 1);
331 if (multiplier == _multiplier) {
332 return multiplier;
333 }
334
335 // We have a case like 999.9 -> 1000, where the correct output is "1K", not "1000".
336 // Fix the magnitude and re-apply the rounding strategy.
337 input.adjustMagnitude(_multiplier - multiplier);
338 apply(input, status);
339 return _multiplier;
340}
341
342/** This is the method that contains the actual rounding logic. */
343void RoundingImpl::apply(impl::DecimalQuantity &value, UErrorCode& status) const {
344 if (fPassThrough) {
345 return;
346 }
347 switch (fPrecision.fType) {
348 case Precision::RND_BOGUS:
349 case Precision::RND_ERROR:
350 // Errors should be caught before the apply() method is called
351 status = U_INTERNAL_PROGRAM_ERROR;
352 break;
353
354 case Precision::RND_NONE:
355 value.roundToInfinity();
356 break;
357
358 case Precision::RND_FRACTION:
359 value.roundToMagnitude(
360 getRoundingMagnitudeFraction(fPrecision.fUnion.fracSig.fMaxFrac),
361 fRoundingMode,
362 status);
363 value.setMinFraction(
364 uprv_max(0, -getDisplayMagnitudeFraction(fPrecision.fUnion.fracSig.fMinFrac)));
365 break;
366
367 case Precision::RND_SIGNIFICANT:
368 value.roundToMagnitude(
369 getRoundingMagnitudeSignificant(value, fPrecision.fUnion.fracSig.fMaxSig),
370 fRoundingMode,
371 status);
372 value.setMinFraction(
373 uprv_max(0, -getDisplayMagnitudeSignificant(value, fPrecision.fUnion.fracSig.fMinSig)));
374 // Make sure that digits are displayed on zero.
375 if (value.isZeroish() && fPrecision.fUnion.fracSig.fMinSig > 0) {
376 value.setMinInteger(1);
377 }
378 break;
379
380 case Precision::RND_FRACTION_SIGNIFICANT: {
381 int32_t displayMag = getDisplayMagnitudeFraction(fPrecision.fUnion.fracSig.fMinFrac);
382 int32_t roundingMag = getRoundingMagnitudeFraction(fPrecision.fUnion.fracSig.fMaxFrac);
383 if (fPrecision.fUnion.fracSig.fMinSig == -1) {
384 // Max Sig override
385 int32_t candidate = getRoundingMagnitudeSignificant(
386 value,
387 fPrecision.fUnion.fracSig.fMaxSig);
388 roundingMag = uprv_max(roundingMag, candidate);
389 } else {
390 // Min Sig override
391 int32_t candidate = getDisplayMagnitudeSignificant(
392 value,
393 fPrecision.fUnion.fracSig.fMinSig);
394 roundingMag = uprv_min(roundingMag, candidate);
395 }
396 value.roundToMagnitude(roundingMag, fRoundingMode, status);
397 value.setMinFraction(uprv_max(0, -displayMag));
398 break;
399 }
400
401 case Precision::RND_INCREMENT:
402 value.roundToIncrement(
403 fPrecision.fUnion.increment.fIncrement,
404 fRoundingMode,
405 status);
406 value.setMinFraction(fPrecision.fUnion.increment.fMinFrac);
407 break;
408
409 case Precision::RND_INCREMENT_ONE:
410 value.roundToMagnitude(
411 -fPrecision.fUnion.increment.fMaxFrac,
412 fRoundingMode,
413 status);
414 value.setMinFraction(fPrecision.fUnion.increment.fMinFrac);
415 break;
416
417 case Precision::RND_INCREMENT_FIVE:
418 value.roundToNickel(
419 -fPrecision.fUnion.increment.fMaxFrac,
420 fRoundingMode,
421 status);
422 value.setMinFraction(fPrecision.fUnion.increment.fMinFrac);
423 break;
424
425 case Precision::RND_CURRENCY:
426 // Call .withCurrency() before .apply()!
427 UPRV_UNREACHABLE;
428
429 default:
430 UPRV_UNREACHABLE;
431 }
432}
433
434void RoundingImpl::apply(impl::DecimalQuantity &value, int32_t minInt, UErrorCode /*status*/) {
435 // This method is intended for the one specific purpose of helping print "00.000E0".
436 U_ASSERT(isSignificantDigits());
437 U_ASSERT(value.isZeroish());
438 value.setMinFraction(fPrecision.fUnion.fracSig.fMinSig - minInt);
439}
440
441#endif /* #if !UCONFIG_NO_FORMATTING */
442