Coverage Report

Created: 2026-10-09 06:57

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/proc/self/cwd/internal/number.h
Line
Count
Source
1
// Copyright 2022 Google LLC
2
//
3
// Licensed under the Apache License, Version 2.0 (the "License");
4
// you may not use this file except in compliance with the License.
5
// You may obtain a copy of the License at
6
//
7
//     https://www.apache.org/licenses/LICENSE-2.0
8
//
9
// Unless required by applicable law or agreed to in writing, software
10
// distributed under the License is distributed on an "AS IS" BASIS,
11
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
// See the License for the specific language governing permissions and
13
// limitations under the License.
14
15
#ifndef THIRD_PARTY_CEL_CPP_INTERNAL_NUMBER_H_
16
#define THIRD_PARTY_CEL_CPP_INTERNAL_NUMBER_H_
17
18
#include <cstdint>
19
#include <limits>
20
21
#include "absl/types/variant.h"
22
23
namespace cel::internal {
24
25
constexpr int64_t kInt64Max = std::numeric_limits<int64_t>::max();
26
constexpr int64_t kInt64Min = std::numeric_limits<int64_t>::lowest();
27
constexpr uint64_t kUint64Max = std::numeric_limits<uint64_t>::max();
28
constexpr uint64_t kUintToIntMax = static_cast<uint64_t>(kInt64Max);
29
constexpr double kDoubleToIntMax = static_cast<double>(kInt64Max);
30
constexpr double kDoubleToIntMin = static_cast<double>(kInt64Min);
31
constexpr double kDoubleToUintMax = static_cast<double>(kUint64Max);
32
33
// The highest integer values that are round-trippable after rounding and
34
// casting to double.
35
template <typename T>
36
0
constexpr int RoundingError() {
37
0
  return 1 << (std::numeric_limits<T>::digits -
38
0
               std::numeric_limits<double>::digits - 1);
39
0
}
Unexecuted instantiation: int cel::internal::RoundingError<long>()
Unexecuted instantiation: int cel::internal::RoundingError<unsigned long>()
40
41
constexpr double kMaxDoubleRepresentableAsInt =
42
    static_cast<double>(kInt64Max - RoundingError<int64_t>());
43
constexpr double kMaxDoubleRepresentableAsUint =
44
    static_cast<double>(kUint64Max - RoundingError<uint64_t>());
45
46
#define CEL_ABSL_VISIT_CONSTEXPR
47
48
using NumberVariant = absl::variant<double, uint64_t, int64_t>;
49
50
enum class ComparisonResult {
51
  kLesser,
52
  kEqual,
53
  kGreater,
54
  // Special case for nan.
55
  kNanInequal
56
};
57
58
// Return the inverse relation (i.e. Invert(cmp(b, a)) is the same as cmp(a, b).
59
302k
constexpr ComparisonResult Invert(ComparisonResult result) {
60
302k
  switch (result) {
61
43.0k
    case ComparisonResult::kLesser:
62
43.0k
      return ComparisonResult::kGreater;
63
254k
    case ComparisonResult::kGreater:
64
254k
      return ComparisonResult::kLesser;
65
1.61k
    case ComparisonResult::kEqual:
66
1.61k
      return ComparisonResult::kEqual;
67
3.84k
    case ComparisonResult::kNanInequal:
68
3.84k
      return ComparisonResult::kNanInequal;
69
302k
  }
70
302k
}
71
72
template <typename OutType>
73
struct ConversionVisitor {
74
  template <typename InType>
75
668k
  constexpr OutType operator()(InType v) {
76
668k
    return static_cast<OutType>(v);
77
668k
  }
long cel::internal::ConversionVisitor<long>::operator()<double>(double)
Line
Count
Source
75
82.6k
  constexpr OutType operator()(InType v) {
76
82.6k
    return static_cast<OutType>(v);
77
82.6k
  }
long cel::internal::ConversionVisitor<long>::operator()<unsigned long>(unsigned long)
Line
Count
Source
75
1.90k
  constexpr OutType operator()(InType v) {
76
1.90k
    return static_cast<OutType>(v);
77
1.90k
  }
long cel::internal::ConversionVisitor<long>::operator()<long>(long)
Line
Count
Source
75
324k
  constexpr OutType operator()(InType v) {
76
324k
    return static_cast<OutType>(v);
77
324k
  }
unsigned long cel::internal::ConversionVisitor<unsigned long>::operator()<double>(double)
Line
Count
Source
75
2.95k
  constexpr OutType operator()(InType v) {
76
2.95k
    return static_cast<OutType>(v);
77
2.95k
  }
unsigned long cel::internal::ConversionVisitor<unsigned long>::operator()<unsigned long>(unsigned long)
Line
Count
Source
75
465
  constexpr OutType operator()(InType v) {
76
465
    return static_cast<OutType>(v);
77
465
  }
unsigned long cel::internal::ConversionVisitor<unsigned long>::operator()<long>(long)
Line
Count
Source
75
256k
  constexpr OutType operator()(InType v) {
76
256k
    return static_cast<OutType>(v);
77
256k
  }
Unexecuted instantiation: double cel::internal::ConversionVisitor<double>::operator()<double>(double)
Unexecuted instantiation: double cel::internal::ConversionVisitor<double>::operator()<unsigned long>(unsigned long)
Unexecuted instantiation: double cel::internal::ConversionVisitor<double>::operator()<long>(long)
78
};
79
80
template <typename T>
81
321k
constexpr ComparisonResult Compare(T a, T b) {
82
321k
  return (a > b)    ? ComparisonResult::kGreater
83
321k
         : (a == b) ? ComparisonResult::kEqual
84
78.1k
                    : ComparisonResult::kLesser;
85
321k
}
cel::internal::ComparisonResult cel::internal::Compare<double>(double, double)
Line
Count
Source
81
266k
constexpr ComparisonResult Compare(T a, T b) {
82
266k
  return (a > b)    ? ComparisonResult::kGreater
83
266k
         : (a == b) ? ComparisonResult::kEqual
84
58.9k
                    : ComparisonResult::kLesser;
85
266k
}
cel::internal::ComparisonResult cel::internal::Compare<unsigned long>(unsigned long, unsigned long)
Line
Count
Source
81
54.6k
constexpr ComparisonResult Compare(T a, T b) {
82
54.6k
  return (a > b)    ? ComparisonResult::kGreater
83
54.6k
         : (a == b) ? ComparisonResult::kEqual
84
19.2k
                    : ComparisonResult::kLesser;
85
54.6k
}
Unexecuted instantiation: cel::internal::ComparisonResult cel::internal::Compare<long>(long, long)
86
87
285k
constexpr ComparisonResult DoubleCompare(double a, double b) {
88
  // constexpr friendly isnan check.
89
285k
  if (!(a == a) || !(b == b)) {
90
18.6k
    return ComparisonResult::kNanInequal;
91
18.6k
  }
92
266k
  return Compare(a, b);
93
285k
}
94
95
// Implement generic numeric comparison against double value.
96
struct DoubleCompareVisitor {
97
311k
  constexpr explicit DoubleCompareVisitor(double v) : v(v) {}
98
99
0
  constexpr ComparisonResult operator()(double other) const {
100
0
    return DoubleCompare(v, other);
101
0
  }
102
103
228k
  constexpr ComparisonResult operator()(uint64_t other) const {
104
228k
    if (v > kDoubleToUintMax) {
105
14.9k
      return ComparisonResult::kGreater;
106
213k
    } else if (v < 0) {
107
4.32k
      return ComparisonResult::kLesser;
108
209k
    } else {
109
209k
      return DoubleCompare(v, static_cast<double>(other));
110
209k
    }
111
228k
  }
112
113
82.3k
  constexpr ComparisonResult operator()(int64_t other) const {
114
82.3k
    if (v > kDoubleToIntMax) {
115
3.49k
      return ComparisonResult::kGreater;
116
78.8k
    } else if (v < kDoubleToIntMin) {
117
2.97k
      return ComparisonResult::kLesser;
118
75.9k
    } else {
119
75.9k
      return DoubleCompare(v, static_cast<double>(other));
120
75.9k
    }
121
82.3k
  }
122
  double v;
123
};
124
125
// Implement generic numeric comparison against uint value.
126
// Delegates to double comparison if either variable is double.
127
struct UintCompareVisitor {
128
279k
  constexpr explicit UintCompareVisitor(uint64_t v) : v(v) {}
129
130
207k
  constexpr ComparisonResult operator()(double other) const {
131
207k
    return Invert(DoubleCompareVisitor(other)(v));
132
207k
  }
133
134
0
  constexpr ComparisonResult operator()(uint64_t other) const {
135
0
    return Compare(v, other);
136
0
  }
137
138
72.4k
  constexpr ComparisonResult operator()(int64_t other) const {
139
72.4k
    if (v > kUintToIntMax || other < 0) {
140
17.8k
      return ComparisonResult::kGreater;
141
54.6k
    } else {
142
54.6k
      return Compare(v, static_cast<uint64_t>(other));
143
54.6k
    }
144
72.4k
  }
145
  uint64_t v;
146
};
147
148
// Implement generic numeric comparison against int value.
149
// Delegates to uint / double if either value is uint / double.
150
struct IntCompareVisitor {
151
95.3k
  constexpr explicit IntCompareVisitor(int64_t v) : v(v) {}
152
153
53.6k
  constexpr ComparisonResult operator()(double other) {
154
53.6k
    return Invert(DoubleCompareVisitor(other)(v));
155
53.6k
  }
156
157
41.6k
  constexpr ComparisonResult operator()(uint64_t other) {
158
41.6k
    return Invert(UintCompareVisitor(other)(v));
159
41.6k
  }
160
161
0
  constexpr ComparisonResult operator()(int64_t other) {
162
0
    return Compare(v, other);
163
0
  }
164
  int64_t v;
165
};
166
167
struct CompareVisitor {
168
383k
  explicit constexpr CompareVisitor(NumberVariant rhs) : rhs(rhs) {}
169
170
50.2k
  CEL_ABSL_VISIT_CONSTEXPR ComparisonResult operator()(double v) {
171
50.2k
    return absl::visit(DoubleCompareVisitor(v), rhs);
172
50.2k
  }
173
174
238k
  CEL_ABSL_VISIT_CONSTEXPR ComparisonResult operator()(uint64_t v) {
175
238k
    return absl::visit(UintCompareVisitor(v), rhs);
176
238k
  }
177
178
95.3k
  CEL_ABSL_VISIT_CONSTEXPR ComparisonResult operator()(int64_t v) {
179
95.3k
    return absl::visit(IntCompareVisitor(v), rhs);
180
95.3k
  }
181
  NumberVariant rhs;
182
};
183
184
struct LosslessConvertibleToIntVisitor {
185
110k
  constexpr bool operator()(double value) const {
186
110k
    return value >= kDoubleToIntMin && value <= kMaxDoubleRepresentableAsInt &&
187
103k
           value == static_cast<double>(static_cast<int64_t>(value));
188
110k
  }
189
2.33k
  constexpr bool operator()(uint64_t value) const {
190
2.33k
    return value <= kUintToIntMax;
191
2.33k
  }
192
324k
  constexpr bool operator()(int64_t value) const { return true; }
193
};
194
195
struct LosslessConvertibleToUintVisitor {
196
30.5k
  constexpr bool operator()(double value) const {
197
30.5k
    return value >= 0 && value <= kMaxDoubleRepresentableAsUint &&
198
22.1k
           value == static_cast<double>(static_cast<uint64_t>(value));
199
30.5k
  }
200
465
  constexpr bool operator()(uint64_t value) const { return true; }
201
257k
  constexpr bool operator()(int64_t value) const { return value >= 0; }
202
};
203
204
// Utility class for CEL number operations.
205
//
206
// In CEL expressions, comparisons between different numeric types are treated
207
// as all happening on the same continuous number line. This generally means
208
// that integers and doubles in convertible range are compared after converting
209
// to doubles (tolerating some loss of precision).
210
//
211
// This extends to key lookups -- {1: 'abc'}[1.0f] is expected to work since
212
// 1.0 == 1 in CEL.
213
class Number {
214
 public:
215
  // Factories to resolve ambiguous overload resolution against literals.
216
409k
  static constexpr Number FromInt64(int64_t value) { return Number(value); }
217
228k
  static constexpr Number FromUint64(uint64_t value) { return Number(value); }
218
332k
  static constexpr Number FromDouble(double value) { return Number(value); }
219
220
422k
  constexpr explicit Number(double double_value) : value_(double_value) {}
221
494k
  constexpr explicit Number(int64_t int_value) : value_(int_value) {}
222
304k
  constexpr explicit Number(uint64_t uint_value) : value_(uint_value) {}
223
224
  // Return a double representation of the value.
225
0
  CEL_ABSL_VISIT_CONSTEXPR double AsDouble() const {
226
0
    return absl::visit(internal::ConversionVisitor<double>(), value_);
227
0
  }
228
229
  // Return signed int64 representation for the value.
230
  // Caller must guarantee the underlying value is representatble as an
231
  // int.
232
408k
  CEL_ABSL_VISIT_CONSTEXPR int64_t AsInt() const {
233
408k
    return absl::visit(internal::ConversionVisitor<int64_t>(), value_);
234
408k
  }
235
236
  // Return unsigned int64 representation for the value.
237
  // Caller must guarantee the underlying value is representable as an
238
  // uint.
239
259k
  CEL_ABSL_VISIT_CONSTEXPR uint64_t AsUint() const {
240
259k
    return absl::visit(internal::ConversionVisitor<uint64_t>(), value_);
241
259k
  }
242
243
  // For key lookups, check if the conversion to signed int is lossless.
244
436k
  CEL_ABSL_VISIT_CONSTEXPR bool LosslessConvertibleToInt() const {
245
436k
    return absl::visit(internal::LosslessConvertibleToIntVisitor(), value_);
246
436k
  }
247
248
  // For key lookups, check if the conversion to unsigned int is lossless.
249
288k
  CEL_ABSL_VISIT_CONSTEXPR bool LosslessConvertibleToUint() const {
250
288k
    return absl::visit(internal::LosslessConvertibleToUintVisitor(), value_);
251
288k
  }
252
253
31.1k
  CEL_ABSL_VISIT_CONSTEXPR bool operator<(Number other) const {
254
31.1k
    return Compare(other) == internal::ComparisonResult::kLesser;
255
31.1k
  }
256
257
22.3k
  CEL_ABSL_VISIT_CONSTEXPR bool operator<=(Number other) const {
258
22.3k
    internal::ComparisonResult cmp = Compare(other);
259
22.3k
    return cmp != internal::ComparisonResult::kGreater &&
260
12.0k
           cmp != internal::ComparisonResult::kNanInequal;
261
22.3k
  }
262
263
46.2k
  CEL_ABSL_VISIT_CONSTEXPR bool operator>(Number other) const {
264
46.2k
    return Compare(other) == internal::ComparisonResult::kGreater;
265
46.2k
  }
266
267
25.6k
  CEL_ABSL_VISIT_CONSTEXPR bool operator>=(Number other) const {
268
25.6k
    internal::ComparisonResult cmp = Compare(other);
269
25.6k
    return cmp != internal::ComparisonResult::kLesser &&
270
7.50k
           cmp != internal::ComparisonResult::kNanInequal;
271
25.6k
  }
272
273
258k
  CEL_ABSL_VISIT_CONSTEXPR bool operator==(Number other) const {
274
258k
    return Compare(other) == internal::ComparisonResult::kEqual;
275
258k
  }
276
277
0
  CEL_ABSL_VISIT_CONSTEXPR bool operator!=(Number other) const {
278
0
    return Compare(other) != internal::ComparisonResult::kEqual;
279
0
  }
280
281
  // Visit the underlying number representation, a variant of double, uint64_t,
282
  // or int64_t.
283
  template <typename T, typename Op>
284
  T visit(Op&& op) const {
285
    return absl::visit(std::forward<Op>(op), value_);
286
  }
287
288
 private:
289
  internal::NumberVariant value_;
290
291
  CEL_ABSL_VISIT_CONSTEXPR internal::ComparisonResult Compare(
292
383k
      Number other) const {
293
383k
    return absl::visit(internal::CompareVisitor(other.value_), value_);
294
383k
  }
295
};
296
297
}  // namespace cel::internal
298
299
#endif  // THIRD_PARTY_CEL_CPP_INTERNAL_NUMBER_H_