Cldr Numbers

v1.5.1

Cldr Numbers

Cldr Numbers v1.5.1 Cldr.Number.System View Source

Functions to manage number systems which describe the numbering characteristics for a locale.

A number system defines the digits (if they exist in this number system) or or rules (if the number system does not have decimal digits).

The system name is also used as a key to define the separators that are used when formatting a number is this number_system. See Cldr.Number.Symbol.number_symbols_for/2.

Link to this section Summary

Types

system_name()
types()

Functions

default_number_system_type()

Return the default number system type name

generate_transliteration_map(from, to)

Generate a transliteration map between two character classes

known_number_system_types()
known_number_systems()
number_system_digits!(system_name)

Returns digits for a number system, or raises an exception if the number system is not know

number_system_digits(system_name)

Returns {:ok, digits} for a number system, or an {:error, message} if the number system is not known

number_system_for(locale, system_name)

Returns the actual number system from a number system type

number_system_names_for!(locale)

Returns the names of the number systems available for a locale or an {:error, message} tuple if the locale is not known

number_system_names_for(locale \\ Cldr.default_locale())

Returns the names of the number systems available for a locale or an {:error, message} tuple if the locale is not known

number_systems()

Return a map of all CLDR number systems and definitions

number_systems_for!(locale)

Returns the number systems available for a locale or raises if the locale is not known

number_systems_for(locale \\ Cldr.get_current_locale())

Returns the number systems available for a locale or {:error, message} if the locale is not known

number_systems_like(locale, number_system)

Returns locale and number systems that have the same digits and separators as the supplied one

system_name_from!(system_name, locale \\ Cldr.get_current_locale())

Returns a number system name for a given locale and number system reference and raises if the number system is not available for the given locale

system_name_from(system_name, locale \\ Cldr.get_current_locale())

Returns a number system name for a given locale and number system reference

systems_with_digits()

Number systems that have their own digit characters defined

to_system!(number, system_name)

Converts a number into the representation of a non-latin number system. Returns a converted string or raises on error

to_system(number, system_name)

Converts a number into the representation of a non-latin number system

unknown_number_system_for_locale_error(number_system, locale, valid_number_systems)

Returns an error tuple for an number system unknown to a given locale

Link to this section Types

Link to this type system_name() View Source 
system_name() :: atom()
Link to this type types() View Source 
types() :: :default | :native | :traditional | :finance

Link to this section Functions

Link to this function default_number_system_type() View Source

Return the default number system type name.

Currently this is :default. Note that this is not the number system itself but the type of the number system. It can be used to find the default number system for a given locale with number_systems_for(locale)[default_number_system()].

Example 

iex> Cldr.Number.System.default_number_system_type
:default
Link to this function generate_transliteration_map(from, to) View Source

Generate a transliteration map between two character classes

Link to this function known_number_system_types() View Source
Link to this function number_system_digits!(system_name) View Source

Returns digits for a number system, or raises an exception if the number system is not know.

Examples 

iex> Cldr.Number.System.number_system_digits! :latn
"0123456789"

Cldr.Number.System.number_system_digits! :nope
** (Cldr.UnknownNumberSystemError) The number system :nope is not known or does not have digits
Link to this function number_system_digits(system_name) View Source

Returns {:ok, digits} for a number system, or an {:error, message} if the number system is not known.

Examples 

iex> Cldr.Number.System.number_system_digits(:latn)
{:ok, "0123456789"}

iex> Cldr.Number.System.number_system_digits(:nope)
{:error, {Cldr.UnknownNumberSystemError, "The number system :nope is not known or does not have digits"}}
Link to this function number_system_for(locale, system_name) View Source 
number_system_for(Cldr.Locale.name() | Cldr.LanguageTag.t(), System.name()) :: [
  atom(),
  ...
]

Returns the actual number system from a number system type.

This function will decode a number system type into the actual number system. If the number system provided can’t be decoded it is returned as is.

Examples 

