icu::number::IncrementRounder Class Reference

A class that defines a rounding strategy parameterized by a rounding increment to be used when formatting numbers in NumberFormatter. More...

#include <numberformatter.h>

Inheritance diagram for icu::number::IncrementRounder:
icu::number::Rounder icu::UMemory

Public Member Functions

Rounder withMinFraction (int32_t minFrac) const
 Specifies the minimum number of fraction digits to render after the decimal separator, padding with zeros if necessary.

Friends

class Rounder

Detailed Description

A class that defines a rounding strategy parameterized by a rounding increment to be used when formatting numbers in NumberFormatter.

To create an IncrementRounder, use one of the factory methods on Rounder.

Draft:
This API may be changed in the future versions and was introduced in ICU 60

Definition at line 978 of file numberformatter.h.


Member Function Documentation

Rounder icu::number::IncrementRounder::withMinFraction ( int32_t  minFrac  )  const

Specifies the minimum number of fraction digits to render after the decimal separator, padding with zeros if necessary.

By default, no trailing zeros are added.

For example, if the rounding increment is 0.5 and minFrac is 2, then the resulting strings include "0.00", "0.50", "1.00", and "1.50".

Note: In ICU4J, this functionality is accomplished via the scale of the BigDecimal rounding increment.

Parameters:
minFrac The minimum number of digits after the decimal separator.
Returns:
A Rounder for chaining or passing to the NumberFormatter rounding() setter.
Draft:
This API may be changed in the future versions and was introduced in ICU 60

The documentation for this class was generated from the following file:

Generated on 15 Dec 2017 for ICU 60.1 by  doxygen 1.6.1