Repository Public
1import Foundation2import Statistics34/// One-dimensional solver shared by Goal Seek and the break-even finder.5enum WhatIfSolver {6 struct Outcome {7 var root: Double?8 var residual: Double9 var converged: Bool10 var iterations: Int11 var evaluations: Int12 var method: String13 var bracket: ClosedRange<Double>?14 var message: String15 }1617 /// Solves g(x) = 0 starting from `start`: (1) accept the start if it already satisfies the18 /// tolerance; (2) expand an interval around the start until g changes sign and run Brent's method19 /// on it; (3) otherwise, or when Brent stops on a discontinuity, fall back to the secant method.20 /// `tolerance` is the largest acceptable |g|. Non-numeric evaluations are passed as NaN.21 static func solve(start: Double, tolerance: Double, maxIterations: Int, lower: Double?, upper: Double?, step: Double?,22 _ g: (Double) throws -> Double) throws -> Outcome {23 var evals = 024 var best: (x: Double, g: Double)?25 func eval(_ x: Double) throws -> Double {26 evals += 127 let v = try g(x)28 if v.isFinite, best == nil || abs(v) < abs(best!.g) { best = (x, v) }29 return v30 }31 let lo = lower ?? -.infinity, hi = upper ?? .infinity32 let x0 = Swift.min(Swift.max(start, lo), hi)33 let g0 = try eval(x0)34 if g0.isFinite, abs(g0) <= tolerance {35 return Outcome(root: x0, residual: g0, converged: true, iterations: 0, evaluations: evals, method: "initial value", bracket: nil,36 message: "The starting value already meets the target.")37 }38 var iterations = 039 var bracketFound: ClosedRange<Double>?40 var note = "No sign change was found around the starting value."41 if let b = try RootFinder.bracket(eval, guess: x0, step: step, min: lo, max: hi) {42 bracketFound = b.lower...b.upper43 do {44 let r = try RootFinder.brent(eval, lower: b.lower, upper: b.upper, xtol: 1e-14, maxIterations: maxIterations)45 iterations += r.iterations46 if r.residual.isFinite, abs(r.residual) <= tolerance {47 return Outcome(root: r.root, residual: r.residual, converged: true, iterations: iterations, evaluations: evals, method: "brent",48 bracket: bracketFound, message: "Converged (Brent's method on a bracketing interval).")49 }50 note = r.converged ? "The output jumps across the target near \(r.root) without reaching it (discontinuity)."51 : "Brent's method did not converge within \(maxIterations) iterations."52 } catch {53 if let e = error as? StatError { note = "Bracketing search failed: \(e.description)." } else { throw error }54 }55 }56 // secant fallback57 let h = step ?? Swift.max(abs(x0) * 0.01, 1e-4)58 var x1 = x0 + h59 if x1 > hi || x1 < lo { x1 = x0 - h }60 let s = try RootFinder.secant(eval, x0: x0, x1: x1, xtol: 1e-14, ftol: tolerance, maxIterations: maxIterations)61 iterations += s.iterations62 if s.residual.isFinite, abs(s.residual) <= tolerance, s.root >= lo, s.root <= hi {63 return Outcome(root: s.root, residual: s.residual, converged: true, iterations: iterations, evaluations: evals, method: "secant",64 bracket: bracketFound, message: "Converged (secant method).")65 }66 return Outcome(root: best?.x, residual: best?.g ?? .nan, converged: false, iterations: iterations, evaluations: evals,67 method: bracketFound != nil ? "brent" : "secant", bracket: bracketFound,68 message: note + " No solution found; the closest value tried is reported.")69 }70}71