Packages

Functions for computing financial metrics

Current section

Files

Jump to
ht_finfunc lib ht_finfunc.ex
Raw

lib/ht_finfunc.ex

defmodule HtFinfunc do
@moduledoc """
HtFinFunc defines methods for working with financial data.
"""
@doc """
Calculate the return on equity given net_income and stockholder's equity.
## Examples
iex> HtFinfunc.return_on_equity(100, 200)
0.5
"""
def return_on_equity(net_income, equity) when is_list(equity), do:
net_income / (Enum.sum(equity) / Enum.count(equity))
def return_on_equity(net_income, equity), do: net_income / equity
end