Annualize a monthly amount

Examples

iex> annualize(1) %Decimal{coef: 12, exp: 0}

iex> annualize("$145.23") %Decimal{coef: 174276, exp: -2}

iex> annualize(nil, 1) %Decimal{coef: 1, exp: 0}

Casts an x of type numeric/0 into a Decimal.t/0.

Examples

iex> cast_decimal(0.11) %Decimal{coef: 11, exp: -2}

iex> cast_decimal(%{sign: -1, coef: 11, exp: -2}) %Decimal{sign: -1, coef: 11, exp: -2}

iex> cast_decimal(%Decimal{sign: -1, coef: 11, exp: -2}) %Decimal{sign: -1, coef: 11, exp: -2}

iex> cast_decimal(1_000, :normal) %Decimal{coef: 1_000, exp: 0}

iex> cast_decimal(1_000, :reduced) %Decimal{coef: 1, exp: 3}

See DarkMatter.Decimals.Conversion.cast_decimal/2.

Casts an x of type numeric/0 into a Decimal.t/0.

Raises ArgumentError if given a non-numeric.

Examples

iex> cast_decimal!(0.11) %Decimal{coef: 11, exp: -2}

iex> cast_decimal!(nil) ** (ArgumentError) invalid argument nil

iex> cast_decimal!(1_000, :normal) %Decimal{coef: 1_000, exp: 0}

iex> cast_decimal!(1_000, :reduced) %Decimal{coef: 1, exp: 3}

See DarkMatter.Decimals.Conversion.cast_decimal!/2.

Casts an x of type numeric/0 into a Decimal.t/0.

Returns {:ok, %Decimal{}} or :error

Examples

iex> cast_decimal_ok(0.11) {:ok, %Decimal{coef: 11, exp: -2}}

iex> cast_decimal_ok(nil) :error

iex> cast_decimal_ok(1_000, :normal) {:ok, %Decimal{coef: 1_000, exp: 0}}

iex> cast_decimal_ok(1_000, :reduced) {:ok, %Decimal{coef: 1, exp: 3}}

See DarkMatter.Decimals.Conversion.cast_decimal_ok/2.

Adds x and y of type numeric/0.

Examples

iex> decimal_add(1, 2.5) %Decimal{coef: 35, exp: -1}

Averages a list of type numeric/0.

Examples

iex> decimal_avg([8, 9, "10.5", 13.3, "$1.23", %Decimal{coef: 33}]) %Decimal{coef: 12505, exp: -3}

iex> decimal_avg([], 711) %Decimal{coef: 711, exp: 0}

See DarkMatter.Decimals.Arithmetic.decimal_avg/2.

Compares x of type numeric/0 to y of type numeric/0.

Returns :eq or :gt or :lt.

Examples

iex> decimal_cmp(1, 1) :eq

iex> decimal_cmp(3, 0) :gt

iex> decimal_cmp(1, 2) :lt

Divides x and y of type numeric/0.

Returns 0 or default (if given) when dividing by 0.

Examples

iex> decimal_div(30, 2.5) %Decimal{coef: 12, exp: 0}

iex> decimal_div(0, 0) %Decimal{coef: 0, exp: 0}

iex> decimal_div(0, 0, 989) %Decimal{coef: 989, exp: 0}

See DarkMatter.Decimals.Arithmetic.decimal_div/3.

Determines if x of type numeric/0 is equivalent to y of type numeric/0.

Returns true or false.

Examples

iex> decimal_equal?(1, 1) true

iex> decimal_equal?(3, 0) false

iex> decimal_equal?(nil, 2) ** (FunctionClauseError) no function clause matching in Decimal.decimal/1

Multiplies x and y of type numeric/0.

Examples

iex> decimal_mult(33, 21.523) %Decimal{coef: 710259, exp: -3}

iex> decimal_mult(0, 0) %Decimal{coef: 0, exp: 0}

iex> decimal_mult(1, 989) %Decimal{coef: 989, exp: 0}

Gives the percentage of x relative to y of type numeric/0.

Examples

iex> decimal_percent(20, 100) %Decimal{coef: 2, exp: 1}

