Quantity v0.2.0 Quantity View Source

Encodes the quantity as a string. The result is parsable with parse/1 If the exponent is positive, encode usinge the "raw" format to preserve precision

unit(quantity)

Extracts the unit from the quantity

Link to this section Types

t()

t() :: %Quantity{unit: String.t(), value: Decimal.t()}

Link to this section Functions

add(quantity_1, quantity_2)

See Quantity.Math.add/2.

add!(quantity_1, quantity_2)

See Quantity.Math.add!/2.

base_value(quantity)

base_value(t()) :: integer()

Extracts the base value from the quantity

exponent(quantity)

exponent(t()) :: integer()

Extracts the exponent from the quantity

new(value, unit)

new(Decimal.t(), String.t()) :: t()

Builds a new Quantity from a Decimal and a unit

new(base_value, exponent, unit)

new(integer(), integer(), String.t()) :: t()

Builds a new Quantity from a base value, exponent and unit

parse(input)

parse(String.t()) :: {:ok, t()} | :error

Parses a string representation of a quantity (perhaps generated with to_string/1)

parse!(input)

parse!(String.t()) :: t()

Same as parse/1, but errors if it could not parse

sub(quantity_1, quantity_2)

See Quantity.Math.sub/2.

sub!(quantity_1, quantity_2)

See Quantity.Math.sub!/2.

sum(quantities)

See Quantity.Math.sum/1.

sum(quantities, exp, unit)

See Quantity.Math.sum/3.

sum!(quantities)

See Quantity.Math.sum!/1.

sum!(quantities, exp, unit)

See Quantity.Math.sum!/3.

to_string(quantity)

to_string(t()) :: String.t()

Encodes the quantity as a string. The result is parsable with parse/1 If the exponent is positive, encode usinge the "raw" format to preserve precision

iex> Quantity.new(42, -1, "db") |> Quantity.to_string() "4.2 db" iex> Quantity.new(42, 1, "db") |> Quantity.to_string() "42E1 db"

unit(quantity)

unit(t()) :: String.t()

Extracts the unit from the quantity