Loading...
Searching...
No Matches
unumberoptions.h File Reference

C API: Header-only input options for various number formatting APIs. More...

`#include "unicode/utypes.h"`

Go to the source code of this file.

## Typedefs

typedef enum UNumberFormatRoundingMode | UNumberFormatRoundingMode
| The possible number format rounding modes.
typedef enum UNumberGroupingStrategy | UNumberGroupingStrategy
| An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten).

## Enumerations

enum | UNumberFormatRoundingMode { UNUM_ROUND_CEILING , UNUM_ROUND_FLOOR , UNUM_ROUND_DOWN , UNUM_ROUND_UP , UNUM_ROUND_HALFEVEN , UNUM_FOUND_HALFEVEN = UNUM_ROUND_HALFEVEN , UNUM_ROUND_HALFDOWN = UNUM_ROUND_HALFEVEN + 1 , UNUM_ROUND_HALFUP , UNUM_ROUND_UNNECESSARY , UNUM_ROUND_HALF_ODD , UNUM_ROUND_HALF_CEILING , UNUM_ROUND_HALF_FLOOR }
| The possible number format rounding modes. More...
enum | UNumberGroupingStrategy { UNUM_GROUPING_OFF , UNUM_GROUPING_MIN2 , UNUM_GROUPING_AUTO , UNUM_GROUPING_ON_ALIGNED , UNUM_GROUPING_THOUSANDS , UNUM_GROUPING_COUNT }
| An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten). More...

## Detailed Description

C API: Header-only input options for various number formatting APIs.

You do not normally need to include this header file directly, because it is included in all files that use these enums.

Definition in file unumberoptions.h.

## Typedef Documentation

## UNumberFormatRoundingMode

typedef enum UNumberFormatRoundingMode UNumberFormatRoundingMode

The possible number format rounding modes.

For more detail on rounding modes, see: https://unicode-org.github.io/icu/userguide/format_parse/numbers/rounding-modes

Stable
  ICU 2.0

## UNumberGroupingStrategy

typedef enum UNumberGroupingStrategy UNumberGroupingStrategy

An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten).

The choices are several pre-built strategies for different use cases that employ locale data whenever possible. Example outputs for 1234 and 1234567 in en-IN:

- OFF: 1234 and 12345
- MIN2: 1234 and 12,34,567
- AUTO: 1,234 and 12,34,567
- ON_ALIGNED: 1,234 and 12,34,567
- THOUSANDS: 1,234 and 1,234,567

The default is AUTO, which displays grouping separators unless the locale data says that grouping is not customary. To force grouping for all numbers greater than 1000 consistently across locales, use ON_ALIGNED. On the other hand, to display grouping less frequently than the default, use MIN2 or OFF. See the docs of each option for details.

Note: This enum specifies the strategy for grouping sizes. To set which character to use as the grouping separator, use the "symbols" setter.

Stable
  ICU 63

## Enumeration Type Documentation

## UNumberFormatRoundingMode

enum UNumberFormatRoundingMode

The possible number format rounding modes.

For more detail on rounding modes, see: https://unicode-org.github.io/icu/userguide/format_parse/numbers/rounding-modes

Stable
  ICU 2.0

Enumerator

UNUM_ROUND_HALFEVEN

Half-even rounding.

Stable
  , ICU 3.8

UNUM_FOUND_HALFEVEN

Half-even rounding, misspelled name.

Deprecated
  , ICU 3.8

UNUM_ROUND_UNNECESSARY

ROUND_UNNECESSARY reports an error if formatted result is not exact.

Stable
  ICU 4.8

UNUM_ROUND_HALF_ODD

Rounds ties toward the odd number.

Stable
  ICU 69

UNUM_ROUND_HALF_CEILING

Rounds ties toward +∞.

Stable
  ICU 69

UNUM_ROUND_HALF_FLOOR

Rounds ties toward -∞.

Stable
  ICU 69

Definition at line 28 of file unumberoptions.h.

## UNumberGroupingStrategy

enum UNumberGroupingStrategy

An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten).

The choices are several pre-built strategies for different use cases that employ locale data whenever possible. Example outputs for 1234 and 1234567 in en-IN:

- OFF: 1234 and 12345
- MIN2: 1234 and 12,34,567
- AUTO: 1,234 and 12,34,567
- ON_ALIGNED: 1,234 and 12,34,567
- THOUSANDS: 1,234 and 1,234,567

The default is AUTO, which displays grouping separators unless the locale data says that grouping is not customary. To force grouping for all numbers greater than 1000 consistently across locales, use ON_ALIGNED. On the other hand, to display grouping less frequently than the default, use MIN2 or OFF. See the docs of each option for details.

Note: This enum specifies the strategy for grouping sizes. To set which character to use as the grouping separator, use the "symbols" setter.

Stable
  ICU 63

Enumerator

UNUM_GROUPING_OFF

Do not display grouping separators in any locale.

Stable
  ICU 61

UNUM_GROUPING_MIN2

Display grouping using locale defaults, except do not show grouping on values smaller than 10000 (such that there is a minimum of two digits before the first separator).

Note that locales may restrict grouping separators to be displayed only on 1 million or greater (for example, ee and hu) or disable grouping altogether (for example, bg currency).

Locale data is used to determine whether to separate larger numbers into groups of 2 (customary in South Asia) or groups of 3 (customary in Europe and the Americas).

Stable
  ICU 61

UNUM_GROUPING_AUTO

Display grouping using the default strategy for all locales.

This is the default behavior.

Note that locales may restrict grouping separators to be displayed only on 1 million or greater (for example, ee and hu) or disable grouping altogether (for example, bg currency).

Locale data is used to determine whether to separate larger numbers into groups of 2 (customary in South Asia) or groups of 3 (customary in Europe and the Americas).

Stable
  ICU 61

UNUM_GROUPING_ON_ALIGNED

Always display the grouping separator on values of at least 1000.

This option ignores the locale data that restricts or disables grouping, described in MIN2 and AUTO. This option may be useful to normalize the alignment of numbers, such as in a spreadsheet.

Locale data is used to determine whether to separate larger numbers into groups of 2 (customary in South Asia) or groups of 3 (customary in Europe and the Americas).

Stable
  ICU 61

UNUM_GROUPING_THOUSANDS

Use the Western defaults: groups of 3 and enabled for all numbers 1000 or greater.

Do not use locale data for determining the grouping strategy.

Stable
  ICU 61

UNUM_GROUPING_COUNT

One more than the highest UNumberGroupingStrategy value.

Internal
  Do not use. This API is for internal use only. ICU 62: The numeric value may change over time; see ICU ticket #12420.

Definition at line 96 of file unumberoptions.h.