1/*
2 * librdkafka - Apache Kafka C library
3 *
4 * Copyright (c) 2018, Magnus Edenhill
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 *
10 * 1. Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28#ifndef _RDHDR_HISTOGRAM_H_
29#define _RDHDR_HISTOGRAM_H_
30
31#include <inttypes.h>
32
33
34typedef struct rd_hdr_histogram_s {
35 int64_t lowestTrackableValue;
36 int64_t highestTrackableValue;
37 int64_t unitMagnitude;
38 int64_t significantFigures;
39 int32_t subBucketHalfCountMagnitude;
40 int32_t subBucketHalfCount;
41 int64_t subBucketMask;
42 int32_t subBucketCount;
43 int32_t bucketCount;
44 int32_t countsLen;
45 int64_t totalCount;
46 int64_t *counts;
47 int64_t outOfRangeCount; /**< Number of rejected records due to
48 * value being out of range. */
49 int64_t lowestOutOfRange; /**< Lowest value that was out of range.
50 * Initialized to lowestTrackableValue */
51 int64_t highestOutOfRange; /**< Highest value that was out of range.
52 * Initialized to highestTrackableValue */
53 int32_t allocatedSize; /**< Allocated size of histogram, for
54 * sigfigs tuning. */
55} rd_hdr_histogram_t;
56
57
58#endif /* !_RDHDR_HISTOGRAM_H_ */
59
60
61void rd_hdr_histogram_destroy (rd_hdr_histogram_t *hdr);
62
63/**
64 * @brief Create a new Hdr_Histogram.
65 *
66 * @param significant_figures must be between 1..5
67 *
68 * @returns a newly allocated histogram, or NULL on error.
69 *
70 * @sa rd_hdr_histogram_destroy()
71 */
72rd_hdr_histogram_t *rd_hdr_histogram_new (int64_t minValue, int64_t maxValue,
73 int significantFigures);
74
75void rd_hdr_histogram_reset (rd_hdr_histogram_t *hdr);
76
77int rd_hdr_histogram_record (rd_hdr_histogram_t *hdr, int64_t v);
78
79double rd_hdr_histogram_stddev (rd_hdr_histogram_t *hdr);
80double rd_hdr_histogram_mean (const rd_hdr_histogram_t *hdr);
81int64_t rd_hdr_histogram_max (const rd_hdr_histogram_t *hdr);
82int64_t rd_hdr_histogram_min (const rd_hdr_histogram_t *hdr);
83int64_t rd_hdr_histogram_quantile (const rd_hdr_histogram_t *hdr, double q);
84
85
86int unittest_rdhdrhistogram (void);
87