Repository Public
1import Foundation2import SheetCore3import Statistics45/// Statement line items for one period. Balance-sheet items are period-end balances; pass the6/// prior period's balances to `FinancialRatios.compute` to use averages in turnover and return ratios.7public struct StatementItems: Sendable, Hashable, Codable {8 // income statement9 public var revenue: Double10 public var costOfGoodsSold: Double11 /// EBIT.12 public var operatingIncome: Double13 public var interestExpense: Double14 /// Earnings before tax.15 public var pretaxIncome: Double16 public var netIncome: Double17 public var depreciationAmortization: Double18 // balance sheet19 public var cash: Double20 public var marketableSecurities: Double21 public var receivables: Double22 public var inventory: Double23 public var currentAssets: Double24 public var totalAssets: Double25 public var payables: Double26 public var currentLiabilities: Double27 /// Interest-bearing debt (short- and long-term).28 public var totalDebt: Double29 public var totalLiabilities: Double30 public var equity: Double3132 public init(revenue: Double, costOfGoodsSold: Double, operatingIncome: Double, interestExpense: Double, pretaxIncome: Double,33 netIncome: Double, depreciationAmortization: Double = 0, cash: Double, marketableSecurities: Double = 0, receivables: Double,34 inventory: Double, currentAssets: Double, totalAssets: Double, payables: Double, currentLiabilities: Double,35 totalDebt: Double, totalLiabilities: Double, equity: Double) {36 self.revenue = revenue; self.costOfGoodsSold = costOfGoodsSold; self.operatingIncome = operatingIncome37 self.interestExpense = interestExpense; self.pretaxIncome = pretaxIncome; self.netIncome = netIncome38 self.depreciationAmortization = depreciationAmortization; self.cash = cash; self.marketableSecurities = marketableSecurities39 self.receivables = receivables; self.inventory = inventory; self.currentAssets = currentAssets; self.totalAssets = totalAssets40 self.payables = payables; self.currentLiabilities = currentLiabilities; self.totalDebt = totalDebt41 self.totalLiabilities = totalLiabilities; self.equity = equity42 }43}4445/// One computed ratio with the formula that produced it.46public struct RatioValue: Sendable, Hashable, Codable {47 public var name: String48 public var category: String49 /// nil when the denominator is zero (the ratio is undefined).50 public var value: Double?51 public var formula: String52}5354public struct FinancialRatios: Sendable, Hashable, Codable, TableReport {55 public var ratios: [RatioValue]56 /// True when turnover/return ratios used the average of opening and closing balances.57 public var usesAverageBalances: Bool58 public var daysInPeriod: Double5960 public subscript(name: String) -> Double? { ratios.first { $0.name == name }?.value }6162 public func table() -> [[Value]] {63 var out: [[Value]] = [[.text("Category"), .text("Ratio"), .text("Value"), .text("Formula")]]64 for r in ratios { out.append([.text(r.category), .text(r.name), Report.num(r.value), .text(r.formula)]) }65 return out66 }6768 /// Computes liquidity, leverage, profitability, efficiency and DuPont ratios.69 ///70 /// When `prior` is given, balance-sheet denominators of flow ratios (turnovers, ROA, ROE, DuPont)71 /// are the average of the prior and current balances; otherwise period-end balances are used.72 /// `daysInPeriod` converts turnovers to days (365 for annual statements, 90 for a quarter…).73 /// A ratio whose denominator is zero is reported as nil, never as infinity.74 public static func compute(_ s: StatementItems, prior: StatementItems? = nil, daysInPeriod: Double = 365) -> FinancialRatios {75 func div(_ a: Double, _ b: Double) -> Double? { b != 0 && a.isFinite && b.isFinite ? a / b : nil }76 func avg(_ key: KeyPath<StatementItems, Double>) -> Double { prior.map { ($0[keyPath: key] + s[keyPath: key]) / 2 } ?? s[keyPath: key] }77 let a = prior != nil ? "average " : ""78 var out = [RatioValue]()79 func add(_ category: String, _ name: String, _ v: Double?, _ formula: String) { out.append(RatioValue(name: name, category: category, value: v, formula: formula)) }8081 let grossProfit = s.revenue - s.costOfGoodsSold82 let ebitda = s.operatingIncome + s.depreciationAmortization83 // liquidity84 add("Liquidity", "Current ratio", div(s.currentAssets, s.currentLiabilities), "current assets / current liabilities")85 add("Liquidity", "Quick ratio", div(s.cash + s.marketableSecurities + s.receivables, s.currentLiabilities), "(cash + marketable securities + receivables) / current liabilities")86 add("Liquidity", "Cash ratio", div(s.cash + s.marketableSecurities, s.currentLiabilities), "(cash + marketable securities) / current liabilities")87 add("Liquidity", "Working capital", s.currentAssets - s.currentLiabilities, "current assets − current liabilities")88 // leverage89 add("Leverage", "Debt to equity", div(s.totalDebt, s.equity), "total debt / equity")90 add("Leverage", "Debt to assets", div(s.totalDebt, s.totalAssets), "total debt / total assets")91 add("Leverage", "Liabilities to assets", div(s.totalLiabilities, s.totalAssets), "total liabilities / total assets")92 add("Leverage", "Equity multiplier", div(avg(\.totalAssets), avg(\.equity)), "\(a)total assets / \(a)equity")93 add("Leverage", "Interest coverage", div(s.operatingIncome, s.interestExpense), "EBIT / interest expense")94 add("Leverage", "Net debt to EBITDA", div(s.totalDebt - s.cash - s.marketableSecurities, ebitda), "(total debt − cash − marketable securities) / (EBIT + D&A)")95 // profitability96 add("Profitability", "Gross margin", div(grossProfit, s.revenue), "(revenue − COGS) / revenue")97 add("Profitability", "Operating margin", div(s.operatingIncome, s.revenue), "EBIT / revenue")98 add("Profitability", "EBITDA margin", div(ebitda, s.revenue), "(EBIT + D&A) / revenue")99 add("Profitability", "Net margin", div(s.netIncome, s.revenue), "net income / revenue")100 add("Profitability", "Return on assets", div(s.netIncome, avg(\.totalAssets)), "net income / \(a)total assets")101 add("Profitability", "Return on equity", div(s.netIncome, avg(\.equity)), "net income / \(a)equity")102 // efficiency103 let assetTurnover = div(s.revenue, avg(\.totalAssets))104 let invTurn = div(s.costOfGoodsSold, avg(\.inventory))105 let recTurn = div(s.revenue, avg(\.receivables))106 let payTurn = div(s.costOfGoodsSold, avg(\.payables))107 add("Efficiency", "Asset turnover", assetTurnover, "revenue / \(a)total assets")108 add("Efficiency", "Inventory turnover", invTurn, "COGS / \(a)inventory")109 add("Efficiency", "Receivables turnover", recTurn, "revenue / \(a)receivables")110 add("Efficiency", "Payables turnover", payTurn, "COGS / \(a)payables")111 let dio = div(avg(\.inventory) * daysInPeriod, s.costOfGoodsSold)112 let dso = div(avg(\.receivables) * daysInPeriod, s.revenue)113 let dpo = div(avg(\.payables) * daysInPeriod, s.costOfGoodsSold)114 add("Efficiency", "Days inventory outstanding", dio, "\(a)inventory × days / COGS")115 add("Efficiency", "Days sales outstanding", dso, "\(a)receivables × days / revenue")116 add("Efficiency", "Days payables outstanding", dpo, "\(a)payables × days / COGS")117 var ccc: Double?118 if let dio, let dso, let dpo { ccc = dio + dso - dpo }119 add("Efficiency", "Cash conversion cycle", ccc, "DIO + DSO − DPO")120 // DuPont121 let margin = div(s.netIncome, s.revenue), em = div(avg(\.totalAssets), avg(\.equity))122 var roe3: Double?123 if let margin, let assetTurnover, let em { roe3 = margin * assetTurnover * em }124 add("DuPont", "DuPont ROE (3-step)", roe3, "net margin × asset turnover × equity multiplier")125 let taxBurden = div(s.netIncome, s.pretaxIncome), interestBurden = div(s.pretaxIncome, s.operatingIncome), ebitMargin = div(s.operatingIncome, s.revenue)126 add("DuPont", "Tax burden", taxBurden, "net income / pretax income")127 add("DuPont", "Interest burden", interestBurden, "pretax income / EBIT")128 var roe5: Double?129 if let taxBurden, let interestBurden, let ebitMargin, let assetTurnover, let em { roe5 = taxBurden * interestBurden * ebitMargin * assetTurnover * em }130 add("DuPont", "DuPont ROE (5-step)", roe5, "tax burden × interest burden × EBIT margin × asset turnover × equity multiplier")131 return FinancialRatios(ratios: out, usesAverageBalances: prior != nil, daysInPeriod: daysInPeriod)132 }133}134