import { ReturnCalculationOptions } from '../schemas/ReturnCalculationOptionsSchema'; import { ReturnCalculationResult } from '../schemas/ReturnCalculationResultSchema'; /** * Calculate Returns from Price Data * * Calculates either simple returns or logarithmic returns from a series of asset prices. * * Simple Returns: * - Formula: r_t = (P_t - P_{t-1}) / P_{t-1} * - Additive property: Total return = (1 + r_1) * (1 + r_2) * ... * (1 + r_n) - 1 * - Used for: Portfolio performance, benchmark comparisons, money-weighted returns * * Logarithmic Returns: * - Formula: r_t = ln(P_t / P_{t-1}) * - Additive property: Total return = r_1 + r_2 + ... + r_n * - Used for: Statistical analysis, volatility calculations, risk models * * @param options - Price data, calculation method, and annualization parameters * @returns Calculated returns with statistics * * @example * ```typescript * // Simple returns for portfolio performance * const simpleReturns = calculateReturns({ * prices: [100, 105, 110, 108, 115], * method: 'simple', * annualize: true, * annualizationFactor: 252 * }); * * // Log returns for volatility analysis * const logReturns = calculateReturns({ * prices: [100, 105, 110, 108, 115], * method: 'log', * annualize: true, * annualizationFactor: 252 * }); * ``` */ export declare function calculateReturns(options: ReturnCalculationOptions): ReturnCalculationResult;