Cldr.Number.PluralRule (Cldr v2.26.0) View Source

Defines the plural rule implementation modules. The functions in this module generates code to implement the plural rules of CLDR.

Link to this section Summary

Types

operand()

plural_type()

Defines the plural types into which a number can be categorised.

Functions

known_plural_types()

Returns a list of the possible pluralization types

plural_type(number, backend \\ nil, options \\ [])

Returns the plural type for a given number.

Link to this section Types

operand()

Specs

operand() :: any()

plural_type()

Specs

plural_type() :: :zero | :one | :two | :few | :many | :other

Defines the plural types into which a number can be categorised.

Link to this section Functions

known_plural_types()

Specs

known_plural_types() :: [plural_type()]

Returns a list of the possible pluralization types

plural_type(number, backend \\ nil, options \\ [])

Returns the plural type for a given number.

Arguments

number is an integer, float or Decimal number
backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend!/0.
options is a keyword list of options

Options

locale is any valid locale name returned by Cldr.known_locale_names/1 or a Cldr.LanguageTag struct returned by Cldr.Locale.new!/2, The default is Cldr.get_locale/0.
backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend!/0. This option allows the backend to be specified as an argument or an option.
type is either Cardinal or Ordinal. The default is Cardinal.

Examples

iex> Cldr.Number.PluralRule.plural_type(123)
:other

iex> Cldr.Number.PluralRule.plural_type(123, type: Ordinal)
:few

iex> Cldr.Number.PluralRule.plural_type(123, type: Cardinal)
:other

iex> Cldr.Number.PluralRule.plural_type(2, locale: "de")
:other