Counter Class

public static class Counter

// An example class that computes some complicated function.
// 
// The value of the functions may be interesting, and could be logged:
//    A histogram of actual values computed.
// 
// But also statistics about the calling of the function itself:
//    A simple count of how many times it's been called.
//    The rate at which it was called.
//    The percentage of real time spent computing the function.
//    A histogram of actual computation times.
public class CounterExample {
    // Logging the actual confidence values computed might be useful to the user in order for
    // them to observe confidence trends over time, or to look at the frequency of certain
    // confidence values.
    readonly Counter.Number confidence
        = new("ConfidenceLevel",               // Name that appears in the GUI menus and charts.
            minValue: 0, maxValue: 100,        // Expected min/max helps charts scale graphics.
            description: "Confidence level");  // A useful description of the value logged.

    // If this function is called often then it may be useful to log the number of times the
    // function was called, and the rate at which it was called.
    readonly Counter.Operations computations
        = new("ConfidenceComputations",
            description: "Confidences computed");

    // If the function is slow, and especially if its computational speed is variable, then
    // it may be useful to log how long it took to compute.
    readonly Counter.PercentageTime timing
        = new("ConfidenceTiming",
            description: "Percentage time spent computing confidences.");

    // An example function that computes a value.
    public double ComputeConfidence() {
        var sw    = Stopwatch.StartNew();
        var value = new Random().Next() * 100; // Some slow function

        timing.IncrementBy(sw.Elapsed.Ticks);  // Logs the execution time of a computation.
        computations.Increment();              // Logs that a value was computed.
        confidence.Log((int)value);            // Logs the actual numeric confidence value.

        return value;
    }
}