Coverage Report

Created: 2026-09-13 07:08

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/tdengine/source/util/src/tdigest.c
Line
Count
Source
1
/*
2
 * Copyright (c) 2019 TAOS Data, Inc. <jhtao@taosdata.com>
3
 *
4
 * This program is free software: you can use, redistribute, and/or modify
5
 * it under the terms of the GNU Affero General Public License, version 3
6
 * or later ("AGPL"), as published by the Free Software Foundation.
7
 *
8
 * This program is distributed in the hope that it will be useful, but WITHOUT
9
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10
 * FITNESS FOR A PARTICULAR PURPOSE.
11
 *
12
 * You should have received a copy of the GNU Affero General Public License
13
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
14
 */
15
16
/*
17
 * src/tdigest.c
18
 *
19
 * Implementation of the t-digest data structure used to compute accurate percentiles.
20
 *
21
 * It is based on the MergingDigest implementation found at:
22
 *   https://github.com/tdunning/t-digest/blob/master/src/main/java/com/tdunning/math/stats/MergingDigest.java
23
 *
24
 * Copyright (c) 2016, Usman Masood <usmanm at fastmail dot fm>
25
 */
26
27
#include "tdigest.h"
28
#include "os.h"
29
#include "osMath.h"
30
#include "tlog.h"
31
32
#define INTERPOLATE(x, x0, x1) (((x) - (x0)) / ((x1) - (x0)))
33
// #define INTEGRATED_LOCATION(compression, q)   ((compression) * (asin(2 * (q) - 1) + M_PI / 2) / M_PI)
34
0
#define INTEGRATED_LOCATION(compression, q) ((compression) * (asin(2 * (double)(q)-1) / M_PI + (double)1 / 2))
35
0
#define FLOAT_EQ(f1, f2)                    (fabs((f1) - (f2)) <= FLT_EPSILON)
36
37
typedef struct SMergeArgs {
38
  TDigest   *t;
39
  SCentroid *centroids;
40
  int32_t    idx;
41
  double     weight_so_far;
42
  double     k1;
43
  double     min;
44
  double     max;
45
} SMergeArgs;
46
47
0
void tdigestAutoFill(TDigest *t, int32_t compression) {
48
0
  t->centroids = (SCentroid *)((char *)t + sizeof(TDigest));
49
0
  t->buffered_pts = (SPt *)((char *)t + sizeof(TDigest) + sizeof(SCentroid) * (int32_t)GET_CENTROID(compression));
50
0
}
51
52
0
TDigest *tdigestNewFrom(void *pBuf, int32_t compression) {
53
0
  memset(pBuf, 0, (size_t)TDIGEST_SIZE(compression));
54
0
  TDigest *t = (TDigest *)pBuf;
55
0
  tdigestAutoFill(t, compression);
56
57
0
  t->compression = compression;
58
0
  t->size = (int64_t)GET_CENTROID(compression);
59
0
  t->threshold = (int32_t)GET_THRESHOLD(compression);
60
0
  t->min = DOUBLE_MAX;
61
0
  t->max = -DOUBLE_MAX;
62
63
0
  return t;
64
0
}
65
66
0
static int32_t cmpCentroid(const void *a, const void *b) {
67
0
  SCentroid *c1 = (SCentroid *)a;
68
0
  SCentroid *c2 = (SCentroid *)b;
69
0
  if (c1->mean < c2->mean) return -1;
70
0
  if (c1->mean > c2->mean) return 1;
71
0
  return 0;
72
0
}
73
74
0
static void mergeCentroid(SMergeArgs *args, SCentroid *merge) {
75
0
  double     k2;
76
0
  SCentroid *c = &args->centroids[args->idx];
77
78
0
  args->weight_so_far += merge->weight;
79
0
  k2 = INTEGRATED_LOCATION(args->t->size, args->weight_so_far / args->t->total_weight);
80
  // idx++
81
0
  if (k2 - args->k1 > 1 && c->weight > 0) {
82
0
    if (args->idx + 1 < args->t->size && merge->mean != args->centroids[args->idx].mean) {
83
0
      args->idx++;
84
0
    }
85
0
    args->k1 = k2;
86
0
  }
87
88
0
  c = &args->centroids[args->idx];
89
0
  if (c->mean == merge->mean) {
90
0
    c->weight += merge->weight;
91
0
  } else {
92
0
    c->weight += merge->weight;
93
0
    c->mean += (merge->mean - c->mean) * merge->weight / c->weight;
94
95
0
    if (merge->weight > 0) {
96
0
      args->min = TMIN(merge->mean, args->min);
97
0
      args->max = TMAX(merge->mean, args->max);
98
0
    }
99
0
  }
100
0
}
101
102
0
int32_t tdigestCompress(TDigest *t) {
103
0
  SCentroid *unmerged_centroids;
104
0
  int64_t    unmerged_weight = 0;
105
0
  int32_t    num_unmerged = t->num_buffered_pts;
106
0
  int32_t    i, j;
107
0
  SMergeArgs args;
108
109
0
  if (t->num_buffered_pts <= 0) return 0;
110
111
0
  unmerged_centroids = (SCentroid *)taosMemoryMalloc(sizeof(SCentroid) * t->num_buffered_pts);
112
0
  if (unmerged_centroids == NULL) {
113
0
    return terrno;
114
0
  }
115
0
  for (i = 0; i < num_unmerged; i++) {
116
0
    SPt       *p = t->buffered_pts + i;
117
0
    SCentroid *c = &unmerged_centroids[i];
118
0
    c->mean = p->value;
119
0
    c->weight = p->weight;
120
0
    unmerged_weight += c->weight;
121
0
  }
122
0
  t->num_buffered_pts = 0;
123
0
  t->total_weight += unmerged_weight;
124
125
0
  taosSort(unmerged_centroids, num_unmerged, sizeof(SCentroid), cmpCentroid);
126
0
  memset(&args, 0, sizeof(SMergeArgs));
127
0
  args.centroids = (SCentroid *)taosMemoryMalloc((size_t)(sizeof(SCentroid) * t->size));
128
0
  if (args.centroids == NULL) {
129
0
    taosMemoryFree((void *)unmerged_centroids);
130
0
    return terrno;
131
0
  }
132
0
  memset(args.centroids, 0, (size_t)(sizeof(SCentroid) * t->size));
133
134
0
  args.t = t;
135
0
  args.min = DOUBLE_MAX;
136
0
  args.max = -DOUBLE_MAX;
137
138
0
  i = 0;
139
0
  j = 0;
140
0
  while (i < num_unmerged && j < t->num_centroids) {
141
0
    SCentroid *a = &unmerged_centroids[i];
142
0
    SCentroid *b = &t->centroids[j];
143
144
0
    if (a->mean <= b->mean) {
145
0
      mergeCentroid(&args, a);
146
0
      i++;
147
0
    } else {
148
0
      mergeCentroid(&args, b);
149
0
      j++;
150
0
    }
151
0
  }
152
153
0
  while (i < num_unmerged) {
154
0
    mergeCentroid(&args, &unmerged_centroids[i++]);
155
0
  }
156
0
  taosMemoryFree((void *)unmerged_centroids);
157
158
0
  while (j < t->num_centroids) {
159
0
    mergeCentroid(&args, &t->centroids[j++]);
160
0
  }
161
162
0
  if (t->total_weight > 0) {
163
0
    t->min = TMIN(t->min, args.min);
164
0
    if (args.centroids[args.idx].weight <= 0) {
165
0
      args.idx--;
166
0
    }
167
0
    t->num_centroids = args.idx + 1;
168
0
    t->max = TMAX(t->max, args.max);
169
0
  }
170
171
0
  memcpy(t->centroids, args.centroids, sizeof(SCentroid) * t->num_centroids);
172
0
  taosMemoryFree((void *)args.centroids);
173
0
  return 0;
174
0
}
175
176
0
int32_t tdigestAdd(TDigest *t, double x, int64_t w) {
177
0
  if (w == 0) return 0;
178
179
0
  int32_t i = t->num_buffered_pts;
180
0
  if (i > 0 && t->buffered_pts[i - 1].value == x) {
181
0
    t->buffered_pts[i].weight = w;
182
0
  } else {
183
0
    t->buffered_pts[i].value = x;
184
0
    t->buffered_pts[i].weight = w;
185
0
    t->num_buffered_pts++;
186
0
  }
187
188
0
  if (t->num_buffered_pts >= t->threshold) {
189
0
    return tdigestCompress(t);
190
0
  }
191
0
  return 0;
192
0
}
193
194
#if 0
195
double tdigestCDF(TDigest *t, double x) {
196
  if (t == NULL) return 0;
197
198
  int32_t    i;
199
  double     left, right;
200
  int64_t    weight_so_far;
201
  SCentroid *a, *b, tmp;
202
203
  tdigestCompress(t);
204
  if (t->num_centroids == 0) return NAN;
205
  if (x < t->min) return 0;
206
  if (x > t->max) return 1;
207
  if (t->num_centroids == 1) {
208
    if (FLOAT_EQ(t->max, t->min)) return 0.5;
209
210
    return INTERPOLATE(x, t->min, t->max);
211
  }
212
213
  weight_so_far = 0;
214
  a = b = &tmp;
215
  b->mean = t->min;
216
  b->weight = 0;
217
  right = 0;
218
219
  for (i = 0; i < t->num_centroids; i++) {
220
    SCentroid *c = &t->centroids[i];
221
222
    left = b->mean - (a->mean + right);
223
    a = b;
224
    b = c;
225
    right = (b->mean - a->mean) * a->weight / (a->weight + b->weight);
226
227
    if (x < a->mean + right) {
228
      double cdf = (weight_so_far + a->weight * INTERPOLATE(x, a->mean - left, a->mean + right)) / t->total_weight;
229
      return TMAX(cdf, 0.0);
230
    }
231
232
    weight_so_far += a->weight;
233
  }
234
235
  left = b->mean - (a->mean + right);
236
  a = b;
237
  right = t->max - a->mean;
238
239
  if (x < a->mean + right) {
240
    return (weight_so_far + a->weight * INTERPOLATE(x, a->mean - left, a->mean + right)) / t->total_weight;
241
  }
242
243
  return 1;
244
}
245
#endif
246
247
0
double tdigestQuantile(TDigest *t, double q) {
248
0
  if (t == NULL) return 0;
249
250
0
  int32_t    i;
251
0
  double     left, right, idx;
252
0
  int64_t    weight_so_far;
253
0
  SCentroid *a, *b, tmp;
254
255
0
  if (tdigestCompress(t) != 0) {
256
0
    uError("failed to compress t-digest");
257
0
  }
258
0
  if (t->num_centroids == 0) return NAN;
259
0
  if (t->num_centroids == 1) return t->centroids[0].mean;
260
0
  if (FLOAT_EQ(q, 0.0)) return t->min;
261
0
  if (FLOAT_EQ(q, 1.0)) return t->max;
262
263
0
  idx = q * t->total_weight;
264
0
  weight_so_far = 0;
265
0
  b = &tmp;
266
0
  b->mean = t->min;
267
0
  b->weight = 0;
268
0
  right = t->min;
269
270
0
  for (i = 0; i < t->num_centroids; i++) {
271
0
    SCentroid *c = &t->centroids[i];
272
0
    a = b;
273
0
    left = right;
274
275
0
    b = c;
276
0
    right = (b->weight * a->mean + a->weight * b->mean) / (a->weight + b->weight);
277
0
    if (idx < weight_so_far + a->weight) {
278
0
      double p = (idx - weight_so_far) / ((a->weight == 0) ? 1 : a->weight);
279
0
      return left * (1 - p) + right * p;
280
0
    }
281
0
    weight_so_far += a->weight;
282
0
  }
283
284
0
  left = right;
285
0
  a = b;
286
0
  right = t->max;
287
288
0
  if (idx < weight_so_far + a->weight && a->weight != 0) {
289
0
    double p = (idx - weight_so_far) / a->weight;
290
0
    return left * (1 - p) + right * p;
291
0
  }
292
293
0
  return t->max;
294
0
}
295
296
0
int32_t tdigestMerge(TDigest *t1, TDigest *t2) {
297
0
  int32_t code = 0;
298
  // SPoints
299
0
  int32_t num_pts = t2->num_buffered_pts;
300
0
  for (int32_t i = num_pts - 1; i >= 0; i--) {
301
0
    SPt *p = t2->buffered_pts + i;
302
0
    code = tdigestAdd(t1, p->value, p->weight);
303
0
    if (code) return code;
304
0
    t2->num_buffered_pts--;
305
0
  }
306
  // centroids
307
0
  for (int32_t i = 0; i < t2->num_centroids; i++) {
308
0
    code = tdigestAdd(t1, t2->centroids[i].mean, t2->centroids[i].weight);
309
0
    if (code) return code;
310
0
  }
311
312
0
  return 0;
313
0
}