iex> Cldr.Number.System.number_system_for Cldr.Locale.new!("th"), :latn
{:ok, %{digits: "0123456789", type: :numeric}}

iex> Cldr.Number.System.number_system_for Cldr.Locale.new!("en"), :default
{:ok, %{digits: "0123456789", type: :numeric}}

iex> Cldr.Number.System.number_system_for Cldr.Locale.new!("he"), :traditional
{:ok, %{rules: "hebrew", type: :algorithmic}}

iex> Cldr.Number.System.number_system_for Cldr.Locale.new!("en"), :finance
{
  :error,
  {Cldr.UnknownNumberSystemError,
    "The number system :finance is unknown for the locale named \"en\". Valid number systems are %{default: :latn, native: :latn}"}
}

iex> Cldr.Number.System.number_system_for Cldr.Locale.new!("en"), :native
{:ok, %{digits: "0123456789", type: :numeric}}
Link to this function number_system_names_for!(locale) View Source 
number_system_names_for!(Cldr.Locale.name() | Cldr.LanguageTag.t()) :: [
  system_name(),
  ...
]

Returns the names of the number systems available for a locale or an {:error, message} tuple if the locale is not known.

Examples 

iex> Cldr.Number.System.number_system_names_for!("en")
[:latn]

iex> Cldr.Number.System.number_system_names_for!("th")
[:latn, :thai]

iex> Cldr.Number.System.number_system_names_for!("he")
[:latn, :hebr]
Link to this function number_system_names_for(locale \\ Cldr.default_locale()) View Source 
number_system_names_for(Cldr.Locale.name() | Cldr.LanguageTag.t()) :: [
  atom(),
  ...
]

Returns the names of the number systems available for a locale or an {:error, message} tuple if the locale is not known.

Examples 

iex> Cldr.Number.System.number_system_names_for Cldr.Locale.new!("en")
{:ok, [:latn]}

iex> Cldr.Number.System.number_system_names_for Cldr.Locale.new!("th")
{:ok, [:latn, :thai]}

iex> Cldr.Number.System.number_system_names_for Cldr.Locale.new!("he")
{:ok, [:latn, :hebr]}

iex> Cldr.Number.System.number_system_names_for Cldr.Locale.new!("zz")
{:error, {Cldr.UnknownLocaleError, "The locale \"zz\" is not known."}}
Link to this function number_systems() View Source 
number_systems() :: Map.t()

Return a map of all CLDR number systems and definitions.

Example 

iex> Cldr.Number.System.number_systems |> Enum.count
78
Link to this function number_systems_for!(locale) View Source 
number_systems_for!(Cldr.Locale.name() | Cldr.LanguageTag.t()) :: Map.t()

Returns the number systems available for a locale or raises if the locale is not known.

Examples 

iex> Cldr.Number.System.number_systems_for! Cldr.Locale.new!("en")
%{default: :latn, native: :latn}

iex> Cldr.Number.System.number_systems_for! Cldr.Locale.new!("th")
%{default: :latn, native: :thai}
Link to this function number_systems_for(locale \\ Cldr.get_current_locale()) View Source 
number_systems_for(Cldr.Locale.name() | Cldr.LanguageTag.t()) :: Map.t()

Returns the number systems available for a locale or {:error, message} if the locale is not known.

Examples 

iex> Cldr.Number.System.number_systems_for Cldr.Locale.new!("en")
{:ok, %{default: :latn, native: :latn}}

iex> Cldr.Number.System.number_systems_for Cldr.Locale.new!("th")
{:ok, %{default: :latn, native: :thai}}

iex> Cldr.Number.System.number_systems_for Cldr.Locale.new!("zz")
{:error, {Cldr.UnknownLocaleError, "The locale \"zz\" is not known."}}
Link to this function number_systems_like(locale, number_system) View Source 
number_systems_like(
  Cldr.LanguageTag.t() | Cldr.Locale.locale_name(),
  system_name()
) :: {:ok, List.t()} | {:error, tuple()}

