summaryrefslogtreecommitdiffstats
path: root/statistics/src/main/java/com/yahoo/statistics/SampleSet.java
blob: 572d87aea5ef5cd41082907dbd5ef36b6c9aec9a (plain) (blame)
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
// Copyright 2016 Yahoo Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.statistics;

/**
 * A running set of samples for a Value instance. It is
 * used only in a very specific context between the sampling threads (each instance
 * is only used by on sampling thread) and the single logging thread.
 *
 * @author <a href="mailto:steinar@yahoo-inc.com">Steinar Knutsen</a>
 */
final class SampleSet {
    Sampling values;
    final Limits histogramLimits;
    private boolean isRegisteredForLogging = false;

    SampleSet(Limits histogramLimits) {
        this.histogramLimits = histogramLimits;
        values = new Sampling(0.0d, 0L, 0.0d, 0.0d, histogramLimits);
    }

    static final class Sampling {
        final double sum;
        final long insertions;
        final double max;
        final double min;
        final Histogram histogram;

        Sampling(double sum, long insertions, double max, double min, Limits histogramLimits) {
            if (histogramLimits != null) {
                this.histogram = new Histogram(histogramLimits);
            } else {
                this.histogram = null;
            }
            this.sum = sum;
            this.insertions = insertions;
            this.max = max;
            this.min = min;
        }

        Sampling(double sum, long insertions, double max, double min, Histogram histogram) {
            this.histogram = histogram;
            this.sum = sum;
            this.insertions = insertions;
            this.max = max;
            this.min = min;
        }
    }


    private Sampling createSampling(double x, Sampling previous) {
        double sum = previous.sum;
        long insertions = previous.insertions;
        double max = previous.max;
        double min = previous.min;

        sum += x;
        if (insertions == 0) {
            max = x;
            min = x;
        } else {
            max = Math.max(x, max);
            min = Math.min(x, min);
        }
        insertions++;
        return new Sampling(sum, insertions, max, min, previous.histogram);
    }

    /**
     * Insert x, do all pertinent operations. (Update histogram, update
     * insertion count for calculating mean, etc.)
     *
     * @return whether this is registered for logging
     */
    synchronized boolean put(double x) {
        Sampling previous = values;
        Histogram histogram = previous.histogram;
        if (histogram != null) {
            histogram.put(new double[] {x});
        }
        values = createSampling(x, previous);
        return isRegisteredForLogging;
    }

    /**
     * Get state and reset it.
     */
    synchronized Sampling getAndReset() {
        Sampling previous = values;
        values = new Sampling(0.0d, 0L, 0.0d, 0.0d, histogramLimits);
        setRegisteredForLogging(false);
        return previous;
    }

    // Setting this state is protected by SampleDirectory.directoryLock. It is
    // either set from the logging thread (protected by directoryLock and using
    // "this" as a memory barrier through getAndReset()), or from the sampling
    // thread protected by directoryLock and without a mem barrier.
    void setRegisteredForLogging(boolean isRegisteredForLogging) {
        this.isRegisteredForLogging = isRegisteredForLogging;
    }

}