Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
Craig Tiller | 74b611c | 2016-01-29 08:00:31 -0800 | [diff] [blame] | 3 | * Copyright 2015-2016, Google Inc. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 4 | * All rights reserved. |
| 5 | * |
| 6 | * Redistribution and use in source and binary forms, with or without |
| 7 | * modification, are permitted provided that the following conditions are |
| 8 | * met: |
| 9 | * |
| 10 | * * Redistributions of source code must retain the above copyright |
| 11 | * notice, this list of conditions and the following disclaimer. |
| 12 | * * Redistributions in binary form must reproduce the above |
| 13 | * copyright notice, this list of conditions and the following disclaimer |
| 14 | * in the documentation and/or other materials provided with the |
| 15 | * distribution. |
| 16 | * * Neither the name of Google Inc. nor the names of its |
| 17 | * contributors may be used to endorse or promote products derived from |
| 18 | * this software without specific prior written permission. |
| 19 | * |
| 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 24 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 25 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 26 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 27 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 28 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 29 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 30 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 31 | * |
| 32 | */ |
| 33 | |
Nicolas "Pixel" Noble | 1ff52d5 | 2015-03-01 05:24:36 +0100 | [diff] [blame] | 34 | #ifndef GRPC_SUPPORT_HISTOGRAM_H |
| 35 | #define GRPC_SUPPORT_HISTOGRAM_H |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 36 | |
Craig Tiller | 76877c3 | 2015-03-03 16:04:23 -0800 | [diff] [blame] | 37 | #include <grpc/support/port_platform.h> |
| 38 | #include <stddef.h> |
| 39 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 40 | #ifdef __cplusplus |
| 41 | extern "C" { |
| 42 | #endif |
| 43 | |
| 44 | typedef struct gpr_histogram gpr_histogram; |
| 45 | |
Craig Tiller | d6546c9 | 2016-01-29 07:59:35 -0800 | [diff] [blame] | 46 | GPR_API gpr_histogram *gpr_histogram_create(double resolution, |
| 47 | double max_bucket_start); |
Craig Tiller | 9b42637 | 2016-01-29 07:58:22 -0800 | [diff] [blame] | 48 | GPR_API void gpr_histogram_destroy(gpr_histogram *h); |
| 49 | GPR_API void gpr_histogram_add(gpr_histogram *h, double x); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 50 | |
| 51 | /* The following merges the second histogram into the first. It only works |
| 52 | if they have the same buckets and resolution. Returns 0 on failure, 1 |
| 53 | on success */ |
Craig Tiller | 9b42637 | 2016-01-29 07:58:22 -0800 | [diff] [blame] | 54 | GPR_API int gpr_histogram_merge(gpr_histogram *dst, const gpr_histogram *src); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 55 | |
Craig Tiller | d6546c9 | 2016-01-29 07:59:35 -0800 | [diff] [blame] | 56 | GPR_API double gpr_histogram_percentile(gpr_histogram *histogram, |
| 57 | double percentile); |
Craig Tiller | 9b42637 | 2016-01-29 07:58:22 -0800 | [diff] [blame] | 58 | GPR_API double gpr_histogram_mean(gpr_histogram *histogram); |
| 59 | GPR_API double gpr_histogram_stddev(gpr_histogram *histogram); |
| 60 | GPR_API double gpr_histogram_variance(gpr_histogram *histogram); |
| 61 | GPR_API double gpr_histogram_maximum(gpr_histogram *histogram); |
| 62 | GPR_API double gpr_histogram_minimum(gpr_histogram *histogram); |
| 63 | GPR_API double gpr_histogram_count(gpr_histogram *histogram); |
| 64 | GPR_API double gpr_histogram_sum(gpr_histogram *histogram); |
| 65 | GPR_API double gpr_histogram_sum_of_squares(gpr_histogram *histogram); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 66 | |
Craig Tiller | 9b42637 | 2016-01-29 07:58:22 -0800 | [diff] [blame] | 67 | GPR_API const uint32_t *gpr_histogram_get_contents(gpr_histogram *histogram, |
Craig Tiller | d6546c9 | 2016-01-29 07:59:35 -0800 | [diff] [blame] | 68 | size_t *count); |
Craig Tiller | 9b42637 | 2016-01-29 07:58:22 -0800 | [diff] [blame] | 69 | GPR_API void gpr_histogram_merge_contents(gpr_histogram *histogram, |
Craig Tiller | d6546c9 | 2016-01-29 07:59:35 -0800 | [diff] [blame] | 70 | const uint32_t *data, |
| 71 | size_t data_count, double min_seen, |
| 72 | double max_seen, double sum, |
| 73 | double sum_of_squares, double count); |
Craig Tiller | 76877c3 | 2015-03-03 16:04:23 -0800 | [diff] [blame] | 74 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 75 | #ifdef __cplusplus |
| 76 | } |
| 77 | #endif |
| 78 | |
Craig Tiller | d6c98df | 2015-08-18 09:33:44 -0700 | [diff] [blame] | 79 | #endif /* GRPC_SUPPORT_HISTOGRAM_H */ |