Returns locale and number systems that have the same digits and separators as the supplied one.

Transliterating between locale & number systems is expensive. To avoid unncessary transliteration we look for locale and number systems that have the same digits and separators. Typically we are comparing to locale “en” and number system “latn” since this is what the number formatting routines use as placeholders.

Link to this function system_name_from!(system_name, locale \\ Cldr.get_current_locale()) View Source

Returns a number system name for a given locale and number system reference and raises if the number system is not available for the given locale.

Examples

iex> Cldr.Number.System.system_name_from!(:default, Cldr.Locale.new!( “en”)) :latn

iex> Cldr.Number.System.system_name_from!(“latn”, Cldr.Locale.new!(“en”)) :latn

iex> Cldr.Number.System.system_name_from!(:traditional, Cldr.Locale.new!(“he”)) :hebr

Link to this function system_name_from(system_name, locale \\ Cldr.get_current_locale()) View Source 
system_name_from(
  system_name(),
  Cldr.Locale.locale_name() | Cldr.LanguageTag.t()
) :: atom()

Returns a number system name for a given locale and number system reference.

Number systems can be references in one of two ways:

  • As a number system type such as :default, :native, :traditional and :finance. This allows references to a number system for a locale in a consistent fashion for a given use

  • WIth the number system name directly, such as :latn, :arab or any of the other 70 or so

This function dereferences the supplied system_name and returns the actual system name.

Examples 

ex> Cldr.Number.System.system_name_from(:default, Cldr.Locale.new!( "en"))
{:ok, :latn}

iex> Cldr.Number.System.system_name_from("latn", Cldr.Locale.new!("en"))
{:ok, :latn}

iex> Cldr.Number.System.system_name_from(:native, Cldr.Locale.new!("en"))
{:ok, :latn}

iex> Cldr.Number.System.system_name_from(:nope, Cldr.Locale.new!("en"))
{
  :error,
  {Cldr.UnknownNumberSystemError, "The number system :nope is unknown"}
}

Note that return value is not guaranteed to be a valid number system for the given locale as demonstrated in the third example.

Link to this function systems_with_digits() View Source

Number systems that have their own digit characters defined.

Link to this function to_system!(number, system_name) View Source

Converts a number into the representation of a non-latin number system. Returns a converted string or raises on error.

See Cldr.Number.System.to_string/2 for further information.

Examples 

iex> Cldr.Number.System.to_system! 123, :hans
"一百二十三"

iex> Cldr.Number.System.to_system! 123, :hant
"一百二十三"

iex> Cldr.Number.System.to_system! 123, :hansfin
"壹佰贰拾叁"
Link to this function to_system(number, system_name) View Source 
to_system(Math.number_or_decimal(), atom()) :: String.t()

Converts a number into the representation of a non-latin number system.

This function converts numbers to a known number system only, it does not provide number formatting.

There are two types of number systems in CLDR:

  • :numeric in which the number system defines a direct mapping between the latin digits 0..9 into a the number system equivalent. In this case, to_system/2 invokes Cldr.Number.Transliterate.transliterate_digits/3 for the given number.

  • :algorithmic in which the number system does not have the same structure as the :latn number system and therefore the conversion is done algorithmically. For CLDR the algorithm is implemented through Cldr.Rbnf rulesets. These rulesets are considered by CLDR to be less rigorous than the :numeric number systems and caution and testing for a specific use case is recommended.

Examples 

iex> Cldr.Number.System.to_system 123456, :hebr
{:ok, "ק׳׳ת׳"}

iex> Cldr.Number.System.to_system 123, :hans
{:ok, "一百二十三"}

iex> Cldr.Number.System.to_system 123, :hant
{:ok, "一百二十三"}

iex> Cldr.Number.System.to_system 123, :hansfin
{:ok, "壹佰贰拾叁"}
Link to this function unknown_number_system_for_locale_error(number_system, locale, valid_number_systems) View Source

Returns an error tuple for an number system unknown to a given locale.

Examples