Repository Public MIT
1// ORIX Calc2// File: Packages/ORIXFeatureMath/Tests/ORIXFeatureMathTests/MathNotationTests.swift3// Description: Tests of the math renderer — layout tree structure, spoken descriptions, measured geometry, and off-screen renders of formulas and of the whole screen.4//5// Author: Simon-Pierre Boucher6// Contact: contact@spboucher.ai7import Foundation8import SwiftUI9import Testing10import ORIXExpression11import ORIXSymbolic12import ORIXUI13@testable import ORIXFeatureMath1415private func P(_ s: String) -> Expr { try! Parser.parse(s, options: ParserOptions(splitUnknownIdentifiers: true)) }1617@Suite struct LayoutTreeTests {18 @Test func fractionHasNumeratorAndDenominatorBoxes() {19 guard case .fraction(let n, let d) = MathBox(expr: P("(x^2+1)/(2x)")) else { Issue.record("not a fraction"); return }20 #expect(n == .row([.power(base: .text("x", .variable), exponent: .number("2")), .op("+"), .number("1")]))21 #expect(d == .row([.number("2"), .text("x", .variable)]))22 }2324 @Test func powerHasBaseAndExponent() {25 #expect(MathBox(expr: P("x^(n+1)")) == .power(base: .text("x", .variable), exponent: .row([.text("n", .variable), .op("+"), .number("1")])))26 // A sum or a fraction as base is fenced; an exponent never needs parentheses.27 guard case .power(let base, _) = MathBox(expr: P("(x+1)^2")) else { Issue.record("not a power"); return }28 #expect(base == .paren(.row([.text("x", .variable), .op("+"), .number("1")])))29 guard case .power(let fractionBase, _) = MathBox(expr: P("(a/b)^2")) else { Issue.record("not a power"); return }30 if case .fenced(.paren, .fraction) = fractionBase {} else { Issue.record("fraction base must be fenced") }31 #expect(MathBox(expr: P("exp(2x)")) == .power(base: .text("e", .variable), exponent: .row([.number("2"), .text("x", .variable)])))32 }3334 @Test func radicalsBarsFunctionsAndNames() {35 #expect(MathBox(expr: P("sqrt(x)")) == .radical(index: nil, radicand: .text("x", .variable)))36 #expect(MathBox(expr: P("root(x, 5)")) == .radical(index: .number("5"), radicand: .text("x", .variable)))37 #expect(MathBox(expr: P("abs(x)")) == .fenced(.bar, .text("x", .variable)))38 #expect(MathBox(expr: P("sin(x)")) == .row([.function("sin"), .paren(.row([.text("x", .variable)]))]))39 #expect(MathBox(expr: .variable("alpha")) == .text("α", .variable))40 #expect(MathBox(expr: .variable("x1")) == .sub(base: .text("x", .variable), index: .number("1")))41 #expect(MathBox(expr: .variable("rate")) == .text("rate", .function), "multi-letter names are upright")42 #expect(MathBox(expr: .rational(-3, 4)) == .row([.symbol("−"), .fraction(numerator: .number("3"), denominator: .number("4"))]))43 }4445 @Test func productsFollowThePrinterRules() {46 #expect(MathBox(expr: P("-3x + 1")) == .row([.row([.row([.symbol("−"), .number("3")]), .text("x", .variable)]), .op("+"), .number("1")]))47 #expect(MathBox(expr: P("2x")) == .row([.number("2"), .text("x", .variable)]))48 #expect(MathBox(expr: P("x*y")) == .row([.text("x", .variable), .op("·"), .text("y", .variable)]))49 #expect(MathBox(expr: P("2*3")) == .row([.number("2"), .op("·"), .number("3")]))50 }5152 @Test func matricesAndVectors() {53 guard case .matrix(let rows) = MathBox(expr: .matrix([[.int(1), .rational(1, 2)], [.variable("x"), .int(4)]])) else { Issue.record("not a matrix"); return }54 #expect(rows.count == 2 && rows[0].count == 2)55 #expect(rows[0][1] == .fraction(numerator: .number("1"), denominator: .number("2")))56 if case .fenced(.bracket, _) = MathBox(expr: .vector([.int(1), .int(2)])) {} else { Issue.record("vector must be bracketed") }57 }5859 @Test func spokenDescriptions() {60 #expect(MathBox(expr: P("(x^2+1)/(2x)")).spokenDescription == "x squared plus 1, over 2 x")61 #expect(MathBox(expr: P("x/2")).spokenDescription == "x over 2")62 #expect(MathBox(expr: P("sqrt(x+1)")).spokenDescription == "the square root of x plus 1")63 #expect(MathBox(expr: P("sin(x)^2")).spokenDescription == "sine of x squared")64 #expect(MathBox(expr: P("abs(x-3)")).spokenDescription == "the absolute value of x minus 3")65 #expect(MathBox(expr: P("x^3 - 2pi")).spokenDescription == "x cubed minus 2 pi")66 #expect(MathBox(expr: P("(x+1)^n")).spokenDescription == "the quantity x plus 1, to the power n")67 #expect(MathBox(expr: P("x^2 = 4")).spokenDescription == "x squared equals 4")68 var limit = LimitProblem.demo; limit.direction = "right"69 #expect(limit.preview(MathEnv()).box?.spokenDescription == "the limit as x approaches 0 from the right of sine of x, over x")70 var integral = IntegralProblem.demo; integral.definite = true71 #expect(integral.preview(MathEnv()).box?.spokenDescription == "the integral from 0 to 1 of x times e to the power x d x")72 #expect(DerivativeProblem.demo.preview(MathEnv()).box?.spokenDescription == "the derivative with respect to x of the quantity x squared times sine of x")73 #expect(MathBox(value: .matrix(Matrix([[Value(1), Value(2)], [Value(3), Value(4)]]))).spokenDescription == "a 2 by 2 matrix, row 1: 1, 2; row 2: 3, 4")74 }7576 @Test func previewsReportParseErrorsInline() {77 var p = IntegralProblem(); p.integrand = "x^"; p.definite = true; p.upper = ""78 let preview = p.preview(MathEnv())79 #expect(preview.box == nil)80 #expect(preview.errors.count == 2 && preview.errors[0].hasPrefix("Integrand:") && preview.errors[1] == "Upper bound: empty")81 }8283 @Test func measuredGeometryIsPlausible() {84 let t = MathTypesetter(size: 20)85 let fraction = t.tree(MathBox(expr: P("(x^2+1)/(2x)")))86 let numerator = fraction.parts["numerator"]!, denominator = fraction.parts["denominator"]!87 #expect(fraction.height > numerator.height + denominator.height, "bar and gaps add height")88 #expect(fraction.width >= max(numerator.width, denominator.width))89 #expect(fraction.ascent > 0 && fraction.descent > 0, "the fraction straddles the baseline")90 let power = t.tree(MathBox(expr: P("x^2")))91 let base = power.parts["base"]!, exponent = power.parts["exponent"]!92 #expect(exponent.height < base.height * 1.05 && exponent.width < base.width * 1.2, "the exponent is set smaller")93 #expect(power.ascent > base.ascent, "the exponent is raised")94 let nested = t.tree(MathBox(expr: P("x^(y^2)")))95 #expect(nested.ascent >= power.ascent)96 let radical = t.tree(MathBox(expr: P("sqrt(x^2+1)")))97 #expect(radical.width > radical.parts["radicand"]!.width && radical.ascent > radical.parts["radicand"]!.ascent)98 let matrix = t.tree(MathBox(expr: .matrix([[.int(1), .int(2)], [.int(3), .int(4)]])))99 #expect(matrix.height > t.tree(.number("1")).height * 2)100 #expect(matrix.parts["cell.1.1"] != nil)101 // Fences grow with their content.102 let tall = t.tree(.paren(MathBox(expr: P("a/b")))), short = t.tree(.paren(.text("a", .variable)))103 #expect(tall.height > short.height * 1.5)104 // The layout scales linearly with the type size.105 let big = MathTypesetter(size: 40).layout(MathBox(expr: P("(x^2+1)/(2x)")))106 let small = MathTypesetter(size: 20).layout(MathBox(expr: P("(x^2+1)/(2x)")))107 #expect(abs(big.height / small.height - 2) < 0.15)108 #expect(MathView.scaledSize(21, .accessibility3) > MathView.scaledSize(21, .large) * 2)109 }110111 @Test func hugeExpressionsFallBackToText() {112 var e = Expr.variable("x")113 for k in 0..<1500 { e = .binary(.add, e, .int(k)) }114 let box = MathBox(expr: e) // must not overflow the stack115 #expect(box.nodeCount > 0)116 var wide: [MathBox] = []117 for _ in 0..<3000 { wide.append(.number("1")) }118 #expect(MathBox.row(wide).nodeCount > MathBox.typesetNodeLimit)119 }120}121122#if canImport(UIKit)123import UIKit124125@MainActor @Suite struct RenderTests {126 static let directory: URL = {127 let d = FileManager.default.temporaryDirectory.appendingPathComponent("orix-math-shots", isDirectory: true)128 try? FileManager.default.createDirectory(at: d, withIntermediateDirectories: true)129 return d130 }()131132 /// Renders a formula off-screen and returns the image with the number of inked pixels.133 private func render(_ box: MathBox, name: String, size: CGFloat = 28) throws -> (image: UIImage, layout: MathLayout, ink: Int) {134 let layout = MathTypesetter(size: size).layout(box)135 let renderer = ImageRenderer(content: MathCanvas(layout: layout, color: .black).padding(8).background(Color.white))136 renderer.scale = 2137 let image = try #require(renderer.uiImage)138 try #require(image.pngData()).write(to: RenderTests.directory.appendingPathComponent("formula-\(name).png"))139 let cg = try #require(image.cgImage)140 let width = cg.width, height = cg.height141 var pixels = [UInt8](repeating: 0, count: width * height * 4)142 let context = try #require(CGContext(data: &pixels, width: width, height: height, bitsPerComponent: 8, bytesPerRow: width * 4,143 space: CGColorSpaceCreateDeviceRGB(), bitmapInfo: CGImageAlphaInfo.premultipliedLast.rawValue))144 context.draw(cg, in: CGRect(x: 0, y: 0, width: width, height: height))145 var ink = 0146 for i in stride(from: 0, to: pixels.count, by: 4) where pixels[i] < 128 { ink += 1 }147 return (image, layout, ink)148 }149150 @Test func rendersFormulas() throws {151 let numerator = try render(MathBox(expr: P("x^2+1")), name: "numerator")152 let fraction = try render(MathBox(expr: P("(x^2+1)/(2x)")), name: "fraction")153 #expect(fraction.ink > 200 && numerator.ink > 100)154 #expect(fraction.image.size.height > numerator.image.size.height * 1.5, "a fraction is taller than its numerator")155 let power = try render(MathBox(expr: P("e^(x^(2/3)) + (a+b)^(n+1)")), name: "nested-power")156 #expect(power.ink > 200 && power.image.size.width > power.image.size.height)157 let radical = try render(MathBox(expr: P("sqrt((x^2+1)/(y-3)) + root(x, 5) + cbrt(2)")), name: "radical")158 #expect(radical.ink > 300)159 let matrix = try render(MathBox(expr: .matrix([[.rational(1, 2), .int(1), .variable("x")], [.int(-2), P("x^2"), .int(0)], [.int(3), .int(4), P("sqrt(2)")]])), name: "matrix")160 #expect(matrix.ink > 300 && matrix.image.size.height > numerator.image.size.height * 2.5)161 // Composite constructs used as problem previews.162 var integral = IntegralProblem(); integral.integrand = "e^(-x^2)"; integral.definite = true; integral.upper = "inf"163 _ = try render(try #require(integral.preview(MathEnv()).box), name: "integral")164 var limit = LimitProblem(); limit.expression = "abs(x)/x"; limit.direction = "left"165 _ = try render(try #require(limit.preview(MathEnv()).box), name: "limit")166 var sum = SeriesProblem.demo; sum.mode = "sum"167 _ = try render(try #require(sum.preview(MathEnv()).box), name: "sum")168 var derivative = DerivativeProblem(); derivative.expression = "x^2*y^3"; derivative.order = 2169 _ = try render(try #require(derivative.preview(MathEnv()).box), name: "derivative")170 _ = try render(.row([.struck(MathBox(expr: P("x = 0"))), .symbol(" "), MathBox(expr: P("abs((a+b)/c) * ((1/x)+y)^2"))]), name: "struck-fences")171 _ = try render(try #require(SystemProblem.demo.preview(MathEnv()).box), name: "system")172 print("ORIX Math formula renders: \(RenderTests.directory.path)")173 }174175 /// An off-screen window. The test process has no window scene, so the window is created through the UIView initialiser.176 static func window(_ size: CGSize) -> UIWindow {177 (UIWindow.self as UIView.Type).init(frame: CGRect(origin: .zero, size: size)) as! UIWindow178 }179180 struct Shot {181 var name: String182 var size: CGSize183 var tool: MathTool184 var dark = false185 var textSize: DynamicTypeSize = .large186 var degrees = false187 var keypad = false188 }189190 static let shots: [Shot] = [191 Shot(name: "phone-solve", size: CGSize(width: 393, height: 852), tool: .solve),192 Shot(name: "phone-solve-result", size: CGSize(width: 393, height: 1900), tool: .solve),193 Shot(name: "phone-integral-dark", size: CGSize(width: 393, height: 1700), tool: .integral, dark: true),194 Shot(name: "phone-derivative-keypad", size: CGSize(width: 393, height: 852), tool: .derivative, keypad: true),195 Shot(name: "phone-derivative-degrees", size: CGSize(width: 393, height: 1300), tool: .derivative, degrees: true),196 Shot(name: "phone-series-ax3", size: CGSize(width: 393, height: 2600), tool: .series, textSize: .accessibility3),197 Shot(name: "phone-matrix", size: CGSize(width: 393, height: 1500), tool: .matrix),198 Shot(name: "phone-ode", size: CGSize(width: 393, height: 2600), tool: .ode),199 Shot(name: "phone-landscape-limit", size: CGSize(width: 852, height: 393), tool: .limit, keypad: true),200 Shot(name: "pad-landscape-optimize", size: CGSize(width: 1366, height: 1024), tool: .optimize),201 Shot(name: "pad-landscape-system-dark", size: CGSize(width: 1366, height: 1024), tool: .system, dark: true),202 Shot(name: "pad-portrait-simplify", size: CGSize(width: 834, height: 1194), tool: .simplify),203 Shot(name: "pad-landscape-ode", size: CGSize(width: 1366, height: 1024), tool: .ode),204 ]205206 @Test func rendersTheScreen() throws {207 for shot in RenderTests.shots {208 let app = AppModel(settings: AppSettings(defaults: UserDefaults(suiteName: "orix.math.render.\(UUID().uuidString)")!), inMemory: true)209 app.settings.data.angleMode = shot.degrees ? .degrees : .radians210 app.applySettings()211 let store = MathStore()212 store.loadDemo { store.env(app, for: $0) }213 store.tool = shot.tool214 if shot.keypad {215 let model = store.derivative216 if shot.tool == .derivative { store.keyboard.activate("derivative.expression", Binding(get: { model.problem.expression }, set: { model.problem.expression = $0 })) }217 else { store.keyboard.activate("limit.expression", Binding(get: { store.limit.problem.expression }, set: { store.limit.problem.expression = $0 })) }218 }219 let compactHeight = shot.size.height < 500220 let root = NavigationStack { MathRoot(store: store).navigationTitle(shot.tool.longTitle).navigationBarTitleDisplayMode(.inline) }221 .tint(MathTheme.tint)222 .environment(app)223 .environment(\.horizontalSizeClass, shot.size.width >= 700 && !compactHeight ? .regular : .compact)224 .environment(\.verticalSizeClass, compactHeight ? .compact : .regular)225 .environment(\.dynamicTypeSize, shot.textSize)226 .preferredColorScheme(shot.dark ? .dark : .light)227 let controller = UIHostingController(rootView: root)228 controller.overrideUserInterfaceStyle = shot.dark ? .dark : .light229 let window = RenderTests.window(shot.size)230 window.rootViewController = controller231 window.isHidden = false232 window.layoutIfNeeded()233 RunLoop.main.run(until: Date().addingTimeInterval(0.5))234 let image = UIGraphicsImageRenderer(size: shot.size).image { context in window.layer.render(in: context.cgContext) }235 let data = try #require(image.pngData())236 #expect(data.count > 5000)237 try data.write(to: RenderTests.directory.appendingPathComponent("screen-\(shot.name).png"))238 window.isHidden = true239 }240 print("ORIX Math screen renders: \(RenderTests.directory.path)")241 }242243 @Test func publicScreenBootstrapsInDemoMode() throws {244 let app = AppModel(settings: AppSettings(defaults: UserDefaults(suiteName: "orix.math.render.\(UUID().uuidString)")!), inMemory: true)245 let controller = UIHostingController(rootView: MathScreen(section: "limit", demo: true).environment(app))246 let window = RenderTests.window(CGSize(width: 393, height: 852))247 window.rootViewController = controller248 window.isHidden = false249 window.layoutIfNeeded()250 RunLoop.main.run(until: Date().addingTimeInterval(0.6))251 let image = UIGraphicsImageRenderer(size: window.bounds.size).image { context in window.layer.render(in: context.cgContext) }252 try #require(image.pngData()).write(to: RenderTests.directory.appendingPathComponent("screen-public-demo-limit.png"))253 #expect(app.loadState(MathSnapshot.self, key: MathStore.stateKey) == nil, "demo mode never writes the saved state")254 window.isHidden = true255 }256}257#endif258