# `Localize.Unit.Operators`
[🔗](https://github.com/elixir-localize/localize/blob/v0.39.0/lib/localize/unit/operators.ex#L1)

Overloaded arithmetic operators for `Localize.Unit.t()` values.

When `use Localize.Unit.Operators` is added to a module, the `+`,
`-`, `*`, and `/` operators are overridden so that they dispatch to
`Localize.Unit.Math` when one or both operands is a
`%Localize.Unit{}` struct. For all other types, the standard
Elixir/Erlang operators are used.

The operators raise on error (they use the bang convention
internally) so they can be used in natural arithmetic
expressions.

## Usage

    defmodule MyApp.Physics do
      use Localize.Unit.Operators

      def kinetic_energy(mass, velocity) do
        # mass and velocity are Localize.Unit structs
        half = Localize.Unit.Math.mult(mass, 0.5) |> elem(1)
        half * velocity * velocity
      end
    end

## Supported operations

| Expression | Delegates to | Notes |
|---|---|---|
| `unit + unit` | `Localize.Unit.Math.add/2` | Units must be convertible. |
| `unit - unit` | `Localize.Unit.Math.sub/2` | Units must be convertible. |
| `unit * number` | `Localize.Unit.Math.mult/2` | Scalar multiplication. |
| `number * unit` | `Localize.Unit.Math.mult/2` | Commutative. |
| `unit * unit` | `Localize.Unit.Math.mult/2` | Produces compound unit. |
| `unit / number` | `Localize.Unit.Math.div/2` | Scalar division. |
| `unit / unit` | `Localize.Unit.Math.div/2` | Produces compound unit. |
| any other types | `Kernel.+/2`, `Kernel.-/2`, `Kernel.*/2`, `Kernel.//2` | Standard Elixir. |

> #### Scope {: .info}
>
> The operator overrides apply only within the module that calls
> `use Localize.Unit.Operators`. They do not affect other modules
> or global operator behaviour.

# `*`

Multiplies two values. When either operand is a
`%Localize.Unit{}` struct, delegates to
`Localize.Unit.Math.mult/2`. Otherwise falls through to
`Kernel.*/2`.

# `+`

Adds two values. When both are `%Localize.Unit{}` structs,
delegates to `Localize.Unit.Math.add/2`. Otherwise falls
through to `Kernel.+/2`.

# `-`

Subtracts two values. When both are `%Localize.Unit{}` structs,
delegates to `Localize.Unit.Math.sub/2`. Otherwise falls
through to `Kernel.-/2`.

# `/`

Divides two values. When the left operand is a
`%Localize.Unit{}` struct, delegates to
`Localize.Unit.Math.div/2`. Otherwise falls through to
`Kernel.//2`.

---

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