Packages
localize
1.0.0-rc.1
1.0.0-rc.4
1.0.0-rc.3
1.0.0-rc.2
1.0.0-rc.1
1.0.0-rc.0
0.50.0
0.49.0
0.48.0
0.47.0
0.46.0
0.45.0
0.44.0
0.41.3
0.41.2
0.41.1
0.41.0
0.40.0
0.39.0
0.38.0
0.37.0
0.36.0
0.35.0
0.34.0
0.33.0
0.32.0
0.31.0
0.30.1
0.30.0
retired
0.29.0
0.28.0
0.27.0
0.26.0
0.25.0
0.24.0
0.23.0
0.22.0
0.21.0
0.20.0
0.19.0
0.18.0
0.16.0
0.15.0
0.14.0
0.13.0
0.12.0
0.11.0
0.10.0
0.9.0
0.8.0
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.0
0.1.0-alpha.1
Localization (parsing, formatting) of numbers, dates/time/calendar, units of measure, messages and lists. Includes localized collation.
Current section
Files
Jump to
Current section
Files
lib/localize/utils/decimal.ex
defmodule Localize.Utils.Decimal do
# Compatibility layer for `Decimal` library operations.
#
# Provides normalized function signatures for common `Decimal`
# operations used throughout Localize.
#
@moduledoc false
@doc """
Normalizes a `Decimal` value by removing trailing zeros from the coefficient.
### Arguments
* `decimal` — a `Decimal.t()` value to normalize.
### Returns
* A normalized `Decimal.t()`.
### Examples
iex> Localize.Utils.Decimal.reduce(Decimal.new("1.20"))
Decimal.new("1.2")
"""
@spec reduce(Decimal.t()) :: Decimal.t()
def reduce(decimal) do
Decimal.normalize(decimal)
end
@doc """
Compares two `Decimal` values.
### Arguments
* `decimal_1` — a `Decimal.t()` value.
* `decimal_2` — a `Decimal.t()` value.
### Returns
* `:lt` if `decimal_1` is less than `decimal_2`.
* `:eq` if they are equal.
* `:gt` if `decimal_1` is greater than `decimal_2`.
### Examples
iex> Localize.Utils.Decimal.compare(Decimal.new("1.0"), Decimal.new("2.0"))
:lt
"""
@spec compare(Decimal.t(), Decimal.t()) :: :eq | :lt | :gt
def compare(decimal_1, decimal_2) do
Decimal.compare(decimal_1, decimal_2)
end
@doc """
Parses a string into a `Decimal` value.
### Arguments
* `string` — a string representation of a number.
### Returns
* `{decimal, ""}` if the string was successfully parsed.
* `{:error, string}` if the string could not be parsed.
### Examples
iex> Localize.Utils.Decimal.parse("3.14")
{Decimal.new("3.14"), ""}
iex> Localize.Utils.Decimal.parse("not_a_number")
{:error, "not_a_number"}
"""
@spec parse(String.t()) :: {Decimal.t(), String.t()} | {:error, String.t()}
def parse(string) do
case Decimal.parse(string) do
{decimal, ""} -> {decimal, ""}
_other -> {:error, string}
end
end
end