1"""sqlglot expressions - math, trigonometry, and bitwise functions."""
  2
  3from __future__ import annotations
  4
  5from sqlglot.expressions.core import Expression, Func, AggFunc
  6
  7
  8# Trigonometric
  9
 10
 11class Acos(Expression, Func):
 12    pass
 13
 14
 15class Acosh(Expression, Func):
 16    pass
 17
 18
 19class Asin(Expression, Func):
 20    pass
 21
 22
 23class Asinh(Expression, Func):
 24    pass
 25
 26
 27class Atan(Expression, Func):
 28    arg_types = {"this": True, "expression": False}
 29
 30
 31class Atanh(Expression, Func):
 32    pass
 33
 34
 35class Atan2(Expression, Func):
 36    arg_types = {"this": True, "expression": True}
 37
 38
 39class Cos(Expression, Func):
 40    pass
 41
 42
 43class Cosh(Expression, Func):
 44    pass
 45
 46
 47class Cot(Expression, Func):
 48    pass
 49
 50
 51class Coth(Expression, Func):
 52    pass
 53
 54
 55class Csc(Expression, Func):
 56    pass
 57
 58
 59class Csch(Expression, Func):
 60    pass
 61
 62
 63class Degrees(Expression, Func):
 64    pass
 65
 66
 67class Radians(Expression, Func):
 68    pass
 69
 70
 71class Sec(Expression, Func):
 72    pass
 73
 74
 75class Sech(Expression, Func):
 76    pass
 77
 78
 79class Sin(Expression, Func):
 80    pass
 81
 82
 83class Sinh(Expression, Func):
 84    pass
 85
 86
 87class Tan(Expression, Func):
 88    pass
 89
 90
 91class Tanh(Expression, Func):
 92    pass
 93
 94
 95# Geometric distance / similarity
 96
 97
 98class CosineDistance(Expression, Func):
 99    arg_types = {"this": True, "expression": True}
100
101
102class DotProduct(Expression, Func):
103    arg_types = {"this": True, "expression": True}
104
105
106class EuclideanDistance(Expression, Func):
107    arg_types = {"this": True, "expression": True}
108
109
110class JarowinklerSimilarity(Expression, Func):
111    arg_types = {
112        "this": True,
113        "expression": True,
114        "case_insensitive": False,
115        "integer_scale": False,
116    }
117
118
119class ManhattanDistance(Expression, Func):
120    arg_types = {"this": True, "expression": True}
121
122
123# Basic arithmetic / math
124
125
126class Abs(Expression, Func):
127    pass
128
129
130class Cbrt(Expression, Func):
131    pass
132
133
134class Ceil(Expression, Func):
135    arg_types = {"this": True, "decimals": False, "to": False}
136    _sql_names = ["CEIL", "CEILING"]
137
138
139class Exp(Expression, Func):
140    pass
141
142
143class Factorial(Expression, Func):
144    pass
145
146
147class Floor(Expression, Func):
148    arg_types = {"this": True, "decimals": False, "to": False}
149
150
151class IsInf(Expression, Func):
152    _sql_names = ["IS_INF", "ISINF"]
153
154
155class IsNan(Expression, Func):
156    _sql_names = ["IS_NAN", "ISNAN"]
157
158
159class Ln(Expression, Func):
160    pass
161
162
163class Log(Expression, Func):
164    arg_types = {"this": True, "expression": False}
165
166
167class Negative(Expression, Func):
168    pass
169
170
171class Nanvl(Expression, Func):
172    arg_types = {"this": True, "expression": True}
173
174
175class Pi(Expression, Func):
176    arg_types = {}
177
178
179class Rint(Expression, Func):
180    pass
181
182
183class Round(Expression, Func):
184    arg_types = {
185        "this": True,
186        "decimals": False,
187        "truncate": False,
188        "casts_non_integer_decimals": False,
189    }
190
191
192class Sign(Expression, Func):
193    _sql_names = ["SIGN", "SIGNUM"]
194
195
196class Sqrt(Expression, Func):
197    pass
198
199
200class Trunc(Expression, Func):
201    arg_types = {"this": True, "decimals": False, "fractions_supported": False}
202    _sql_names = ["TRUNC", "TRUNCATE"]
203
204
205# Safe arithmetic
206
207
208class SafeAdd(Expression, Func):
209    arg_types = {"this": True, "expression": True}
210
211
212class SafeDivide(Expression, Func):
213    arg_types = {"this": True, "expression": True}
214
215
216class SafeMultiply(Expression, Func):
217    arg_types = {"this": True, "expression": True}
218
219
220class SafeNegate(Expression, Func):
221    pass
222
223
224class SafeSubtract(Expression, Func):
225    arg_types = {"this": True, "expression": True}
226
227
228# Bitwise
229
230
231class BitwiseAndAgg(Expression, AggFunc):
232    pass
233
234
235class BitwiseCount(Expression, Func):
236    pass
237
238
239class BitwiseOrAgg(Expression, AggFunc):
240    pass
241
242
243class BitwiseXorAgg(Expression, AggFunc):
244    pass
245
246
247class BitmapBitPosition(Expression, Func):
248    pass
249
250
251class BitmapBucketNumber(Expression, Func):
252    pass
253
254
255class BitmapConstructAgg(Expression, AggFunc):
256    pass
257
258
259class BitmapCount(Expression, Func):
260    pass
261
262
263class BitmapOrAgg(Expression, AggFunc):
264    pass
265
266
267class Booland(Expression, Func):
268    arg_types = {"this": True, "expression": True, "round_input": False}
269
270
271class Boolnot(Expression, Func):
272    arg_types = {"this": True, "round_input": False}
273
274
275class Boolor(Expression, Func):
276    arg_types = {"this": True, "expression": True, "round_input": False}
277
278
279class BoolxorAgg(Expression, AggFunc):
280    pass
281
282
283class Getbit(Expression, Func):
284    _sql_names = ["GETBIT", "GET_BIT"]
285    # zero_is_msb means the most significant bit is indexed 0
286    arg_types = {"this": True, "expression": True, "zero_is_msb": False}