File: WallClockTimeMetric.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (79 lines) | stat: -rw-r--r-- 3,277 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2016 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//
//  WallClockTimeMetric.swift
//  Performance metric measuring how long it takes code to execute
//

/// This metric uses the system uptime to keep track of how much time passes
/// between starting and stopping measuring.
internal final class WallClockTimeMetric: PerformanceMetric {
    static let name = "org.swift.XCTPerformanceMetric_WallClockTime"

    typealias Measurement = TimeInterval
    private var startTime: TimeInterval?
    var measurements: [Measurement] = []

    func startMeasuring() {
        startTime = currentTime()
    }

    func stopMeasuring() {
        guard let startTime = startTime else { fatalError("Must start measuring before stopping measuring") }
        let stopTime = currentTime()
        measurements.append(stopTime-startTime)
    }

    private let maxRelativeStandardDeviation = 10.0
    private let standardDeviationNegligibilityThreshold = 0.1

    func calculateResults() -> String {
        let results = [
                          String(format: "average: %.3f", measurements.average),
                          String(format: "relative standard deviation: %.3f%%", measurements.relativeStandardDeviation),
                          "values: [\(measurements.map({ String(format: "%.6f", $0) }).joined(separator: ", "))]",
                          "performanceMetricID:\(type(of: self).name)",
                          String(format: "maxPercentRelativeStandardDeviation: %.3f%%", maxRelativeStandardDeviation),
                          String(format: "maxStandardDeviation: %.3f", standardDeviationNegligibilityThreshold),
                          ]
        return "[Time, seconds] \(results.joined(separator: ", "))"
    }

    func failureMessage() -> String? {
        let relativeStandardDeviation = measurements.relativeStandardDeviation
        if (relativeStandardDeviation > maxRelativeStandardDeviation &&
            measurements.standardDeviation > standardDeviationNegligibilityThreshold) {
            return String(format: "The relative standard deviation of the measurements is %.3f%% which is higher than the max allowed of %.3f%%.", relativeStandardDeviation, maxRelativeStandardDeviation)
        }

        return nil
    }

    private func currentTime() -> TimeInterval {
        return ProcessInfo.processInfo.systemUptime
    }
}


private extension Collection where Index: ExpressibleByIntegerLiteral, Iterator.Element == WallClockTimeMetric.Measurement {
    var average: WallClockTimeMetric.Measurement {
        return self.reduce(0, +) / Double(Int(count))
    }

    var standardDeviation: WallClockTimeMetric.Measurement {
        let average = self.average
        let squaredDifferences = self.map({ pow($0 - average, 2.0) })
        let variance = squaredDifferences.reduce(0, +) / Double(Int(count-1))
        return sqrt(variance)
    }

    var relativeStandardDeviation: Double {
        return (standardDeviation*100) / average
    }
}