Rounds an x of type numeric/0 based on the opts.

Returns round_up * ((x + (round_up/2)) / round_up)

Examples

iex> decimal_round_ok(25.11, round_up: 50) {:ok, %Decimal{coef: 5, exp: 1}}

iex> decimal_round_ok(50, round_up: 50) {:ok, %Decimal{coef: 5, exp: 1}}

iex> decimal_round_ok(0, round_up: 50) {:ok, %Decimal{coef: 0, exp: 0}}

Subtracts x from y of type numeric/0.

Examples

iex> decimal_sub(1, 2.5) %Decimal{sign: -1, coef: 15, exp: -1}

Sums a list of type numeric/0.

Examples

iex> decimal_sum([8, 9, "10.5", 13.3, "$1.23", %Decimal{coef: 33}]) %Decimal{coef: 7503, exp: -2}

iex> decimal_sum([], 711) %Decimal{coef: 711, exp: 0}

See DarkMatter.Decimals.Arithmetic.decimal_sum/2.

Gives the decimal representation of anx of type numeric/0.

Examples

iex> from_percentage(25) %Decimal{coef: 25, exp: -2}

Determines the max variance percent of a list of type numeric/0.

Defaults to 100 if given an empty list.

Examples

iex> max_variance_percent([8, 9, "10.5", 13.3, "$1.23", %Decimal{coef: 33}]) %Decimal{coef: 2638944422231107556977209116, exp: -25}

iex> max_variance_percent([]) %Decimal{coef: 1, exp: 2}

iex> max_variance_percent([], {0, 100}) %Decimal{coef: 0, exp: 0}

iex> max_variance_percent([1], {0, 100}) %Decimal{coef: 1, exp: 2}

See DarkMatter.Decimals.Variance.max_variance_percent/2.

Rounds whether an x of type numeric/0 is already rounded according to opts

Examples

iex> rounded?(25.11, round_up: 50) false

iex> rounded?(50, round_up: 50) true

iex> rounded?(0, round_up: 50) true

Rounds an x of type numeric/0 into a integer/0.

Examples

iex> to_number(0.11) 0.11

iex> to_number(%Decimal{coef: 124_225, exp: -3}) 124.225

iex> to_number("$0") 0

iex> to_number(nil) nil

iex> to_number("xyz") nil

Gives the percentage representation of anx of type numeric/0.

Examples

iex> to_percentage(0.25) %Decimal{coef: 25, exp: 0}

Rounds an x of type nil or numeric/0 into a t:string/0.

Examples

iex> to_string(%Decimal{coef: 12, exp: -10}) "0.0000000012"

iex> to_string(%Decimal{coef: 124_225, exp: -3}) "124.225"

iex> to_string("$0") "0"

iex> to_string(nil) nil

iex> to_string("xyz") ** (Decimal.Error) invalid_operation: number parsing syntax: xyz

See DarkMatter.Decimals.Conversion.to_string/2.

Determines the variance of a list of type numeric/0.

Defaults to 0 if given an empty or single item list.

Examples

iex> variance([8, 9, "10.5", 13.3, "$1.23", %Decimal{coef: 33}]) %Decimal{coef: 11688055, exp: -5}

iex> variance([]) %Decimal{coef: 0, exp: 0}

iex> variance([1_000]) %Decimal{coef: 0, exp: 0}

Determines the variance percent of a list of type numeric/0.

Defaults to 0 if given an empty list or 100 if given a single item list.

Examples

iex> variance_percent([8, 9, "10.5", 13.3, "$1.23", %Decimal{coef: 33}]) %Decimal{coef: 2831837255702387281334649757, exp: -25}

iex> variance_percent([]) %Decimal{coef: 0, exp: 0}

iex> variance_percent([1_000]) %Decimal{coef: 1, exp: 2}

iex> variance_percent([], {0, 100}) %Decimal{coef: 0, exp: 0}

iex> variance_percent([1], {0, 100}) %Decimal{coef: 1, exp: 2}

See DarkMatter.Decimals.Variance.variance_percent/2.