ICU 76.1: icu::CompactDecimalFormat Class Reference

ICU 76.1 76.1

Public Member Functions | Static Public Member Functions
icu::CompactDecimalFormat Class Reference

IMPORTANT: New users are strongly encouraged to see if numberformatter.h fits their use case. More...

`#include <compactdecimalformat.h>`

Inheritance diagram for icu::CompactDecimalFormat:

## Public Member Functions
| CompactDecimalFormat (const CompactDecimalFormat &source)
| Copy constructor.
| ~CompactDecimalFormat () override
| Destructor.
CompactDecimalFormat & | operator= (const CompactDecimalFormat &rhs)
| Assignment operator.
CompactDecimalFormat * | clone () const override
| Clone this Format object polymorphically.
void | parse (const UnicodeString &text, Formattable &result, ParsePosition &parsePosition) const override
| CompactDecimalFormat does not support parsing.
void | parse (const UnicodeString &text, Formattable &result, UErrorCode &status) const override
| CompactDecimalFormat does not support parsing.
CurrencyAmount * | parseCurrency (const UnicodeString &text, ParsePosition &pos) const override
| Parses text from the given string as a currency amount.
UClassID | getDynamicClassID () const override
| Returns a unique class ID POLYMORPHICALLY.
UnicodeString & | format (double number, UnicodeString &appendTo, FieldPosition &pos) const override
| Format a double or long number using base-10 representation.
UnicodeString & | format (double number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const override
| Format a double or long number using base-10 representation.
UnicodeString & | format (double number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const override
| Format a double or long number using base-10 representation.
UnicodeString & | format (int32_t number, UnicodeString &appendTo, FieldPosition &pos) const override
| Format a long number using base-10 representation.
UnicodeString & | format (int32_t number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const override
| Format a long number using base-10 representation.
UnicodeString & | format (int32_t number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const override
| Format a long number using base-10 representation.
UnicodeString & | format (int64_t number, UnicodeString &appendTo, FieldPosition &pos) const override
| Format an int64 number using base-10 representation.
UnicodeString & | format (int64_t number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const override
| Format an int64 number using base-10 representation.
UnicodeString & | format (int64_t number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const override
| Format an int64 number using base-10 representation.
UnicodeString & | format (StringPiece number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const override
| Format a decimal number.
UnicodeString & | format (const number::impl::DecimalQuantity &number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const override
| Format a decimal number.
UnicodeString & | format (const number::impl::DecimalQuantity &number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const override
| Format a decimal number.
Public Member Functions inherited from icu::DecimalFormat
| DecimalFormat (UErrorCode &status)
| Create a DecimalFormat using the default pattern and symbols for the default locale.
| DecimalFormat (const UnicodeString &pattern, UErrorCode &status)
| Create a DecimalFormat from the given pattern and the symbols for the default locale.
| DecimalFormat (const UnicodeString &pattern, DecimalFormatSymbols *symbolsToAdopt, UErrorCode &status)
| Create a DecimalFormat from the given pattern and symbols.
| DecimalFormat (const UnicodeString &pattern, DecimalFormatSymbols *symbolsToAdopt, UNumberFormatStyle style, UErrorCode &status)
| This API is for ICU use only.
virtual DecimalFormat & | setAttribute (UNumberFormatAttribute attr, int32_t newValue, UErrorCode &status)
| Set an integer attribute on this DecimalFormat.
virtual int32_t | getAttribute (UNumberFormatAttribute attr, UErrorCode &status) const
| Get an integer May return U_UNSUPPORTED_ERROR if this instance does not support the specified attribute.
void | setGroupingUsed (UBool newValue) override
| Set whether or not grouping will be used in this format.
void | setParseIntegerOnly (UBool value) override
| Sets whether or not numbers should be parsed as integers only.
void | setLenient (UBool enable) override
| Sets whether lenient parsing should be enabled (it is off by default).
| DecimalFormat (const UnicodeString &pattern, DecimalFormatSymbols *symbolsToAdopt, UParseError &parseError, UErrorCode &status)
| Create a DecimalFormat from the given pattern and symbols.
| DecimalFormat (const UnicodeString &pattern, const DecimalFormatSymbols &symbols, UErrorCode &status)
| Create a DecimalFormat from the given pattern and symbols.
| DecimalFormat (const DecimalFormat &source)
| Copy constructor.
DecimalFormat & | operator= (const DecimalFormat &rhs)
| Assignment operator.
| ~DecimalFormat () override
| Destructor.
DecimalFormat * | clone () const override
| Clone this Format object polymorphically.
bool | operator== (const Format &other) const override
| Return true if the given Format objects are semantically equal.
UnicodeString & | format (double number, UnicodeString &appendTo, FieldPosition &pos) const override
| Format a double or long number using base-10 representation.
UnicodeString & | format (double number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const override
| Format a double or long number using base-10 representation.
UnicodeString & | format (double number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const override
| Format a double or long number using base-10 representation.
UnicodeString & | format (int32_t number, UnicodeString &appendTo, FieldPosition &pos) const override
| Format a long number using base-10 representation.
UnicodeString & | format (int32_t number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const override
| Format a long number using base-10 representation.
UnicodeString & | format (int32_t number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const override
| Format a long number using base-10 representation.
UnicodeString & | format (int64_t number, UnicodeString &appendTo, FieldPosition &pos) const override
| Format an int64 number using base-10 representation.
UnicodeString & | format (int64_t number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const override
| Format an int64 number using base-10 representation.
UnicodeString & | format (int64_t number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const override
| Format an int64 number using base-10 representation.
UnicodeString & | format (StringPiece number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const override
| Format a decimal number.
UnicodeString & | format (const number::impl::DecimalQuantity &number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const override
| Format a decimal number.
UnicodeString & | format (const number::impl::DecimalQuantity &number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const override
| Format a decimal number.
void | parse (const UnicodeString &text, Formattable &result, ParsePosition &parsePosition) const override
| Parse the given string using this object's choices.
CurrencyAmount * | parseCurrency (const UnicodeString &text, ParsePosition &pos) const override
| Parses text from the given string as a currency amount.
virtual const DecimalFormatSymbols * | getDecimalFormatSymbols () const
| Returns the decimal format symbols, which is generally not changed by the programmer or user.
virtual void | adoptDecimalFormatSymbols (DecimalFormatSymbols *symbolsToAdopt)
| Sets the decimal format symbols, which is generally not changed by the programmer or user.
virtual void | setDecimalFormatSymbols (const DecimalFormatSymbols &symbols)
| Sets the decimal format symbols, which is generally not changed by the programmer or user.
virtual const CurrencyPluralInfo * | getCurrencyPluralInfo () const
| Returns the currency plural format information, which is generally not changed by the programmer or user.
virtual void | adoptCurrencyPluralInfo (CurrencyPluralInfo *toAdopt)
| Sets the currency plural format information, which is generally not changed by the programmer or user.
virtual void | setCurrencyPluralInfo (const CurrencyPluralInfo &info)
| Sets the currency plural format information, which is generally not changed by the programmer or user.
UnicodeString & | getPositivePrefix (UnicodeString &result) const
| Get the positive prefix.
virtual void | setPositivePrefix (const UnicodeString &newValue)
| Set the positive prefix.
UnicodeString & | getNegativePrefix (UnicodeString &result) const
| Get the negative prefix.
virtual void | setNegativePrefix (const UnicodeString &newValue)
| Set the negative prefix.
UnicodeString & | getPositiveSuffix (UnicodeString &result) const
| Get the positive suffix.
virtual void | setPositiveSuffix (const UnicodeString &newValue)
| Set the positive suffix.
UnicodeString & | getNegativeSuffix (UnicodeString &result) const
| Get the negative suffix.
virtual void | setNegativeSuffix (const UnicodeString &newValue)
| Set the negative suffix.
UBool | isSignAlwaysShown () const
| Whether to show the plus sign on positive (non-negative) numbers; for example, "+12".
void | setSignAlwaysShown (UBool value)
| Set whether to show the plus sign on positive (non-negative) numbers; for example, "+12".
int32_t | getMultiplier () const
| Get the multiplier for use in percent, permill, etc.
virtual void | setMultiplier (int32_t newValue)
| Set the multiplier for use in percent, permill, etc.
int32_t | getMultiplierScale () const
| Gets the power of ten by which number should be multiplied before formatting, which can be combined with setMultiplier() to multiply by any arbitrary decimal value.
void | setMultiplierScale (int32_t newValue)
| Sets a power of ten by which number should be multiplied before formatting, which can be combined with setMultiplier() to multiply by any arbitrary decimal value.
virtual double | getRoundingIncrement () const
| Get the rounding increment.
virtual void | setRoundingIncrement (double newValue)
| Set the rounding increment.
virtual ERoundingMode | getRoundingMode () const override
| Get the rounding mode.
virtual void | setRoundingMode (ERoundingMode roundingMode) override
| Set the rounding mode.
virtual int32_t | getFormatWidth () const
| Get the width to which the output of format() is padded.
virtual void | setFormatWidth (int32_t width)
| Set the width to which the output of format() is padded.
virtual UnicodeString | getPadCharacterString () const
| Get the pad character used to pad to the format width.
virtual void | setPadCharacter (const UnicodeString &padChar)
| Set the character used to pad to the format width.
virtual EPadPosition | getPadPosition () const
| Get the position at which padding will take place.
virtual void | setPadPosition (EPadPosition padPos)
| Set the position at which padding will take place.
virtual UBool | isScientificNotation () const
| Return whether or not scientific notation is used.
virtual void | setScientificNotation (UBool useScientific)
| Set whether or not scientific notation is used.
virtual int8_t | getMinimumExponentDigits () const
| Return the minimum exponent digits that will be shown.
virtual void | setMinimumExponentDigits (int8_t minExpDig)
| Set the minimum exponent digits that will be shown.
virtual UBool | isExponentSignAlwaysShown () const
| Return whether the exponent sign is always shown.
virtual void | setExponentSignAlwaysShown (UBool expSignAlways)
| Set whether the exponent sign is always shown.
int32_t | getGroupingSize () const
| Return the grouping size.
virtual void | setGroupingSize (int32_t newValue)
| Set the grouping size.
int32_t | getSecondaryGroupingSize () const
| Return the secondary grouping size.
virtual void | setSecondaryGroupingSize (int32_t newValue)
| Set the secondary grouping size.
int32_t | getMinimumGroupingDigits () const
| Returns the minimum number of grouping digits.
void | setMinimumGroupingDigits (int32_t newValue)
| Sets the minimum grouping digits.
UBool | isDecimalSeparatorAlwaysShown () const
| Allows you to get the behavior of the decimal separator with integers.
virtual void | setDecimalSeparatorAlwaysShown (UBool newValue)
| Allows you to set the behavior of the decimal separator with integers.
UBool | isDecimalPatternMatchRequired () const
| Allows you to get the parse behavior of the pattern decimal mark.
virtual void | setDecimalPatternMatchRequired (UBool newValue)
| Allows you to set the parse behavior of the pattern decimal mark.
UBool | isParseNoExponent () const
| Returns whether to ignore exponents when parsing.
void | setParseNoExponent (UBool value)
| Specifies whether to stop parsing when an exponent separator is encountered.
UBool | isParseCaseSensitive () const
| Returns whether parsing is sensitive to case (lowercase/uppercase).
void | setParseCaseSensitive (UBool value)
| Whether to pay attention to case when parsing; default is to ignore case (perform case-folding).
UBool | isFormatFailIfMoreThanMaxDigits () const
| Returns whether truncation of high-order integer digits should result in an error.
void | setFormatFailIfMoreThanMaxDigits (UBool value)
| Sets whether truncation of high-order integer digits should result in an error.
virtual UnicodeString & | toPattern (UnicodeString &result) const
| Synthesizes a pattern string that represents the current state of this Format object.
virtual UnicodeString & | toLocalizedPattern (UnicodeString &result) const
| Synthesizes a localized pattern string that represents the current state of this Format object.
virtual void | applyPattern (const UnicodeString &pattern, UParseError &parseError, UErrorCode &status)
| Apply the given pattern to this Format object.
virtual void | applyPattern (const UnicodeString &pattern, UErrorCode &status)
| Sets the pattern.
virtual void | applyLocalizedPattern (const UnicodeString &pattern, UParseError &parseError, UErrorCode &status)
| Apply the given pattern to this Format object.
virtual void | applyLocalizedPattern (const UnicodeString &pattern, UErrorCode &status)
| Apply the given pattern to this Format object.
void | setMaximumIntegerDigits (int32_t newValue) override
| Sets the maximum number of digits allowed in the integer portion of a number.
void | setMinimumIntegerDigits (int32_t newValue) override
| Sets the minimum number of digits allowed in the integer portion of a number.
void | setMaximumFractionDigits (int32_t newValue) override
| Sets the maximum number of digits allowed in the fraction portion of a number.
void | setMinimumFractionDigits (int32_t newValue) override
| Sets the minimum number of digits allowed in the fraction portion of a number.
int32_t | getMinimumSignificantDigits () const
| Returns the minimum number of significant digits that will be displayed.
int32_t | getMaximumSignificantDigits () const
| Returns the maximum number of significant digits that will be displayed.
void | setMinimumSignificantDigits (int32_t min)
| Sets the minimum number of significant digits that will be displayed.
void | setMaximumSignificantDigits (int32_t max)
| Sets the maximum number of significant digits that will be displayed.
UBool | areSignificantDigitsUsed () const
| Returns true if significant digits are in use, or false if integer and fraction digit counts are in use.
void | setSignificantDigitsUsed (UBool useSignificantDigits)
| Sets whether significant digits are in use, or integer and fraction digit counts are in use.
void | setCurrency (const char16_t *theCurrency, UErrorCode &ec) override
| Sets the currency used to display currency amounts.
virtual void | setCurrency (const char16_t *theCurrency)
| Sets the currency used to display currency amounts.
void | setCurrencyUsage (UCurrencyUsage newUsage, UErrorCode *ec)
| Sets the `Currency Usage` object used to display currency.
UCurrencyUsage | getCurrencyUsage () const
| Returns the `Currency Usage` object used to display currency.
void | formatToDecimalQuantity (double number, number::impl::DecimalQuantity &output, UErrorCode &status) const
| Format a number and save it into the given DecimalQuantity.
void | formatToDecimalQuantity (const Formattable &number, number::impl::DecimalQuantity &output, UErrorCode &status) const
| Get a DecimalQuantity corresponding to a formattable as it would be formatted by this DecimalFormat.
const number::LocalizedNumberFormatter * | toNumberFormatter (UErrorCode &status) const
| Converts this DecimalFormat to a (Localized)NumberFormatter.
UClassID | getDynamicClassID () const override
| Returns a unique class ID POLYMORPHICALLY.
virtual UnicodeString & | format (const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const override
| Format an object to produce a string.
virtual UnicodeString & | format (const Formattable &obj, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const override
| Format an object to produce a string.
UnicodeString & | format (double number, UnicodeString &appendTo) const
| Format a double number.
UnicodeString & | format (int32_t number, UnicodeString &appendTo) const
| Format a long number.
UnicodeString & | format (int64_t number, UnicodeString &appendTo) const
| Format an int64 number.
virtual void | parse (const UnicodeString &text, Formattable &result, UErrorCode &status) const
| Parse a string as a numeric value, and return a Formattable numeric object.
Public Member Functions inherited from icu::NumberFormat
virtual | ~NumberFormat ()
| Destructor.
virtual void | parseObject (const UnicodeString &source, Formattable &result, ParsePosition &parse_pos) const override
| Parse a string to produce an object.
UnicodeString & | format (double number, UnicodeString &appendTo) const
| Format a double number.
UnicodeString & | format (int32_t number, UnicodeString &appendTo) const
| Format a long number.
UnicodeString & | format (int64_t number, UnicodeString &appendTo) const
| Format an int64 number.
UBool | isParseIntegerOnly () const
| Return true if this format will parse numbers as integers only.
virtual UBool | isLenient () const
| Returns whether lenient parsing is enabled (it is off by default).
UBool | isGroupingUsed () const
| Returns true if grouping is used in this format.
int32_t | getMaximumIntegerDigits () const
| Returns the maximum number of digits allowed in the integer portion of a number.
int32_t | getMinimumIntegerDigits () const
| Returns the minimum number of digits allowed in the integer portion of a number.
int32_t | getMaximumFractionDigits () const
| Returns the maximum number of digits allowed in the fraction portion of a number.
int32_t | getMinimumFractionDigits () const
| Returns the minimum number of digits allowed in the fraction portion of a number.
const char16_t * | getCurrency () const
| Gets the currency used to display currency amounts.
virtual void | setContext (UDisplayContext value, UErrorCode &status)
| Set a particular UDisplayContext value in the formatter, such as UDISPCTX_CAPITALIZATION_FOR_STANDALONE.
virtual UDisplayContext | getContext (UDisplayContextType type, UErrorCode &status) const
| Get the formatter's UDisplayContext value for the specified UDisplayContextType, such as UDISPCTX_TYPE_CAPITALIZATION.
UnicodeString & | format (const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const
| Formats an object to produce a string.
Public Member Functions inherited from icu::Format
virtual | ~Format ()
| Destructor.
bool | operator!= (const Format &other) const
| Return true if the given Format objects are not semantically equal.
UnicodeString & | format (const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const
| Formats an object to produce a string.
void | parseObject (const UnicodeString &source, Formattable &result, UErrorCode &status) const
| Parses a string to produce an object.
Locale | getLocale (ULocDataLocaleType type, UErrorCode &status) const
| Get the locale for this format object.
const char * | getLocaleID (ULocDataLocaleType type, UErrorCode &status) const
| Get the locale for this format object.
Public Member Functions inherited from icu::UObject
virtual | ~UObject ()
| Destructor.

## Static Public Member Functions
static CompactDecimalFormat * | createInstance (const Locale &inLocale, UNumberCompactStyle style, UErrorCode &status)
| Returns a compact decimal instance for specified locale.
static UClassID | getStaticClassID ()
| Return the class ID for this class.
Static Public Member Functions inherited from icu::DecimalFormat
static UClassID | getStaticClassID ()
| Return the class ID for this class.
Static Public Member Functions inherited from icu::NumberFormat
static NumberFormat * | createInstance (UErrorCode &)
| Create a default style NumberFormat for the current default locale.
static NumberFormat * | createInstance (const Locale &inLocale, UErrorCode &)
| Create a default style NumberFormat for the specified locale.
static NumberFormat * | createInstance (const Locale &desiredLocale, UNumberFormatStyle style, UErrorCode &errorCode)
| Create a specific style NumberFormat for the specified locale.
static NumberFormat * | internalCreateInstance (const Locale &desiredLocale, UNumberFormatStyle style, UErrorCode &errorCode)
| ICU use only.
static const SharedNumberFormat * | createSharedInstance (const Locale &inLocale, UNumberFormatStyle style, UErrorCode &status)
| ICU use only.
static NumberFormat * | createCurrencyInstance (UErrorCode &)
| Returns a currency format for the current default locale.
static NumberFormat * | createCurrencyInstance (const Locale &inLocale, UErrorCode &)
| Returns a currency format for the specified locale.
static NumberFormat * | createPercentInstance (UErrorCode &)
| Returns a percentage format for the current default locale.
static NumberFormat * | createPercentInstance (const Locale &inLocale, UErrorCode &)
| Returns a percentage format for the specified locale.
static NumberFormat * | createScientificInstance (UErrorCode &)
| Returns a scientific format for the current default locale.
static NumberFormat * | createScientificInstance (const Locale &inLocale, UErrorCode &)
| Returns a scientific format for the specified locale.
static const Locale * | getAvailableLocales (int32_t &count)
| Get the set of Locales for which NumberFormats are installed.
static URegistryKey | registerFactory (NumberFormatFactory *toAdopt, UErrorCode &status)
| Register a new NumberFormatFactory.
static UBool | unregister (URegistryKey key, UErrorCode &status)
| Unregister a previously-registered NumberFormatFactory using the key returned from the register call.
static StringEnumeration * | getAvailableLocales ()
| Return a StringEnumeration over the locales available at the time of the call, including registered locales.
static UClassID | getStaticClassID ()
| Return the class ID for this class.

## Additional Inherited Members
Public Types inherited from icu::DecimalFormat
enum | EPadPosition { kPadBeforePrefix , kPadAfterPrefix , kPadBeforeSuffix , kPadAfterSuffix }
| Pad position. More...
Public Types inherited from icu::NumberFormat
enum | ERoundingMode { kRoundCeiling , kRoundFloor , kRoundDown , kRoundUp , kRoundHalfEven , kRoundHalfDown , kRoundHalfUp , kRoundUnnecessary , kRoundHalfOdd , kRoundHalfCeiling , kRoundHalfFloor }
| Rounding mode. More...
enum | EAlignmentFields { kIntegerField = UNUM_INTEGER_FIELD , kFractionField = UNUM_FRACTION_FIELD , kDecimalSeparatorField = UNUM_DECIMAL_SEPARATOR_FIELD , kExponentSymbolField = UNUM_EXPONENT_SYMBOL_FIELD , kExponentSignField = UNUM_EXPONENT_SIGN_FIELD , kExponentField = UNUM_EXPONENT_FIELD , kGroupingSeparatorField = UNUM_GROUPING_SEPARATOR_FIELD , kCurrencyField = UNUM_CURRENCY_FIELD , kPercentField = UNUM_PERCENT_FIELD , kPermillField = UNUM_PERMILL_FIELD , kSignField = UNUM_SIGN_FIELD , kMeasureUnitField = UNUM_MEASURE_UNIT_FIELD , kCompactField = UNUM_COMPACT_FIELD , INTEGER_FIELD = UNUM_INTEGER_FIELD , FRACTION_FIELD = UNUM_FRACTION_FIELD }
| Alignment Field constants used to construct a FieldPosition object. More...
Protected Member Functions inherited from icu::NumberFormat
| NumberFormat ()
| Default constructor for subclass use only.
| NumberFormat (const NumberFormat &)
| Copy constructor.
NumberFormat & | operator= (const NumberFormat &)
| Assignment operator.
virtual void | getEffectiveCurrency (char16_t *result, UErrorCode &ec) const
| Returns the currency in effect for this formatter.
Protected Member Functions inherited from icu::Format
void | setLocaleIDs (const char *valid, const char *actual)
| Format ()
| Default constructor for subclass use only.
| Format (const Format &)
Format & | operator= (const Format &)
Static Protected Member Functions inherited from icu::NumberFormat
static NumberFormat * | makeInstance (const Locale &desiredLocale, UNumberFormatStyle style, UBool mustBeDecimalFormat, UErrorCode &errorCode)
| Creates the specified number format style of the desired locale.
Static Protected Member Functions inherited from icu::Format
static void | syntaxError (const UnicodeString &pattern, int32_t pos, UParseError &parseError)
| Simple function for initializing a UParseError from a UnicodeString.
Static Protected Attributes inherited from icu::NumberFormat
static const int32_t | gDefaultMaxIntegerDigits
static const int32_t | gDefaultMinIntegerDigits

## Detailed Description

IMPORTANT: New users are strongly encouraged to see if numberformatter.h fits their use case.

Although not deprecated, this header is provided for backwards compatibility only.

The CompactDecimalFormat produces abbreviated numbers, suitable for display in environments will limited real estate. For example, 'Hits: 1.2B' instead of 'Hits: 1,200,000,000'. The format will be appropriate for the given language, such as "1,2 Mrd." for German.

For numbers under 1000 trillion (under 10^15, such as 123,456,789,012,345), the result will be short for supported languages. However, the result may sometimes exceed 7 characters, such as when there are combining marks or thin characters. In such cases, the visual width in fonts should still be short.

By default, there are 3 significant digits. After creation, if more than three significant digits are set (with setMaximumSignificantDigits), or if a fixed number of digits are set (with setMaximumIntegerDigits or setMaximumFractionDigits), then result may be wider.

At this time, parsing is not supported, and will produce a U_UNSUPPORTED_ERROR. Resetting the pattern prefixes or suffixes is not supported; the method calls are ignored.

Stable
  ICU 51

Definition at line 63 of file compactdecimalformat.h.

## Constructor & Destructor Documentation

## ◆ CompactDecimalFormat()

icu::CompactDecimalFormat::CompactDecimalFormat | ( | const CompactDecimalFormat & | source | ) |

Copy constructor.

Parameters

  source | the DecimalFormat object to be copied from.

Stable
  ICU 51

## ◆ ~CompactDecimalFormat()

icu::CompactDecimalFormat::~CompactDecimalFormat | ( |  | ) |
| override

Destructor.

Stable
  ICU 51

## Member Function Documentation

## ◆ clone()

CompactDecimalFormat * icu::CompactDecimalFormat::clone | ( |  | ) | const
| overridevirtual

Clone this Format object polymorphically.

The caller owns the result and should delete it when done.

Returns
  a polymorphic copy of this CompactDecimalFormat.

Stable
  ICU 51

Implements icu::NumberFormat.

## ◆ createInstance()

static CompactDecimalFormat * icu::CompactDecimalFormat::createInstance | ( | const Locale & | inLocale,
|  | UNumberCompactStyle | style,
|  | UErrorCode & | status )
| static

Returns a compact decimal instance for specified locale.

NOTE: New users are strongly encouraged to use `number::NumberFormatter` instead of NumberFormat.

Parameters

  inLocale | the given locale.
  style | whether to use short or long style.
  status | error code returned here.

Stable
  ICU 51

## ◆ format() [1/12]

UnicodeString & icu::DecimalFormat::format | ( | const number::impl::DecimalQuantity & | number,
|  | UnicodeString & | appendTo,
|  | FieldPosition & | pos,
|  | UErrorCode & | status ) const
| overridevirtual

Format a decimal number.

The number is a DecimalQuantity wrapper onto a floating point decimal number. The default implementation in NumberFormat converts the decimal number to a double and formats that.

Parameters

  number | The number, a DecimalQuantity format Decimal Floating Point.
  appendTo | Output parameter to receive result. Result is appended to existing contents.
  pos | On input: an alignment field, if desired. On output: the offsets of the alignment field.
  status | Output param filled with success/failure status.

Returns
  Reference to 'appendTo' parameter.

Internal
  Do not use. This API is for internal use only.

Reimplemented from icu::NumberFormat.

## ◆ format() [2/12]

UnicodeString & icu::DecimalFormat::format | ( | const number::impl::DecimalQuantity & | number,
|  | UnicodeString & | appendTo,
|  | FieldPositionIterator * | posIter,
|  | UErrorCode & | status ) const
| overridevirtual

Format a decimal number.

The number is a DecimalQuantity wrapper onto a floating point decimal number. The default implementation in NumberFormat converts the decimal number to a double and formats that.

Parameters

  number | The number, a DecimalQuantity format Decimal Floating Point.
  appendTo | Output parameter to receive result. Result is appended to existing contents.
  posIter | On return, can be used to iterate over positions of fields generated by this format call.
  status | Output param filled with success/failure status.

Returns
  Reference to 'appendTo' parameter.

Internal
  Do not use. This API is for internal use only.

Reimplemented from icu::NumberFormat.

## ◆ format() [3/12]

UnicodeString & icu::DecimalFormat::format | ( | double | number,
|  | UnicodeString & | appendTo,
|  | FieldPosition & | pos ) const
| overridevirtual

Format a double or long number using base-10 representation.

Parameters

  number | The value to be formatted.
  appendTo | Output parameter to receive result. Result is appended to existing contents.
  pos | On input: an alignment field, if desired. On output: the offsets of the alignment field.

Returns
  Reference to 'appendTo' parameter.

Stable
  ICU 2.0

Implements icu::NumberFormat.

## ◆ format() [4/12]

UnicodeString & icu::DecimalFormat::format | ( | double | number,
|  | UnicodeString & | appendTo,
|  | FieldPosition & | pos,
|  | UErrorCode & | status ) const
| overridevirtual

Format a double or long number using base-10 representation.

Parameters

  number | The value to be formatted.
  appendTo | Output parameter to receive result. Result is appended to existing contents.
  pos | On input: an alignment field, if desired. On output: the offsets of the alignment field.
  status |

Returns
  Reference to 'appendTo' parameter.

Internal
  Do not use. This API is for internal use only.

Reimplemented from icu::NumberFormat.

## ◆ format() [5/12]

UnicodeString & icu::DecimalFormat::format | ( | double | number,
|  | UnicodeString & | appendTo,
|  | FieldPositionIterator * | posIter,
|  | UErrorCode & | status ) const
| overridevirtual

Format a double or long number using base-10 representation.

Parameters

  number | The value to be formatted.
  appendTo | Output parameter to receive result. Result is appended to existing contents.
  posIter | On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
  status | Output param filled with success/failure status.

Returns
  Reference to 'appendTo' parameter.

Stable
  ICU 4.4

Reimplemented from icu::NumberFormat.

## ◆ format() [6/12]

UnicodeString & icu::DecimalFormat::format | ( | int32_t | number,
|  | UnicodeString & | appendTo,
|  | FieldPosition & | pos ) const
| overridevirtual

Format a long number using base-10 representation.

Parameters

  number | The value to be formatted.
  appendTo | Output parameter to receive result. Result is appended to existing contents.
  pos | On input: an alignment field, if desired. On output: the offsets of the alignment field.

Returns
  Reference to 'appendTo' parameter.

Stable
  ICU 2.0

Implements icu::NumberFormat.

## ◆ format() [7/12]

UnicodeString & icu::DecimalFormat::format | ( | int32_t | number,
|  | UnicodeString & | appendTo,
|  | FieldPosition & | pos,
|  | UErrorCode & | status ) const
| overridevirtual

Format a long number using base-10 representation.

Parameters

  number | The value to be formatted.
  appendTo | Output parameter to receive result. Result is appended to existing contents.
  pos | On input: an alignment field, if desired. On output: the offsets of the alignment field.
  status | Output param filled with success/failure status.

Returns
  Reference to 'appendTo' parameter.

Internal
  Do not use. This API is for internal use only.

Reimplemented from icu::NumberFormat.

## ◆ format() [8/12]

UnicodeString & icu::DecimalFormat::format | ( | int32_t | number,
|  | UnicodeString & | appendTo,
|  | FieldPositionIterator * | posIter,
|  | UErrorCode & | status ) const
| overridevirtual

Format a long number using base-10 representation.

Parameters

  number | The value to be formatted.
  appendTo | Output parameter to receive result. Result is appended to existing contents.
  posIter | On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
  status | Output param filled with success/failure status.

Returns
  Reference to 'appendTo' parameter.

Stable
  ICU 4.4

Reimplemented from icu::NumberFormat.

## ◆ format() [9/12]

UnicodeString & icu::DecimalFormat::format | ( | int64_t | number,
|  | UnicodeString & | appendTo,
|  | FieldPosition & | pos ) const
| overridevirtual

Format an int64 number using base-10 representation.

Parameters

  number | The value to be formatted.
  appendTo | Output parameter to receive result. Result is appended to existing contents.
  pos | On input: an alignment field, if desired. On output: the offsets of the alignment field.

Returns
  Reference to 'appendTo' parameter.

Stable
  ICU 2.8

Reimplemented from icu::NumberFormat.

## ◆ format() [10/12]

UnicodeString & icu::DecimalFormat::format | ( | int64_t | number,
|  | UnicodeString & | appendTo,
|  | FieldPosition & | pos,
|  | UErrorCode & | status ) const
| overridevirtual

Format an int64 number using base-10 representation.

Parameters

  number | The value to be formatted.
  appendTo | Output parameter to receive result. Result is appended to existing contents.
  pos | On input: an alignment field, if desired. On output: the offsets of the alignment field.
  status | Output param filled with success/failure status.

Returns
  Reference to 'appendTo' parameter.

Internal
  Do not use. This API is for internal use only.

Reimplemented from icu::NumberFormat.

## ◆ format() [11/12]

UnicodeString & icu::DecimalFormat::format | ( | int64_t | number,
|  | UnicodeString & | appendTo,
|  | FieldPositionIterator * | posIter,
|  | UErrorCode & | status ) const
| overridevirtual

Format an int64 number using base-10 representation.

Parameters

  number | The value to be formatted.
  appendTo | Output parameter to receive result. Result is appended to existing contents.
  posIter | On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
  status | Output param filled with success/failure status.

Returns
  Reference to 'appendTo' parameter.

Stable
  ICU 4.4

Reimplemented from icu::NumberFormat.

## ◆ format() [12/12]

UnicodeString & icu::DecimalFormat::format | ( | StringPiece | number,
|  | UnicodeString & | appendTo,
|  | FieldPositionIterator * | posIter,
|  | UErrorCode & | status ) const
| overridevirtual

Format a decimal number.

The syntax of the unformatted number is a "numeric string" as defined in the Decimal Arithmetic Specification, available at http://speleotrove.com/decimal

Parameters

  number | The unformatted number, as a string.
  appendTo | Output parameter to receive result. Result is appended to existing contents.
  posIter | On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
  status | Output param filled with success/failure status.

Returns
  Reference to 'appendTo' parameter.

Stable
  ICU 4.4

Reimplemented from icu::NumberFormat.

## ◆ getDynamicClassID()

UClassID icu::CompactDecimalFormat::getDynamicClassID | ( |  | ) | const
| overridevirtual

Returns a unique class ID POLYMORPHICALLY.

Pure virtual override. This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphic operator==() and clone() methods call this method.

Returns
  The class ID for this object. All objects of a given class have the same class ID. Objects of other classes have different class IDs.

Stable
  ICU 51

Implements icu::NumberFormat.

## ◆ getStaticClassID()

static UClassID icu::CompactDecimalFormat::getStaticClassID | ( |  | ) |
| static

Return the class ID for this class.

This is useful only for comparing to a return value from getDynamicClassID(). For example:

    .      Base* polymorphic_pointer = createPolymorphicObject();
    .      if (polymorphic_pointer->getDynamicClassID() ==
    .          Derived::getStaticClassID()) ...

Returns
  The class ID for all objects of this class.

Stable
  ICU 51

## ◆ operator=()

CompactDecimalFormat & icu::CompactDecimalFormat::operator= | ( | const CompactDecimalFormat & | rhs | ) |

Assignment operator.

Parameters

  rhs | the DecimalFormat object to be copied.

Stable
  ICU 51

## ◆ parse() [1/2]

void icu::CompactDecimalFormat::parse | ( | const UnicodeString & | text,
|  | Formattable & | result,
|  | ParsePosition & | parsePosition ) const
| overridevirtual

CompactDecimalFormat does not support parsing.

This implementation does nothing.

Parameters

  text | Unused.
  result | Does not change.
  parsePosition | Does not change.

See also
  Formattable

Stable
  ICU 51

Implements icu::NumberFormat.

## ◆ parse() [2/2]

void icu::CompactDecimalFormat::parse | ( | const UnicodeString & | text,
|  | Formattable & | result,
|  | UErrorCode & | status ) const
| overridevirtual

CompactDecimalFormat does not support parsing.

This implementation sets status to U_UNSUPPORTED_ERROR

Parameters

  text | Unused.
  result | Does not change.
  status | Always set to U_UNSUPPORTED_ERROR.

Stable
  ICU 51

Reimplemented from icu::NumberFormat.

## ◆ parseCurrency()

CurrencyAmount * icu::CompactDecimalFormat::parseCurrency | ( | const UnicodeString & | text,
|  | ParsePosition & | pos ) const
| overridevirtual

Parses text from the given string as a currency amount.

Unlike the parse() method, this method will attempt to parse a generic currency name, searching for a match of this object's locale's currency display names, or for a 3-letter ISO currency code. This method will fail if this format is not a currency format, that is, if it does not contain the currency pattern symbol (U+00A4) in its prefix or suffix. This implementation always returns nullptr.

Parameters

  text | the string to parse
  pos | input-output position; on input, the position within text to match; must have 0 <= pos.getIndex() < text.length(); on output, the position after the last matched character. If the parse fails, the position in unchanged upon output.

Returns
  if parse succeeds, a pointer to a newly-created CurrencyAmount object (owned by the caller) containing information about the parsed currency; if parse fails, this is nullptr.

Internal
  Do not use. This API is for internal use only.

Reimplemented from icu::NumberFormat.

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

- i18n/unicode/compactdecimalformat.h