Access to CLDR's minimal pairs: short translated phrases that show a grammatical form in context.
A minimal pair is the smallest sentence that distinguishes one form from
another — English cardinals are "{0} day" and "{0} days", which differ
only in the plural. CLDR ships them so translators can check that a rule
selects the form they expect, and they serve the same purpose at runtime
for anything that wants to show a worked example of a locale's plural,
ordinal, case or gender behaviour.
Four categories are available, and which of them a locale has depends on its grammar: every locale has cardinals, most have ordinals, and only locales that inflect for case or gender carry those.
Summary
Types
A grammatical feature CLDR ships minimal pairs for.
Functions
Returns the cardinal minimal pairs for a locale.
Returns the categories for which minimal pairs may be available.
Formats a number into the minimal pair its plural category selects.
Returns the grammatical-case minimal pairs for a locale.
Returns the grammatical-gender minimal pairs for a locale.
Returns the ordinal minimal pairs for a locale.
Types
Functions
@spec cardinal(Localize.locale()) :: {:ok, %{required(atom()) => String.t()}} | {:error, Exception.t()}
Returns the cardinal minimal pairs for a locale.
Arguments
localeis a locale identifier atom, string, or aLocalize.LanguageTag.t/0.
Returns
{:ok, map}of plural category to phrase, such as%{one: "{0} day", other: "{0} days"}. The map is empty for a locale CLDR ships no pairs for.{:error, exception}if the locale is unknown.
Examples
iex> {:ok, pairs} = Localize.MinimalPairs.cardinal(:en)
iex> pairs[:one]
"{0} day"@spec categories() :: [category(), ...]
Returns the categories for which minimal pairs may be available.
Returns
[:cardinal, :ordinal, :case, :gender].
Examples
iex> Localize.MinimalPairs.categories()
[:cardinal, :ordinal, :case, :gender]@spec format(number(), :cardinal | :ordinal, Keyword.t()) :: {:ok, String.t()} | {:error, Exception.t()}
Formats a number into the minimal pair its plural category selects.
Picks the cardinal or ordinal phrase the number would take in this locale and substitutes the number into it, which is what makes minimal pairs useful as a check: the output is the sentence a correct implementation should produce.
Arguments
numberis any number.categoryis:cardinal(the default) or:ordinal.
Options
:localeis any locale returned byLocalize.all_locale_ids/0. Defaults toLocalize.get_locale/0.
Returns
{:ok, string}with the number substituted for{0}.{:error, exception}if the number or options are not valid, the locale is unknown, the category is not:cardinalor:ordinal, or the locale has no pair for the category the number selects.
Examples
iex> Localize.MinimalPairs.format(1, :cardinal, locale: :en)
{:ok, "1 day"}
iex> Localize.MinimalPairs.format(3, :cardinal, locale: :en)
{:ok, "3 days"}
iex> Localize.MinimalPairs.format(2, :ordinal, locale: :en)
{:ok, "Take the 2nd right."}
iex> Localize.MinimalPairs.format(2, locale: :en)
{:ok, "2 days"}@spec grammatical_case(Localize.locale()) :: {:ok, %{required(atom()) => String.t()}} | {:error, Exception.t()}
Returns the grammatical-case minimal pairs for a locale.
Arguments
localeis a locale identifier atom, string, or aLocalize.LanguageTag.t/0.
Returns
{:ok, map}of case name to phrase. Empty for a locale that does not inflect for case.{:error, exception}if the locale is unknown.
Examples
iex> {:ok, pairs} = Localize.MinimalPairs.grammatical_case(:de)
iex> Map.keys(pairs) |> Enum.sort()
[:accusative, :dative, :genitive, :nominative]
iex> Localize.MinimalPairs.grammatical_case(:en)
{:ok, %{}}@spec grammatical_gender(Localize.locale()) :: {:ok, %{required(atom()) => String.t()}} | {:error, Exception.t()}
Returns the grammatical-gender minimal pairs for a locale.
Arguments
localeis a locale identifier atom, string, or aLocalize.LanguageTag.t/0.
Returns
{:ok, map}of gender name to phrase. Empty for a locale that does not inflect for gender.{:error, exception}if the locale is unknown.
Examples
iex> {:ok, pairs} = Localize.MinimalPairs.grammatical_gender(:de)
iex> Map.keys(pairs) |> Enum.sort()
[:feminine, :masculine, :neuter]@spec ordinal(Localize.locale()) :: {:ok, %{required(atom()) => String.t()}} | {:error, Exception.t()}
Returns the ordinal minimal pairs for a locale.
Arguments
localeis a locale identifier atom, string, or aLocalize.LanguageTag.t/0.
Returns
{:ok, map}of plural category to phrase, such as%{one: "Take the {0}st right.", other: "Take the {0}th right."}.{:error, exception}if the locale is unknown.
Examples
iex> {:ok, pairs} = Localize.MinimalPairs.ordinal(:en)
iex> pairs[:two]
"Take the {0}nd right."