Expand description
Risk metrics: volatility, Sharpe, Sortino, max drawdown, beta, rolling drawdown.
§Error handling (v0.1+)
All public functions return FinanceResult. Short series, zero sample vol, empty
prices, and length mismatches yield structured FinanceError values.
Functions§
- beta
- OLS beta of asset returns vs market returns (same length series).
- drawdown_
series - Running drawdown series (one value per price, starting at 0).
- max_
drawdown - Maximum peak-to-trough drawdown over a positive price series (most negative fraction).
- price_
volatility - Volatility of simple returns computed from consecutive prices.
- rolling_
max_ drawdown - Running maximum drawdown magnitude observed up to each price index.
- sharpe_
ratio - Sharpe ratio:
(mean - risk_free) / volatilityover the return series. - sortino_
ratio - Sortino ratio:
(mean - target) / downside_deviation, using returns belowtargetonly. - volatility
- Sample standard deviation of a return series (population divisor
n - 1). - volatility_
annualized - Annualized volatility:
volatility(returns) * sqrt(periods_per_year).