SPB Git

Repository Public MIT

DescriptiveTests.swift 14.1 KB 211 lines swift

1// ORIX Calc2// File: Packages/ORIXStatistics/Tests/ORIXStatisticsTests/DescriptiveTests.swift3// Description: Descriptive statistics against numpy / scipy references (all nine quantile methods), hand examples and error paths.4//5// Author: Simon-Pierre Boucher6// Contact: contact@spboucher.ai7import Foundation8import Testing9@testable import ORIXStatistics1011@Suite struct DescriptiveReferenceTests {12    static func cases() throws -> [[String: Any]] { try Reference.cases("descriptive") }1314    @Test func locationAndSpread() throws {15        for c in try Self.cases() {16            let x = c.doubles("data"), name = c.string("name")17            #expect(Descriptive.count(x) == c.int("n"))18            // Reference mean and variances are exact rational arithmetic correctly rounded.19            #expect(close(try Descriptive.sum(x), c.double("sum"), rtol: 1e-15), "\(name)")20            #expect(close(try Descriptive.mean(x), c.double("mean"), rtol: 2e-16), "\(name) mean")21            #expect(close(try Descriptive.median(x), c.double("median"), rtol: 1e-15), "\(name)")22            #expect(try Descriptive.minimum(x) == c.double("min") && Descriptive.maximum(x) == c.double("max"))23            #expect(close(try Descriptive.range(x), c.double("max") - c.double("min"), rtol: 1e-15))24            #expect(close(try Descriptive.variance(x, sample: false), c.double("populationVariance"), rtol: 1e-13), "\(name) pvar")25            #expect(close(try Descriptive.variance(x), c.double("sampleVariance"), rtol: 1e-13), "\(name) svar")26            #expect(close(try Descriptive.standardDeviation(x, sample: false), c.double("populationSD"), rtol: 1e-13))27            #expect(close(try Descriptive.standardDeviation(x), c.double("sampleSD"), rtol: 1e-13))28            #expect(close(try Descriptive.standardError(x), c.double("standardError"), rtol: 1e-13))29            #expect(try Descriptive.modes(x) == c.doubles("modes"), "\(name) modes")30            #expect(try Descriptive.ranks(x) == c.doubles("ranks"), "\(name) ranks")31            #expect(allClose(try Descriptive.zScores(x), c.doubles("zscores"), rtol: 1e-9, atol: 1e-9), "\(name) z")32            #expect(close(try Descriptive.weightedMean(x, weights: c.doubles("weights")), c.double("weightedMean"), rtol: 1e-14), "\(name)")33            if c.has("geometricMean") {34                #expect(close(try Descriptive.geometricMean(x), c.double("geometricMean"), rtol: 1e-14), "\(name)")35                #expect(close(try Descriptive.harmonicMean(x), c.double("harmonicMean"), rtol: 1e-14), "\(name)")36            }37        }38    }3940    @Test func shape() throws {41        for c in try Self.cases() where c.has("populationSkewness") {42            let x = c.doubles("data"), name = c.string("name")43            #expect(close(try Descriptive.populationSkewness(x), c.double("populationSkewness"), rtol: 1e-11, atol: 1e-14), "\(name)")44            #expect(close(try Descriptive.sampleSkewness(x), c.double("sampleSkewness"), rtol: 1e-11, atol: 1e-14), "\(name)")45            #expect(close(try Descriptive.populationExcessKurtosis(x), c.double("populationExcessKurtosis"), rtol: 1e-11, atol: 1e-13), "\(name)")46            #expect(close(try Descriptive.sampleExcessKurtosis(x), c.double("sampleExcessKurtosis"), rtol: 1e-11, atol: 1e-13), "\(name)")47        }48    }4950    @Test func allNineQuantileMethodsMatchNumpy() throws {51        var compared = 052        for c in try Self.cases() {53            let x = c.doubles("data"), ps = c.doubles("ps"), table = c.dict("quantiles")54            for method in QuantileMethod.allCases {55                let expected = (table[method.rawValue] as? [NSNumber])?.map(\.doubleValue) ?? []56                #expect(expected.count == ps.count)57                let got = try Descriptive.quantiles(x, ps, method: method)58                for i in ps.indices {59                    #expect(close(got[i], expected[i], rtol: 1e-13, atol: 1e-13), "\(c.string("name")) \(method.rawValue) p=\(ps[i]): \(got[i]) vs \(expected[i])")60                    compared += 161                }62            }63            // numpy 'linear' is the default; scipy.stats.iqr uses it too.64            #expect(close(try Descriptive.interquartileRange(x), c.double("iqrLinear"), rtol: 1e-12))65            #expect(close(try Descriptive.percentile(x, 40), try Descriptive.quantile(x, 0.4), rtol: 1e-15))66            let tukey = try Descriptive.quartiles(x, method: .tukeyHinges), ti = try Descriptive.quartiles(x, method: .medianOfHalvesExclusive)67            #expect([tukey.first, tukey.third] == c.doubles("tukeyHinges"), "\(c.string("name")) hinges")68            #expect([ti.first, ti.third] == c.doubles("exclusiveHinges"), "\(c.string("name")) TI quartiles")69        }70        #expect(compared == 8 * 9 * 15)71    }7273    @Test func histogramsMatchNumpy() throws {74        for c in try Self.cases() {75            let x = c.doubles("data")76            for (key, rule) in [("sturges", BinningRule.sturges), ("freedmanDiaconis", .freedmanDiaconis), ("fixed7", .fixedCount(7))] {77                let ref = c.dict("hist_" + key)78                let h = try Descriptive.histogram(x, rule: rule)79                #expect(h.counts == (ref["counts"] as? [NSNumber])?.map(\.intValue), "\(c.string("name")) \(key)")80                #expect(allClose(h.edges, ref.doubles("edges"), rtol: 1e-12, atol: 1e-9), "\(c.string("name")) \(key) edges")81                #expect(h.total == x.count)82                #expect(close(zip(h.densities, h.counts).reduce(0) { $0 + $1.0 } * h.binWidth, 1, rtol: 1e-12))83            }84        }85    }8687    @Test func associationMatchesScipy() throws {88        let pairs = (try Reference.load("descriptive")["pairs"] as? [[String: Any]]) ?? []89        #expect(pairs.count == 4)90        for c in pairs {91            let x = c.doubles("x"), y = c.doubles("y")92            #expect(close(try Descriptive.covariance(x, y), c.double("sampleCovariance"), rtol: 1e-12), "\(c.string("name"))")93            #expect(close(try Descriptive.covariance(x, y, sample: false), c.double("populationCovariance"), rtol: 1e-12))94            #expect(close(try Descriptive.correlation(x, y), c.double("pearson"), rtol: 1e-12), "\(c.string("name"))")95            #expect(close(try Descriptive.spearmanCorrelation(x, y), c.double("spearman"), rtol: 1e-12), "\(c.string("name")) spearman")96        }97    }98}99100@Suite struct DescriptiveBehaviourTests {101    @Test func handExamples() throws {102        let x = [2.0, 4, 4, 4, 5, 5, 7, 9]103        #expect(try Descriptive.mean(x) == 5)104        #expect(try Descriptive.variance(x, sample: false) == 4)105        #expect(try Descriptive.standardDeviation(x, sample: false) == 2)106        #expect(close(try Descriptive.variance(x), 32.0 / 7, rtol: 1e-15))107        #expect(try Descriptive.modes(x) == [4])108        #expect(try Descriptive.median(x) == 4.5)109        // Quartiles of 1…9: Tukey (inclusive) 3 and 7; TI / exclusive 2.5 and 7.5; R-7 3 and 7; R-6 2.5 and 7.5.110        let nine = (1...9).map(Double.init)111        #expect(try Descriptive.quartiles(nine, method: .tukeyHinges) == (3, 7))112        #expect(try Descriptive.quartiles(nine, method: .medianOfHalvesExclusive) == (2.5, 7.5))113        #expect(try Descriptive.quartiles(nine) == (3, 7))114        #expect(try Descriptive.quartiles(nine, method: .quantile(.weibull)) == (2.5, 7.5))115        let five = try Descriptive.fiveNumberSummary(nine)116        #expect(five == FiveNumberSummary(minimum: 1, firstQuartile: 3, median: 5, thirdQuartile: 7, maximum: 9))117        #expect(five.interquartileRange == 4 && five.innerFences == -3.0...13.0)118        // Excel PERCENTILE.EXC / R-6 clamps at the ends instead of failing.119        #expect(try Descriptive.quantile(nine, 0.01, method: .weibull) == 1)120        #expect(try Descriptive.quantile(nine, 0.999, method: .weibull) == 9)121    }122123    @Test func modesConvention() throws {124        #expect(try Descriptive.modes([1, 2, 3, 4]) == [])                 // all unique: no mode125        #expect(try Descriptive.modes([3, 1, 3, 2, 1]) == [1, 3])          // bimodal, ascending126        #expect(try Descriptive.modes([7]) == [7])127        #expect(try Descriptive.modes([2, 2, 5, 5]) == [2, 5])             // every value tied above 1: all are modes128    }129130    @Test func compensatedSummationSurvivesCancellation() throws {131        #expect(try Descriptive.sum([1e100, 1, -1e100]) == 1)               // naive summation gives 0132        #expect(try Descriptive.sum([]) == 0)133        let big = [Double](repeating: 0.1, count: 1_000_000)134        #expect(close(try Descriptive.sum(big), 100_000, rtol: 1e-15))135        #expect(try Descriptive.mean([Double.greatestFiniteMagnitude, Double.greatestFiniteMagnitude]) == Double.greatestFiniteMagnitude)136        // Variance of data with a huge offset keeps its digits (naive Σx² − n·x̄² would return garbage).137        let shifted = [1e9 + 4, 1e9 + 7, 1e9 + 13, 1e9 + 16]138        #expect(try Descriptive.variance(shifted) == 30)139    }140141    @Test func frequencyTableAndExpansion() throws {142        let t = try Descriptive.frequencyTable([3, 1, 3, 2, 3, 1])143        #expect(t.map(\.value) == [1, 2, 3] && t.map(\.count) == [2, 1, 3] && t.map(\.cumulativeCount) == [2, 3, 6])144        #expect(close(t[2].relativeFrequency, 0.5, rtol: 1e-15) && t[2].cumulativeRelativeFrequency == 1)145        #expect(try Descriptive.expand(values: [5, 7], frequencies: [2, 3]) == [5, 5, 7, 7, 7])146        #expect(throws: StatisticsError.self) { try Descriptive.expand(values: [5], frequencies: [-1]) }147        #expect(throws: StatisticsError.self) { try Descriptive.expand(values: [5, 6], frequencies: [1]) }148    }149150    @Test func histogramEdgeCases() throws {151        let constant = try Descriptive.histogram([4, 4, 4])152        #expect(constant.counts.reduce(0, +) == 3 && constant.edges.first == 3.5 && constant.edges.last == 4.5)153        let h = try Descriptive.histogram([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], rule: .fixedWidth(2.5))154        #expect(h.edges == [0, 2.5, 5, 7.5, 10, 12.5] && h.counts == [3, 2, 3, 2, 1])155        let ranged = try Descriptive.histogram([-5, 0.5, 1.5, 99], rule: .fixedCount(2), range: 0...2)156        #expect(ranged.counts == [1, 1])                                    // values outside the range are ignored157        #expect(h.midpoints[0] == 1.25 && h.relativeFrequencies.reduce(0, +) == 1)158        #expect(throws: StatisticsError.self) { try Descriptive.histogram([1, 2], rule: .fixedCount(0)) }159        #expect(throws: StatisticsError.self) { try Descriptive.histogram([1, 2], rule: .fixedWidth(0)) }160        #expect(throws: StatisticsError.self) { try Descriptive.histogram([1, 2], rule: .fixedWidth(1, origin: 5)) }161    }162163    @Test func summary() throws {164        let s = try Descriptive.summary([2, 4, 4, 4, 5, 5, 7, 9])165        #expect(s.count == 8 && s.sum == 40 && s.sumOfSquares == 232 && s.mean == 5 && s.range == 7 && s.modes == [4])166        #expect(s.populationStandardDeviation == 2 && close(s.sampleStandardDeviation!, (32.0 / 7).squareRoot(), rtol: 1e-15))167        #expect(s.sampleSkewness != nil && s.sampleExcessKurtosis != nil)168        let one = try Descriptive.summary([3])169        #expect(one.sampleVariance == nil && one.standardError == nil && one.populationSkewness == nil && one.populationVariance == 0)170        let flat = try Descriptive.summary([2, 2, 2, 2])171        #expect(flat.populationSkewness == nil && flat.sampleExcessKurtosis == nil)      // undefined → nil, never NaN172    }173174    @Test func errorPaths() {175        #expect(throws: StatisticsError.emptyData) { try Descriptive.mean([]) }176        #expect(throws: StatisticsError.emptyData) { try Descriptive.median([]) }177        #expect(throws: StatisticsError.emptyData) { try Descriptive.quantile([], 0.5) }178        #expect(throws: StatisticsError.emptyData) { try Descriptive.summary([]) }179        #expect(throws: StatisticsError.insufficientSample(required: 2, actual: 1)) { try Descriptive.variance([1]) }180        #expect(throws: StatisticsError.insufficientSample(required: 2, actual: 1)) { try Descriptive.standardError([1]) }181        #expect(throws: StatisticsError.insufficientSample(required: 3, actual: 2)) { try Descriptive.sampleSkewness([1, 2]) }182        #expect(throws: StatisticsError.insufficientSample(required: 4, actual: 3)) { try Descriptive.sampleExcessKurtosis([1, 2, 3]) }183        #expect(throws: StatisticsError.self) { try Descriptive.mean([1, .nan]) }184        #expect(throws: StatisticsError.self) { try Descriptive.sum([1, .infinity]) }185        #expect(throws: StatisticsError.probabilityOutOfRange(1.5)) { try Descriptive.quantile([1, 2], 1.5) }186        #expect(throws: StatisticsError.self) { try Descriptive.percentile([1, 2], 101) }187        #expect(throws: StatisticsError.self) { try Descriptive.populationSkewness([5, 5, 5]) }188        #expect(throws: StatisticsError.self) { try Descriptive.zScores([5, 5, 5]) }189        #expect(throws: StatisticsError.self) { try Descriptive.correlation([1, 2, 3], [4, 4, 4]) }190        #expect(throws: StatisticsError.self) { try Descriptive.correlation([1, 2, 3], [4, 5]) }191        #expect(throws: StatisticsError.self) { try Descriptive.covariance([1], [2]) }192        #expect(throws: StatisticsError.self) { try Descriptive.geometricMean([1, 0, 2]) }193        #expect(throws: StatisticsError.self) { try Descriptive.harmonicMean([1, -2]) }194        #expect(throws: StatisticsError.self) { try Descriptive.weightedMean([1, 2], weights: [0, 0]) }195        #expect(throws: StatisticsError.self) { try Descriptive.weightedMean([1, 2], weights: [1, -1]) }196        #expect(throws: StatisticsError.self) { try Descriptive.weightedMean([1, 2], weights: [1]) }197        #expect(throws: StatisticsError.self) { try Descriptive.coefficientOfVariation([-1, 1]) }198        #expect(throws: StatisticsError.self) { try Descriptive.centralMoment([1, 2], order: -1) }199    }200201    @Test func smallExtras() throws {202        #expect(try Descriptive.variance([7], sample: false) == 0)203        #expect(try Descriptive.quantile([7], 0.3) == 7)204        #expect(close(try Descriptive.coefficientOfVariation([2, 4, 4, 4, 5, 5, 7, 9]), (32.0 / 7).squareRoot() / 5, rtol: 1e-15))205        #expect(try Descriptive.centralMoment([1, 2, 3], order: 2) == 2.0 / 3)206        #expect(try Descriptive.ranks([10, 20, 10, 30]) == [1.5, 3, 1.5, 4])207        #expect(try Descriptive.spearmanCorrelation([1, 2, 3, 4], [1, 8, 27, 64]) == 1)208        #expect(try Descriptive.correlation([1, 2, 3], [2, 4, 6]) == 1)209    }210}211
Files main
Menu

Theme