Coverage Report

Created: 2026-05-27 07:00

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
8.56k
constexpr ComparisonResult Invert(ComparisonResult result) {
60
8.56k
  switch (result) {
61
2.92k
    case ComparisonResult::kLesser:
62
2.92k
      return ComparisonResult::kGreater;
63
5.11k
    case ComparisonResult::kGreater:
64
5.11k
      return ComparisonResult::kLesser;
65
139
    case ComparisonResult::kEqual:
66
139
      return ComparisonResult::kEqual;
67
379
    case ComparisonResult::kNanInequal:
68
379
      return ComparisonResult::kNanInequal;
69
8.56k
  }
70
8.56k
}
71
72
template <typename OutType>
73
struct ConversionVisitor {
74
  template <typename InType>
75
3.51k
  constexpr OutType operator()(InType v) {
76
3.51k
    return static_cast<OutType>(v);
77
3.51k
  }
long cel::internal::ConversionVisitor<long>::operator()<double>(double)
Line
Count
Source
75
736
  constexpr OutType operator()(InType v) {
76
736
    return static_cast<OutType>(v);
77
736
  }
long cel::internal::ConversionVisitor<long>::operator()<unsigned long>(unsigned long)
Line
Count
Source
75
507
  constexpr OutType operator()(InType v) {
76
507
    return static_cast<OutType>(v);
77
507
  }
long cel::internal::ConversionVisitor<long>::operator()<long>(long)
Line
Count
Source
75
797
  constexpr OutType operator()(InType v) {
76
797
    return static_cast<OutType>(v);
77
797
  }
unsigned long cel::internal::ConversionVisitor<unsigned long>::operator()<double>(double)
Line
Count
Source
75
646
  constexpr OutType operator()(InType v) {
76
646
    return static_cast<OutType>(v);
77
646
  }
unsigned long cel::internal::ConversionVisitor<unsigned long>::operator()<unsigned long>(unsigned long)
Line
Count
Source
75
459
  constexpr OutType operator()(InType v) {
76
459
    return static_cast<OutType>(v);
77
459
  }
unsigned long cel::internal::ConversionVisitor<unsigned long>::operator()<long>(long)
Line
Count
Source
75
373
  constexpr OutType operator()(InType v) {
76
373
    return static_cast<OutType>(v);
77
373
  }
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
9.74k
constexpr ComparisonResult Compare(T a, T b) {
82
9.74k
  return (a > b)    ? ComparisonResult::kGreater
83
9.74k
         : (a == b) ? ComparisonResult::kEqual
84
4.28k
                    : ComparisonResult::kLesser;
85
9.74k
}
cel::internal::ComparisonResult cel::internal::Compare<double>(double, double)
Line
Count
Source
81
4.24k
constexpr ComparisonResult Compare(T a, T b) {
82
4.24k
  return (a > b)    ? ComparisonResult::kGreater
83
4.24k
         : (a == b) ? ComparisonResult::kEqual
84
2.34k
                    : ComparisonResult::kLesser;
85
4.24k
}
cel::internal::ComparisonResult cel::internal::Compare<unsigned long>(unsigned long, unsigned long)
Line
Count
Source
81
5.49k
constexpr ComparisonResult Compare(T a, T b) {
82
5.49k
  return (a > b)    ? ComparisonResult::kGreater
83
5.49k
         : (a == b) ? ComparisonResult::kEqual
84
1.93k
                    : ComparisonResult::kLesser;
85
5.49k
}
Unexecuted instantiation: cel::internal::ComparisonResult cel::internal::Compare<long>(long, long)
86
87
5.02k
constexpr ComparisonResult DoubleCompare(double a, double b) {
88
  // constexpr friendly isnan check.
89
5.02k
  if (!(a == a) || !(b == b)) {
90
781
    return ComparisonResult::kNanInequal;
91
781
  }
92
4.24k
  return Compare(a, b);
93
5.02k
}
94
95
// Implement generic numeric comparison against double value.
96
struct DoubleCompareVisitor {
97
7.64k
  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
3.15k
  constexpr ComparisonResult operator()(uint64_t other) const {
104
3.15k
    if (v > kDoubleToUintMax) {
105
572
      return ComparisonResult::kGreater;
106
2.57k
    } else if (v < 0) {
107
641
      return ComparisonResult::kLesser;
108
1.93k
    } else {
109
1.93k
      return DoubleCompare(v, static_cast<double>(other));
110
1.93k
    }
111
3.15k
  }
112
113
4.49k
  constexpr ComparisonResult operator()(int64_t other) const {
114
4.49k
    if (v > kDoubleToIntMax) {
115
836
      return ComparisonResult::kGreater;
116
3.65k
    } else if (v < kDoubleToIntMin) {
117
567
      return ComparisonResult::kLesser;
118
3.08k
    } else {
119
3.08k
      return DoubleCompare(v, static_cast<double>(other));
120
3.08k
    }
121
4.49k
  }
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
9.09k
  constexpr explicit UintCompareVisitor(uint64_t v) : v(v) {}
129
130
1.80k
  constexpr ComparisonResult operator()(double other) const {
131
1.80k
    return Invert(DoubleCompareVisitor(other)(v));
132
1.80k
  }
133
134
0
  constexpr ComparisonResult operator()(uint64_t other) const {
135
0
    return Compare(v, other);
136
0
  }
137
138
7.29k
  constexpr ComparisonResult operator()(int64_t other) const {
139
7.29k
    if (v > kUintToIntMax || other < 0) {
140
1.79k
      return ComparisonResult::kGreater;
141
5.49k
    } else {
142
5.49k
      return Compare(v, static_cast<uint64_t>(other));
143
5.49k
    }
144
7.29k
  }
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
6.75k
  constexpr explicit IntCompareVisitor(int64_t v) : v(v) {}
152
153
2.48k
  constexpr ComparisonResult operator()(double other) {
154
2.48k
    return Invert(DoubleCompareVisitor(other)(v));
155
2.48k
  }
156
157
4.27k
  constexpr ComparisonResult operator()(uint64_t other) {
158
4.27k
    return Invert(UintCompareVisitor(other)(v));
159
4.27k
  }
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
14.9k
  explicit constexpr CompareVisitor(NumberVariant rhs) : rhs(rhs) {}
169
170
3.35k
  CEL_ABSL_VISIT_CONSTEXPR ComparisonResult operator()(double v) {
171
3.35k
    return absl::visit(DoubleCompareVisitor(v), rhs);
172
3.35k
  }
173
174
4.82k
  CEL_ABSL_VISIT_CONSTEXPR ComparisonResult operator()(uint64_t v) {
175
4.82k
    return absl::visit(UintCompareVisitor(v), rhs);
176
4.82k
  }
177
178
6.75k
  CEL_ABSL_VISIT_CONSTEXPR ComparisonResult operator()(int64_t v) {
179
6.75k
    return absl::visit(IntCompareVisitor(v), rhs);
180
6.75k
  }
181
  NumberVariant rhs;
182
};
183
184
struct LosslessConvertibleToIntVisitor {
185
2.45k
  constexpr bool operator()(double value) const {
186
2.45k
    return value >= kDoubleToIntMin && value <= kMaxDoubleRepresentableAsInt &&
187
1.75k
           value == static_cast<double>(static_cast<int64_t>(value));
188
2.45k
  }
189
546
  constexpr bool operator()(uint64_t value) const {
190
546
    return value <= kUintToIntMax;
191
546
  }
192
797
  constexpr bool operator()(int64_t value) const { return true; }
193
};
194
195
struct LosslessConvertibleToUintVisitor {
196
2.35k
  constexpr bool operator()(double value) const {
197
2.35k
    return value >= 0 && value <= kMaxDoubleRepresentableAsUint &&
198
1.56k
           value == static_cast<double>(static_cast<uint64_t>(value));
199
2.35k
  }
200
459
  constexpr bool operator()(uint64_t value) const { return true; }
201
458
  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
7.31k
  static constexpr Number FromInt64(int64_t value) { return Number(value); }
217
5.64k
  static constexpr Number FromUint64(uint64_t value) { return Number(value); }
218
6.39k
  static constexpr Number FromDouble(double value) { return Number(value); }
219
220
10.2k
  constexpr explicit Number(double double_value) : value_(double_value) {}
221
13.5k
  constexpr explicit Number(int64_t int_value) : value_(int_value) {}
222
11.2k
  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
2.04k
  CEL_ABSL_VISIT_CONSTEXPR int64_t AsInt() const {
233
2.04k
    return absl::visit(internal::ConversionVisitor<int64_t>(), value_);
234
2.04k
  }
235
236
  // Return unsigned int64 representation for the value.
237
  // Caller must guarantee the underlying value is representable as an
238
  // uint.
239
1.47k
  CEL_ABSL_VISIT_CONSTEXPR uint64_t AsUint() const {
240
1.47k
    return absl::visit(internal::ConversionVisitor<uint64_t>(), value_);
241
1.47k
  }
242
243
  // For key lookups, check if the conversion to signed int is lossless.
244
3.79k
  CEL_ABSL_VISIT_CONSTEXPR bool LosslessConvertibleToInt() const {
245
3.79k
    return absl::visit(internal::LosslessConvertibleToIntVisitor(), value_);
246
3.79k
  }
247
248
  // For key lookups, check if the conversion to unsigned int is lossless.
249
3.27k
  CEL_ABSL_VISIT_CONSTEXPR bool LosslessConvertibleToUint() const {
250
3.27k
    return absl::visit(internal::LosslessConvertibleToUintVisitor(), value_);
251
3.27k
  }
252
253
2.12k
  CEL_ABSL_VISIT_CONSTEXPR bool operator<(Number other) const {
254
2.12k
    return Compare(other) == internal::ComparisonResult::kLesser;
255
2.12k
  }
256
257
1.68k
  CEL_ABSL_VISIT_CONSTEXPR bool operator<=(Number other) const {
258
1.68k
    internal::ComparisonResult cmp = Compare(other);
259
1.68k
    return cmp != internal::ComparisonResult::kGreater &&
260
917
           cmp != internal::ComparisonResult::kNanInequal;
261
1.68k
  }
262
263
2.26k
  CEL_ABSL_VISIT_CONSTEXPR bool operator>(Number other) const {
264
2.26k
    return Compare(other) == internal::ComparisonResult::kGreater;
265
2.26k
  }
266
267
1.73k
  CEL_ABSL_VISIT_CONSTEXPR bool operator>=(Number other) const {
268
1.73k
    internal::ComparisonResult cmp = Compare(other);
269
1.73k
    return cmp != internal::ComparisonResult::kLesser &&
270
865
           cmp != internal::ComparisonResult::kNanInequal;
271
1.73k
  }
272
273
7.12k
  CEL_ABSL_VISIT_CONSTEXPR bool operator==(Number other) const {
274
7.12k
    return Compare(other) == internal::ComparisonResult::kEqual;
275
7.12k
  }
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
14.9k
      Number other) const {
293
14.9k
    return absl::visit(internal::CompareVisitor(other.value_), value_);
294
14.9k
  }
295
};
296
297
}  // namespace cel::internal
298
299
#endif  // THIRD_PARTY_CEL_CPP_INTERNAL_NUMBER_H_