SPB Git

Repository Public

HoltWinters.swift 5.1 KB 110 lines swift

1// =============================================================================2//                  SP BOUCHER | SOFTWARE & RESEARCH3//             ARTIFICIAL INTELLIGENCE • FINANCE • ENGINEERING4// =============================================================================5//6// PROJECT METADATA7// -----------------------------------------------------------------------------8// Project          : ORIX Sheet9// File             : Packages/SheetAnalytics/Sources/FinanceModels/Forecasting/HoltWinters.swift10// Module           : FinanceModels11// Repository       : https://git.spboucher.ai/orix-sheet12// Created          : 2026-11-2113// Last Modified    : 2026-11-2114//15// =============================================================================16// AUTHOR & PROFESSIONAL AFFILIATION17// =============================================================================18//19// Author           : Simon-Pierre Boucher20// Position         : Professor of Finance21// Institution      : Université du Québec en Outaouais (UQO)22// Department       : Département des sciences administratives23// Organization     : SP Boucher24//25// Website          : https://spboucher.ai26// Git              : https://git.spboucher.ai27//28// =============================================================================29// OFFICIAL CONTACT DIRECTORY30// =============================================================================31//32// General          : info@spboucher.ai33// Professional     : contact@spboucher.ai34// Direct           : simon@spboucher.ai35// Research         : research@spboucher.ai36// Development      : dev@spboucher.ai37// Support          : support@spboucher.ai38// Security/Admin   : admin@spboucher.ai39// Notifications    : notifications@spboucher.ai40//41// Preferred Contact: support@spboucher.ai42//43// =============================================================================44// COPYRIGHT & INTELLECTUAL PROPERTY45// =============================================================================46//47// Copyright (c) 202648// Simon-Pierre Boucher49//50// All rights reserved where applicable.51//52// This file is governed by the applicable project license,53// copyright notices, institutional agreements and relevant law.54//55// Unless expressly authorized by the applicable license or56// rights holder, copying, redistribution, sublicensing,57// publication and commercial exploitation are not permitted.58//59// Existing third-party rights and notices remain unaffected.60//61// =============================================================================62// CONFIDENTIALITY & SECURITY63// =============================================================================64//65// Classification   : Public66// Distribution     : Public repository; use is governed by the project license67// Security Contact : admin@spboucher.ai68//69// Access to this source does not independently grant permission70// to redistribute or disclose confidential materials.71//72// Do not embed credentials, private keys, access tokens,73// certificates or confidential personal information.74//75// =============================================================================76// LICENSE & MAINTENANCE77// =============================================================================78//79// License          : None specified (no license file in this repository)80// Maintainer       : Simon-Pierre Boucher81// Technical Contact: dev@spboucher.ai82//83// =============================================================================84// END OF SP BOUCHER SOURCE HEADER85// =============================================================================8687import Foundation88import Statistics8990extension Forecasting {91    /// Holt–Winters forecast of a seasonal series (thin wrapper over `Statistics.ExponentialSmoothing`):92    /// additive trend, additive or multiplicative seasonality of length `seasonLength`, smoothing93    /// parameters chosen by minimising the in-sample sum of squared errors. Returns the fit, so the94    /// caller can read the parameters and error measures, and call `forecast(h)` or — for additive95    /// seasonality only, where the closed formulas exist — `forecastInterval(h)`.96    /// Needs at least two full seasons of data.97    public static func holtWinters(_ y: [Double], seasonLength m: Int, multiplicative: Bool = false,98                                   dampedTrend: Bool = false) throws -> ExponentialSmoothingFit {99        guard m >= 2 else { throw StatError.invalidInput("season length must be at least 2") }100        guard y.count >= 2 * m else { throw StatError.insufficientData("Holt–Winters needs at least two full seasons") }101        return try ExponentialSmoothing.fit(y, trend: dampedTrend ? .dampedAdditive : .additive,102                                            seasonal: multiplicative ? .multiplicative : .additive, period: m)103    }104105    /// Point forecasts for the next `horizon` periods by Holt–Winters (see `holtWinters`).106    public static func holtWintersForecast(_ y: [Double], seasonLength m: Int, horizon: Int, multiplicative: Bool = false) throws -> [Double] {107        try holtWinters(y, seasonLength: m, multiplicative: multiplicative).forecast(horizon)108    }109}110
Files main
Menu

Theme