Cldr Numbers v2.6.3 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
Functions
Return the default number system type name.
Generate a transliteration map between two character classes
Returns {:ok, digits}
for a number system, or an {:error, message}
if the
number system is not known.
Returns digits
for a number system, or raises an exception if the
number system is not know.
Returns the actual number system from a number system type.
Returns the names of the number systems available for
a locale or an {:error, message}
tuple if the locale
is not known.
Returns the names of the number systems available for
a locale or an {:error, message}
tuple if the locale
is not known.
Return a map of all CLDR number systems and definitions.
Returns the number systems available for a locale
or {:error, message}
if the locale is not known.
Returns the number systems available for a locale or raises if the locale is not known.
Returns locale and number systems that have the same digits and separators as the supplied one.
Returns a number system name for a given locale and number system reference.
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.
Number systems that have their own digit characters defined.
Converts a number into the representation of a non-latin number system.
Converts a number into the representation of a non-latin number system. Returns a converted string or raises on error.
Returns an error tuple for an number system unknown to a given locale.
Link to this section Types
system_name()
View Source
system_name() :: atom()
system_name() :: atom()
types()
View Source
types() :: :default | :native | :traditional | :finance
types() :: :default | :native | :traditional | :finance
Link to this section Functions
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
generate_transliteration_map(from, to) View Source
Generate a transliteration map between two character classes
known_number_system_types(backend) View Source
known_number_systems() View Source
number_system_digits(system_name)
View Source
number_system_digits(system_name()) ::
{:ok, String.t()} | {:error, {module(), String.t()}}
number_system_digits(system_name()) :: {:ok, String.t()} | {:error, {module(), String.t()}}
Returns {:ok, digits}
for a number system, or an {:error, message}
if the
number system is not known.
system_name
is any number system name returned byCldr.known_number_systems/0
or a number system type returned byCldr.known_number_system_types/0
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"}}
number_system_digits!(system_name)
View Source
number_system_digits!(system_name()) :: String.t() | no_return()
number_system_digits!(system_name()) :: String.t() | no_return()
Returns digits
for a number system, or raises an exception if the
number system is not know.
system_name
is any number system name returned byCldr.known_number_systems/0
or a number system type returned byCldr.known_number_system_types/0
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
number_system_for(locale, system_name, backend)
View Source
number_system_for(
Cldr.Locale.locale_name() | Cldr.LanguageTag.t(),
Cldr.Number.System.system_name(),
Cldr.backend()
) :: {:ok, map()} | {:error, {module(), String.t()}}
number_system_for( Cldr.Locale.locale_name() | Cldr.LanguageTag.t(), Cldr.Number.System.system_name(), Cldr.backend() ) :: {:ok, map()} | {:error, {module(), String.t()}}
Returns the actual number system from a number system type.
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
system_name
is any number system name returned byCldr.known_number_systems/0
or a number system type returned byCldr.known_number_system_types/0
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 "th", :latn, TestBackend.Cldr
{:ok, %{digits: "0123456789", type: :numeric}}
iex> Cldr.Number.System.number_system_for "en", :default, TestBackend.Cldr
{:ok, %{digits: "0123456789", type: :numeric}}
iex> Cldr.Number.System.number_system_for "he", :traditional, TestBackend.Cldr
{:ok, %{rules: "hebrew", type: :algorithmic}}
iex> Cldr.Number.System.number_system_for "en", :finance, TestBackend.Cldr
{
: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 "en", :native, TestBackend.Cldr
{:ok, %{digits: "0123456789", type: :numeric}}
number_system_names_for(locale, backend)
View Source
number_system_names_for(
Cldr.Locale.locale_name() | Cldr.LanguageTag.t(),
Cldr.backend()
) :: {:ok, [atom()]} | {:error, {module(), String.t()}}
number_system_names_for( Cldr.Locale.locale_name() | Cldr.LanguageTag.t(), Cldr.backend() ) :: {:ok, [atom()]} | {:error, {module(), String.t()}}
Returns the names of the number systems available for
a locale or an {:error, message}
tuple if the locale
is not known.
locale
is any locale returned byCldr.Locale.new!/1
or aCldr.LanguageTag
struct
Examples
iex> Cldr.Number.System.number_system_names_for("en", TestBackend.Cldr)
{:ok, [:latn]}
iex> Cldr.Number.System.number_system_names_for("th", TestBackend.Cldr)
{:ok, [:latn, :thai]}
iex> Cldr.Number.System.number_system_names_for("he", TestBackend.Cldr)
{:ok, [:latn, :hebr]}
iex> Cldr.Number.System.number_system_names_for("zz", TestBackend.Cldr)
{:error, {Cldr.UnknownLocaleError, "The locale \"zz\" is not known."}}
number_system_names_for!(locale, backend)
View Source
number_system_names_for!(
Cldr.Locale.locale_name() | Cldr.LanguageTag.t(),
Cldr.backend()
) :: [system_name()] | no_return()
number_system_names_for!( Cldr.Locale.locale_name() | Cldr.LanguageTag.t(), Cldr.backend() ) :: [system_name()] | no_return()
Returns the names of the number systems available for
a locale or an {:error, message}
tuple if the locale
is not known.
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
Examples
iex> Cldr.Number.System.number_system_names_for!("en", TestBackend.Cldr)
[:latn]
iex> Cldr.Number.System.number_system_names_for!("th", TestBackend.Cldr)
[:latn, :thai]
iex> Cldr.Number.System.number_system_names_for!("he", TestBackend.Cldr)
[:latn, :hebr]
number_systems()
View Source
number_systems() :: map()
number_systems() :: map()
Return a map of all CLDR number systems and definitions.
Example
iex> Cldr.Number.System.number_systems |> Enum.count
83
number_systems_for(locale, backend)
View Source
number_systems_for(
Cldr.Locale.locale_name() | Cldr.LanguageTag.t(),
Cldr.backend()
) :: {:ok, map()} | {:error, {module(), String.t()}}
number_systems_for( Cldr.Locale.locale_name() | Cldr.LanguageTag.t(), Cldr.backend() ) :: {:ok, map()} | {:error, {module(), String.t()}}
Returns the number systems available for a locale
or {:error, message}
if the locale is not known.
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
Examples
iex> Cldr.Number.System.number_systems_for "en", TestBackend.Cldr
{:ok, %{default: :latn, native: :latn}}
iex> Cldr.Number.System.number_systems_for "th", TestBackend.Cldr
{:ok, %{default: :latn, native: :thai}}
iex> Cldr.Number.System.number_systems_for "zz", TestBackend.Cldr
{:error, {Cldr.UnknownLocaleError, "The locale \"zz\" is not known."}}
number_systems_for!(locale, backend)
View Source
number_systems_for!(
Cldr.Locale.locale_name() | Cldr.LanguageTag.t(),
Cldr.backend()
) :: map() | no_return()
number_systems_for!( Cldr.Locale.locale_name() | Cldr.LanguageTag.t(), Cldr.backend() ) :: map() | no_return()
Returns the number systems available for a locale or raises if the locale is not known.
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
Examples
iex> Cldr.Number.System.number_systems_for! "en", TestBackend.Cldr
%{default: :latn, native: :latn}
iex> Cldr.Number.System.number_systems_for! "th", TestBackend.Cldr
%{default: :latn, native: :thai}
number_systems_like(locale, number_system, backend)
View Source
number_systems_like(
Cldr.LanguageTag.t() | Cldr.Locale.locale_name(),
system_name(),
Cldr.backend()
) :: {:ok, list()} | {:error, {module(), String.t()}}
number_systems_like( Cldr.LanguageTag.t() | Cldr.Locale.locale_name(), system_name(), Cldr.backend() ) :: {:ok, list()} | {:error, {module(), String.t()}}
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.
system_name_from(system_name, locale, backend)
View Source
system_name_from(
system_name(),
Cldr.Locale.locale_name() | Cldr.LanguageTag.t(),
Cldr.backend()
) :: {:ok, atom()} | {:error, {module(), String.t()}}
system_name_from( system_name(), Cldr.Locale.locale_name() | Cldr.LanguageTag.t(), Cldr.backend() ) :: {:ok, atom()} | {:error, {module(), String.t()}}
Returns a number system name for a given locale and number system reference.
system_name
is any number system name returned byCldr.known_number_systems/0
or a number system type returned byCldr.known_number_system_types/0
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
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, "en", TestBackend.Cldr)
{:ok, :latn}
iex> Cldr.Number.System.system_name_from("latn", "en", TestBackend.Cldr)
{:ok, :latn}
iex> Cldr.Number.System.system_name_from(:native, "en", TestBackend.Cldr)
{:ok, :latn}
iex> Cldr.Number.System.system_name_from(:nope, "en", TestBackend.Cldr)
{
: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.
system_name_from!(system_name, locale, backend)
View Source
system_name_from!(
system_name(),
Cldr.Locale.locale_name() | Cldr.LanguageTag.t(),
Cldr.backend()
) :: atom() | no_return()
system_name_from!( system_name(), Cldr.Locale.locale_name() | Cldr.LanguageTag.t(), Cldr.backend() ) :: atom() | no_return()
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
is any number system name returned byCldr.known_number_systems/0
or a number system type returned byCldr.known_number_system_types/0
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
Examples
iex> Cldr.Number.System.system_name_from!(:default, "en", TestBackend.Cldr) :latn
iex> Cldr.Number.System.system_name_from!("latn", "en", TestBackend.Cldr) :latn
iex> Cldr.Number.System.system_name_from!(:traditional, "he", TestBackend.Cldr) :hebr
systems_with_digits() View Source
Number systems that have their own digit characters defined.
to_system(number, system_name, backend)
View Source
to_system(Cldr.Math.number_or_decimal(), atom(), Cldr.backend()) ::
{:ok, binary()} | {:error, {module(), String.t()}}
to_system(Cldr.Math.number_or_decimal(), atom(), Cldr.backend()) :: {:ok, binary()} | {:error, {module(), 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.
number
is afloat
,integer
orDecimal
system_name
is any number system name returned byCldr.known_number_systems/0
or a number system type returned byCldr.known_number_system_types/0
There are two types of number systems in CLDR:
:numeric
in which the number system defines a direct mapping between the latin digits0..9
into a the number system equivalent. In this case,to_system/3
invokesCldr.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 throughCldr.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, TestBackend.Cldr
{:ok, "ק׳׳ת׳"}
iex> Cldr.Number.System.to_system 123, :hans, TestBackend.Cldr
{:ok, "一百二十三"}
iex> Cldr.Number.System.to_system 123, :hant, TestBackend.Cldr
{:ok, "一百二十三"}
iex> Cldr.Number.System.to_system 123, :hansfin, TestBackend.Cldr
{:ok, "壹佰贰拾叁"}
to_system!(number, system_name, backend)
View Source
to_system!(Cldr.Math.number_or_decimal(), atom(), Cldr.backend()) ::
binary() | no_return()
to_system!(Cldr.Math.number_or_decimal(), atom(), Cldr.backend()) :: binary() | no_return()
Converts a number into the representation of a non-latin number system. Returns a converted string or raises on error.
number
is afloat
,integer
orDecimal
system_name
is any number system name returned byCldr.known_number_systems/1
or a number system type returned byCldr.known_number_system_types/0
See Cldr.Number.System.to_system/3
for further
information.
Examples
iex> Cldr.Number.System.to_system! 123, :hans, TestBackend.Cldr
"一百二十三"
iex> Cldr.Number.System.to_system! 123, :hant, TestBackend.Cldr
"一百二十三"
iex> Cldr.Number.System.to_system! 123, :hansfin, TestBackend.Cldr
"壹佰贰拾叁"
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.
number_system
is any number system name not returned byCldr.known_number_systems/0
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct returned byCldr.Locale.new!/1
valid_number_systems
is a map returned byCldr.Number.System.number_systems_for/2