Cldr Numbers v1.4.1 Cldr.Number.Format View Source
Functions to manage the collection of number patterns defined in Cldr.
Number patterns affect how numbers are interpreted in a localized context. Here are some examples, based on the French locale. The “.” shows where the decimal point should go. The “,” shows where the thousands separator should go. A “0” indicates zero-padding: if the number is too short, a zero (in the locale’s numeric set) will go there. A “#” indicates no padding: if the number is too short, nothing goes there. A “¤” shows where the currency sign will go. The following illustrates the effects of different patterns for the French locale, with the number “1234.567”. Notice how the pattern characters ‘,’ and ‘.’ are replaced by the characters appropriate for the locale.
Number Pattern Examples
Pattern | Currency | Text |
---|---|---|
#,##0.## | n/a | 1 234,57 |
#,##0.### | n/a | 1 234,567 |
###0.##### | n/a | 1234,567 |
###0.0000# | n/a | 1234,5670 |
00000.0000 | n/a | 01234,5670 |
#,##0.00 ¤ | EUR | 1 234,57 € |
The number of # placeholder characters before the decimal do not matter, since no limit is placed on the maximum number of digits. There should, however, be at least one zero some place in the pattern. In currency formats, the number of digits after the decimal also do not matter, since the information in the supplemental data (see Supplemental Currency Data) is used to override the number of decimal places — and the rounding — according to the currency that is being formatted. That can be seen in the above chart, with the difference between Yen and Euro formatting.
Details of the number formats are described in the Unicode documentation
Link to this section Summary
Functions
Returns the decimal formats defined for a given locale
Returns the decimal formats defined for a given locale
Returns the list of decimal formats in the configured locales including
the list of locales configured for precompilation in config.exs
Returns the list of decimal formats for a configured locale
Returns the decimal format styles that are supported by
Cldr.Number.Formatter.Decimal
Returns the format styles available for a locale
Returns the names of the number systems for the locale
Returns the number system types available for a locale
Return the predfined formats for a given locale
and number_system
Return the predfined formats for a given locale
and number_system
or raises
if either the locale
or number_system
is invalid
Returns the minium grouping digits for a locale
Returns the minium grouping digits for a locale or raises if there is an error
Returns the short formats available for a locale
Link to this section Types
Link to this section Functions
all_formats_for(Cldr.LanguageTag.t() | Cldr.Locale.locale_name()) :: {:ok, Map.t()} | {:error, {Exception.t(), String.t()}}
Returns the decimal formats defined for a given locale.
Options
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
. The default isCldr.get_current_locale/0
Examples
Cldr.Number.Format.all_formats_for("en")
#=> {:ok, %{latn: %Cldr.Number.Format{
accounting: "¤#,##0.00;(¤#,##0.00)",
currency: "¤#,##0.00",
percent: "#,##0%",
scientific: "#E0",
standard: "#,##0.###",
currency_short: [{"1000", [one: "¤0K", other: "¤0K"]},
{"10000", [one: "¤00K", other: "¤00K"]},
{"100000", [one: "¤000K", other: "¤000K"]},
{"1000000", [one: "¤0M", other: "¤0M"]},
{"10000000", [one: "¤00M", other: "¤00M"]},
{"100000000", [one: "¤000M", other: "¤000M"]},
{"1000000000", [one: "¤0B", other: "¤0B"]},
{"10000000000", [one: "¤00B", other: "¤00B"]},
{"100000000000", [one: "¤000B", other: "¤000B"]},
{"1000000000000", [one: "¤0T", other: "¤0T"]},
{"10000000000000", [one: "¤00T", other: "¤00T"]},
{"100000000000000", [one: "¤000T", other: "¤000T"]}],
....
}}
Returns the decimal formats defined for a given locale.
Options
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
. The default isCldr.get_current_locale/0
Returns
a list of decimal formats ot
raises an exception
See Cldr.Number.Format.all_formats_for/1
for further information.
Returns the list of decimal formats in the configured locales including
the list of locales configured for precompilation in config.exs
.
This function exists to allow the decimal formatter to precompile all the known formats at compile time.
Example
Cldr.Number.Format.decimal_format_list ["#", "#,##,##0%",
#=> "#,##,##0.###", "#,##,##0.00¤", "#,##,##0.00¤;(#,##,##0.00¤)",
"#,##,##0 %", "#,##0%", "#,##0.###", "#,##0.00 ¤",
"#,##0.00 ¤;(#,##0.00 ¤)", "#,##0.00¤", "#,##0.00¤;(#,##0.00¤)",
"#,##0 %", "#0%", "#0.######", "#0.00 ¤", "#E0", "%#,##0", "% #,##0",
"0", "0.000000E+000", "0000 M ¤", "0000¤", "000G ¤", "000K ¤", "000M ¤",
"000T ¤", "000mM ¤", "000m ¤", "000 Bio'.' ¤", "000 Bln ¤", "000 Bn ¤",
"000 B ¤", "000 E ¤", "000 K ¤", "000 MRD ¤", "000 Md ¤", "000 Mio'.' ¤",
"000 Mio ¤", "000 Mld ¤", "000 Mln ¤", "000 Mn ¤", "000 Mrd'.' ¤",
"000 Mrd ¤", "000 Mr ¤", "000 M ¤", "000 NT ¤", "000 N ¤", "000 Tn ¤",
"000 Tr ¤", ...]
decimal_format_list_for(Cldr.LanguageTag.t() | Cldr.Locale.locale_name()) :: {:ok, [String.t(), ...]} | {:error, {Exception.t(), String.t()}}
Returns the list of decimal formats for a configured locale.
Options
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
. The default isCldr.get_current_locale/0
This function exists to allow the decimal formatter to precompile all the known formats at compile time. Its use is not otherwise recommended.
Example
iex> Cldr.Number.Format.decimal_format_list_for("en")
{:ok, ["#,##0%", "#,##0.###", "#E0", "0 billion", "0 million", "0 thousand",
"0 trillion", "00 billion", "00 million", "00 thousand", "00 trillion",
"000 billion", "000 million", "000 thousand", "000 trillion", "000B", "000K",
"000M", "000T", "00B", "00K", "00M", "00T", "0B", "0K", "0M", "0T",
"¤#,##0.00", "¤#,##0.00;(¤#,##0.00)", "¤000B", "¤000K", "¤000M",
"¤000T", "¤00B", "¤00K", "¤00M", "¤00T", "¤0B", "¤0K", "¤0M", "¤0T"]}
decimal_format_styles_for( Cldr.LanguageTag.t() | Cldr.Locale.locale_name(), Cldr.Number.System.system_name() ) :: [atom(), ...]
Returns the decimal format styles that are supported by
Cldr.Number.Formatter.Decimal
.
Options
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
. The default isCldr.get_current_locale/0
number_system
is any valid number system or number system type returned byCldr.Number.System.number_systems_for/1
Example
iex> Cldr.Number.Format.decimal_format_styles_for("en")
{:ok, [:accounting, :currency, :currency_long, :percent,
:scientific, :standard]}
format_styles_for( Cldr.LanguageTag.t() | Cldr.Locale.locale_name(), Cldr.Number.System.system_name() ) :: [atom(), ...]
Returns the format styles available for a locale
.
Options
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
. The default isCldr.get_current_locale/0
number_system
is any valid number system or number system type returned byCldr.Number.System.number_systems_for/1
Format styles standardise the access to a format defined for a common
use. These types are :standard
, :currency
, :accounting
, :scientific
and :percent, :currency_short, :decimal_short, :decimal_long.
These types can be used when formatting a number for output. For example
Cldr.Number.to_string(123.456, format: :percent)
.
Example
iex> Cldr.Number.Format.format_styles_for("en")
{:ok, [:accounting, :currency, :currency_long, :currency_short,
:decimal_long, :decimal_short, :percent, :scientific, :standard]}
format_system_names_for(Cldr.LanguageTag.t()) :: [String.t(), ...]
Returns the names of the number systems for the locale
.
Options
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
. The default isCldr.get_current_locale/0
Examples
iex> Cldr.Number.Format.format_system_names_for("th")
{:ok, [:latn, :thai]}
iex> Cldr.Number.Format.format_system_names_for("pl")
{:ok, [:latn]}
format_system_types_for(Cldr.LanguageTag.t()) :: [atom(), ...]
Returns the number system types available for a locale
Options
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
. The default isCldr.get_current_locale/0
A number system type is an identifier that categorises number systems that comprise a site of digits or rules for transliterating or translating digits and a number system name for determining plural rules and format masks.
If that all sounds a bit complicated then the default number system type
called :default
is probably what you want nearly all the time.
Examples
iex> Cldr.Number.Format.format_system_types_for("pl")
{:ok, [:default, :native]}
iex> Cldr.Number.Format.format_system_types_for("ru")
{:ok, [:default, :native]}
iex> Cldr.Number.Format.format_system_types_for("th")
{:ok, [:default, :native]}
formats_for(Cldr.LanguageTag.t(), atom() | String.t()) :: Map.t()
Return the predfined formats for a given locale
and number_system
.
Options
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
. The default isCldr.get_current_locale/0
number_system
is any valid number system or number system type returned byCldr.Number.System.number_systems_for/1
Example
Cldr.Number.Format.formats_for "fr", :native
#=> %Cldr.Number.Format{
accounting: "#,##0.00 ¤;(#,##0.00 ¤)",
currency: "#,##0.00 ¤",
percent: "#,##0 %",
scientific: "#E0",
standard: "#,##0.###"
currency_short: [{"1000", [one: "0 k ¤", other: "0 k ¤"]},
{"10000", [one: "00 k ¤", other: "00 k ¤"]},
{"100000", [one: "000 k ¤", other: "000 k ¤"]},
{"1000000", [one: "0 M ¤", other: "0 M ¤"]},
{"10000000", [one: "00 M ¤", other: "00 M ¤"]},
{"100000000", [one: "000 M ¤", other: "000 M ¤"]},
{"1000000000", [one: "0 Md ¤", other: "0 Md ¤"]},
{"10000000000", [one: "00 Md ¤", other: "00 Md ¤"]},
{"100000000000", [one: "000 Md ¤", other: "000 Md ¤"]},
{"1000000000000", [one: "0 Bn ¤", other: "0 Bn ¤"]},
{"10000000000000", [one: "00 Bn ¤", other: "00 Bn ¤"]},
{"100000000000000", [one: "000 Bn ¤", other: "000 Bn ¤"]}],
...
}
formats_for!(Cldr.LanguageTag.t(), Cldr.Number.System.system_name()) :: Map.t() | none()
Return the predfined formats for a given locale
and number_system
or raises
if either the locale
or number_system
is invalid.
Options
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
. The default isCldr.get_current_locale/0
number_system
is any valid number system or number system type returned byCldr.Number.System.number_systems_for/1
minimum_grouping_digits_for(Cldr.LanguageTag.t()) :: {:ok, non_neg_integer()} | {:error, {Exception.t(), String.t()}}
Returns the minium grouping digits for a locale.
Options
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
. The default isCldr.get_current_locale/0
Returns
{:ok, minumum_digits}
or{:error, {exception, message}}
Examples
iex> Cldr.Number.Format.minimum_grouping_digits_for("en")
{:ok, 1}
Returns the minium grouping digits for a locale or raises if there is an error.
Options
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
. The default isCldr.get_current_locale/0
Examples
iex> Cldr.Number.Format.minimum_grouping_digits_for!(Cldr.Locale.new!("en"))
1
Cldr.Number.Format.minimum_grouping_digits_for!(:invalid)
** (Cldr.UnknownLocaleError) The locale :invalid is invalid
short_format_styles_for(Cldr.LanguageTag.t(), binary() | atom()) :: [ atom(), ... ]
Returns the short formats available for a locale.
Options
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
. The default isCldr.get_current_locale/0
number_system
is any valid number system or number system type returned byCldr.Number.System.number_systems_for/1
Example
iex> Cldr.Number.Format.short_format_styles_for("he")
{:ok, [:currency_short, :decimal_long, :decimal_short]}