# `Localize.Number.PluralRule`
[🔗](https://github.com/elixir-localize/localize/blob/v0.6.0/lib/localize/number/plural_rules/plural_rule.ex#L1)

Defines plural rule modules for cardinal and ordinal number
categories according to the CLDR plural rules specification.

At compile time, this module generates two child modules:

* `Localize.Number.PluralRule.Cardinal` — implements cardinal
  plural rules (used for counting: "1 item", "2 items").

* `Localize.Number.PluralRule.Ordinal` — implements ordinal
  plural rules (used for ordering: "1st", "2nd", "3rd").

Each generated module contains per-locale `plural_rule/2`
functions that classify a number into one of the CLDR plural
categories: `:zero`, `:one`, `:two`, `:few`, `:many`, or
`:other`.

# `operand`

```elixir
@type operand() :: any()
```

# `plural_rule`

```elixir
@type plural_rule() :: Keyword.t()
```

A plural rule definition before compilation.

# `plural_type`

```elixir
@type plural_type() :: :zero | :one | :two | :few | :many | :other
```

The plural categories into which a number can be classified.

# `known_plural_types`

```elixir
@spec known_plural_types() :: [plural_type(), ...]
```

Returns the list of possible plural categories.

### Returns

* A list of plural type atoms.

### Examples

    iex> Localize.Number.PluralRule.known_plural_types()
    [:zero, :one, :two, :few, :many, :other]

# `plural_type`

```elixir
@spec plural_type(number() | Decimal.t(), Keyword.t()) ::
  plural_type() | {:error, Exception.t()}
```

Returns the plural category for a given number.

### Arguments

* `number` is an integer, float, or Decimal number.

* `options` is a keyword list of options.

### Options

* `:locale` is any locale identifier string or a
  `t:Localize.LanguageTag.t/0`. The default is `"en"`.

* `:type` is either `:cardinal` or `:ordinal`.
  The default is `:cardinal`.

### Returns

* A plural category atom: `:zero`, `:one`, `:two`, `:few`,
  `:many`, or `:other`.

* `{:error, exception}` if no plural rules are available
  for the given locale.

### Examples

    iex> Localize.Number.PluralRule.plural_type(1, locale: "en")
    :one

    iex> Localize.Number.PluralRule.plural_type(2, locale: "en")
    :other

    iex> Localize.Number.PluralRule.plural_type(1, locale: "en", type: :ordinal)
    :one

    iex> Localize.Number.PluralRule.plural_type(2, locale: "en", type: :ordinal)
    :two

---

*Consult [api-reference.md](api-reference.md) for complete listing*