Repository Public MIT
1// ORIX Calc2// File: Packages/ORIXFeatureStatistics/Tests/ORIXFeatureStatisticsTests/RegressionTests.swift3// Description: Tests of the Regression section — demo against hand formulas, reference fits (simple, multiple, curves), exported expressions, rank deficiency, staleness.4//5// Author: Simon-Pierre Boucher6// Contact: contact@spboucher.ai7import Foundation8import Testing9import ORIXExpression10import ORIXStatistics11import ORIXUI12@testable import ORIXFeatureStatistics1314@MainActor @Suite struct RegressionTests {15 private func dataset(_ names: [String], _ columns: [[Double]]) -> Dataset { Dataset(title: "ref", names: names, columns: columns) }1617 @Test func demoMatchesTheNormalEquations() async throws {18 let data = DataModel()19 data.loadDemo()20 let m = RegressionModel()21 await m.loadDemo(dataset: data.dataset, dataRevision: data.revision)22 let o = try #require(m.output)23 let fit = try #require(o.simple)24 let x: [Double] = [2, 3.5, 4, 5, 5.5, 6, 7, 8, 8.5, 9, 10, 11.5], y: [Double] = [52, 58, 57, 64, 68, 66, 72, 79, 77, 83, 86, 93]25 let n = Double(x.count), mx = x.reduce(0, +) / n, my = y.reduce(0, +) / n26 let sxx = x.map { ($0 - mx) * ($0 - mx) }.reduce(0, +), sxy = zip(x, y).map { ($0 - mx) * ($1 - my) }.reduce(0, +), syy = y.map { ($0 - my) * ($0 - my) }.reduce(0, +)27 let slope = sxy / sxx, intercept = my - slope * mx28 let rss = zip(x, y).map { ($1 - intercept - slope * $0) * ($1 - intercept - slope * $0) }.reduce(0, +)29 #expect(close(fit.slope.estimate, slope, 1e-11) && close(fit.intercept.estimate, intercept, 1e-11))30 #expect(close(fit.rSquared, 1 - rss / syy, 1e-11))31 #expect(close(fit.correlation, sxy / (sxx * syy).squareRoot(), 1e-11))32 #expect(close(fit.residualStandardError, (rss / (n - 2)).squareRoot(), 1e-11))33 #expect(close(fit.slope.standardError, (rss / (n - 2) / sxx).squareRoot(), 1e-11))34 #expect(close(fit.slope.tStatistic, slope / (rss / (n - 2) / sxx).squareRoot(), 1e-10))35 let p = try #require(o.prediction?.value)36 #expect(close(p.fitted, intercept + slope * 7.5, 1e-11))37 #expect(p.predictionLower < p.meanLower && p.meanLower < p.fitted && p.fitted < p.meanUpper && p.meanUpper < p.predictionUpper)38 #expect(o.points.count == 12 && o.residuals.count == 12 && o.line.count == 2)39 #expect(abs(o.residuals.map(\.y).reduce(0, +)) < 1e-9, "OLS residuals sum to zero")40 #expect(o.xName == "Hours" && o.yName == "Score")41 #expect(m.state.calculated && m.error == nil && !m.isRunning)42 }4344 @Test func referenceSimpleRegression() async throws {45 for c in try Reference.cases("regression") where c.string("kind") == "simple" {46 var s = RegressionState()47 s.mode = .simple; s.xColumn = 0; s.yColumn = 1; s.level = c.double("level"); s.x0 = c.double("x0")48 let o = try RegressionEngine.compute(s, dataset: dataset(["x", "y"], [c.doubles("x"), c.doubles("y")]))49 let fit = try #require(o.simple)50 #expect(close(fit.slope.estimate, c.double("slope"), 1e-9) && close(fit.intercept.estimate, c.double("intercept"), 1e-9))51 #expect(close(fit.slope.standardError, c.double("slopeSE"), 1e-8) && close(fit.intercept.standardError, c.double("interceptSE"), 1e-8))52 #expect(close(fit.slope.pValue, c.double("pSlope"), 1e-7) && close(fit.slope.tStatistic, c.double("tSlope"), 1e-8))53 #expect(close(fit.slope.lower, c.double("slopeLower"), 1e-8) && close(fit.intercept.upper, c.double("interceptUpper"), 1e-8))54 #expect(close(fit.correlation, c.double("r"), 1e-9) && close(fit.rSquared, c.double("rSquared"), 1e-9))55 #expect(close(fit.residualStandardError, c.double("sigma"), 1e-9) && close(fit.fStatistic, c.double("f"), 1e-7))56 let p = try #require(o.prediction?.value)57 #expect(close(p.fitted, c.double("fitted"), 1e-9))58 #expect(close(p.meanLower, c.double("meanLower"), 1e-8) && close(p.meanUpper, c.double("meanUpper"), 1e-8))59 #expect(close(p.predictionLower, c.double("predLower"), 1e-8) && close(p.predictionUpper, c.double("predUpper"), 1e-8))60 }61 }6263 @Test func referenceMultipleRegression() async throws {64 var checked = 065 for c in try Reference.cases("regression") where c.string("kind") == "multiple" {66 let predictors = c.matrix("predictors")67 guard predictors.count + 1 <= Dataset.maxColumns else { continue }68 var s = RegressionState()69 s.mode = .multiple; s.response = 0; s.predictors = Array(1...predictors.count); s.intercept = c.bool("intercept"); s.level = c.double("level")70 let names = ["y"] + predictors.indices.map { "x\($0 + 1)" }71 let o = try RegressionEngine.compute(s, dataset: dataset(names, [c.doubles("y")] + predictors))72 let fit = try #require(o.multiple)73 #expect(zip(fit.coefficients.map(\.estimate), c.doubles("coefficients")).allSatisfy { close($0, $1, 1e-7) }, "\(c.string("name"))")74 #expect(zip(fit.coefficients.map(\.standardError), c.doubles("standardErrors")).allSatisfy { close($0, $1, 1e-6) })75 #expect(close(fit.rSquared, c.double("rSquared"), 1e-9) && close(fit.adjustedRSquared, c.double("adjustedRSquared"), 1e-9))76 #expect(close(fit.aic, c.double("aic"), 1e-8) && close(fit.bic, c.double("bic"), 1e-8))77 #expect(close(fit.durbinWatson, c.double("durbinWatson"), 1e-8))78 #expect(zip(fit.varianceInflationFactors, c.doubles("vif")).allSatisfy { close($0, $1, 1e-5) })79 #expect(zip(fit.cooksDistance, c.doubles("cooks")).allSatisfy { close($0, $1, 1e-6) })80 #expect(o.diagnostics.count == c.doubles("y").count)81 let largest = try #require(o.largestCook)82 #expect(fit.cooksDistance[largest] == fit.cooksDistance.max())83 #expect(o.graphExpression == nil || predictors.count == 1)84 checked += 185 }86 #expect(checked >= 4)87 }8889 @Test func referenceCurveFitsAndRSquaredScale() async throws {90 for c in try Reference.cases("regression") where c.string("kind") == "curve" {91 var s = RegressionState()92 s.mode = .curve; s.xColumn = 0; s.yColumn = 193 let model = c.string("model")94 switch model {95 case "quadratic": s.curve = .quadratic96 case "cubic": s.curve = .cubic97 case "exponential": s.curve = .exponential98 case "logarithmic": s.curve = .logarithmic99 case "power": s.curve = .power100 case "linear": s.curve = .polynomial; s.degree = 1101 default: s.curve = .polynomial; s.degree = c.int("degree")102 }103 #expect(s.degree <= 5)104 let o = try RegressionEngine.compute(s, dataset: dataset(["x", "y"], [c.doubles("x"), c.doubles("y")]))105 let fit = try #require(o.curve)106 #expect(zip(fit.coefficients, c.doubles("coefficients")).allSatisfy { close($0, $1, 1e-6) }, "\(model)")107 #expect(close(fit.rSquared, c.double("rSquared"), 1e-8), "\(model)")108 #expect(close(fit.rSquaredOriginalScale, c.double("rSquaredOriginal"), 1e-8), "\(model)")109 #expect((fit.rSquaredScale == .transformed) == (model == "exponential" || model == "power"), "R² scale flagged as the engine reports it")110 // The exported expression evaluates to the fitted curve in the shared engine.111 let expression = try #require(o.graphExpression)112 let compiled = try CompiledExpression(try Parser.parse(expression, options: ParserOptions(variables: ["x"])), variables: ["x"])113 for x in [c.doubles("x")[2], c.doubles("x")[9]] {114 #expect(close(compiled(x), try fit.value(at: x), 1e-10), "\(model): \(expression)")115 }116 #expect(!o.line.isEmpty && o.residuals.count == c.doubles("x").count)117 }118 }119120 @Test func exportedEquationsParseInTheEngine() async throws {121 let app = makeApp()122 let data = DataModel()123 data.load(SampleDatasets.housePrices)124 var s = RegressionState()125 s.mode = .multiple; s.response = 0; s.predictors = [1, 2, 3]126 let o = try RegressionEngine.compute(s, dataset: data.dataset)127 let fit = try #require(o.multiple)128 #expect(fit.coefficients.count == 4 && fit.rSquared > 0.9)129 #expect(o.workspaceLine.hasPrefix("fit(x1, x2, x3) = "))130 // Canonical text ("." decimals), as every Quick Action sends it.131 guard case .success = await app.evaluateCanonical(o.workspaceLine, mode: .workspace, record: false) else { Issue.record("the function definition must parse"); return }132 let value = try await app.evaluateCanonical("fit(150, 15, 7.4)", mode: .workspace, record: false).get().value?.doubleValue133 #expect(close(try #require(value), try fit.value(at: [150, 15, 7.4]), 1e-10))134 // Negative coefficients are parenthesised.135 #expect(RegressionEngine.polynomialExpression([-1.5, 2, -0.25]) == "(-1.5) + 2*x + (-0.25)*x^2")136 // Simple regression: Graph gets an expression in x.137 s = RegressionState(); s.mode = .simple; s.xColumn = 1; s.yColumn = 0138 let simple = try RegressionEngine.compute(s, dataset: data.dataset)139 let g = try #require(simple.graphExpression)140 let compiled = try CompiledExpression(try Parser.parse(g, options: ParserOptions(variables: ["x"])), variables: ["x"])141 #expect(close(compiled(140), try #require(simple.simple).value(at: 140), 1e-10))142 }143144 @Test func rankDeficiencyIsShownPlainly() async throws {145 let x1: [Double] = [1, 2, 3, 4, 5, 6, 7, 8], y: [Double] = [2.1, 3.9, 6.2, 8.1, 9.8, 12.2, 13.9, 16.1]146 let ds = dataset(["y", "a", "b"], [y, x1, x1.map { 2 * $0 }])147 let m = RegressionModel()148 m.state.mode = .multiple; m.state.response = 0; m.state.predictors = [1, 2]149 await m.calculate(dataset: ds, dataRevision: 1)150 #expect(m.output == nil)151 var engineMessage = ""152 do { _ = try LinearRegression.multiple(y: y, predictors: [x1, x1.map { 2 * $0 }], names: ["a", "b"]) } catch { engineMessage = statMessage(error) }153 #expect(!engineMessage.isEmpty && m.error == engineMessage, "the engine's rank-deficiency message, unchanged")154 // Other input problems.155 m.state.predictors = [0]156 await m.calculate(dataset: ds, dataRevision: 1)157 #expect(m.error?.contains("at least one predictor") == true)158 m.state.mode = .curve; m.state.xColumn = 1; m.state.yColumn = 1159 await m.calculate(dataset: ds, dataRevision: 1)160 #expect(m.error?.contains("two different columns") == true)161 m.state.yColumn = 0; m.state.curve = .logarithmic162 await m.calculate(dataset: dataset(["y", "x"], [y, x1.map { $0 - 4 }]), dataRevision: 2)163 #expect(m.error?.isEmpty == false, "ln of a non-positive x is the engine's domain error")164 }165166 @Test func staleAfterAnInputOrDataChangeAndLogged() async throws {167 let app = makeApp()168 let store = StatisticsStore()169 store.data.loadDemo()170 store.regression.state.x0 = 6171 await store.calculateRegression(app)172 #expect(store.regression.output != nil)173 #expect(app.history.first?.mode == .statistics && app.history.first?.input.contains("linear regression") == true)174 #expect(!store.regression.isStale(dataRevision: store.data.revision))175 store.regression.state.mode = .curve176 #expect(store.regression.isStale(dataRevision: store.data.revision))177 await store.calculateRegression(app)178 #expect(!store.regression.isStale(dataRevision: store.data.revision))179 #expect(app.history.first?.display.contains("R²") == true)180 store.data.appendRow(); store.data.setValue(12, row: 12, column: 0); store.data.setValue(95, row: 12, column: 1)181 #expect(store.regression.isStale(dataRevision: store.data.revision))182 // Exponential fit of the growth sample: R² is flagged as that of ln y.183 store.data.load(SampleDatasets.bacteria)184 store.regression.state.curve = .exponential185 await store.calculateRegression(app)186 let fit = try #require(store.regression.output?.curve)187 #expect(fit.rSquaredScale == .transformed)188 #expect(app.history.first?.display.contains("(of ln y)") == true)189 #expect(fit.coefficients[1] > 1.4 && fit.coefficients[1] < 1.5, "growth factor per hour of the sample")190 }191}192