cubecl_ir/
arithmetic.rs

1use core::fmt::Display;
2
3use crate::TypeHash;
4
5use crate::{BinaryOperator, OperationArgs, OperationReflect, UnaryOperator, Variable};
6
7/// Arithmetic operations
8#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
9#[derive(Debug, Clone, TypeHash, PartialEq, Eq, Hash, OperationReflect)]
10#[operation(opcode_name = ArithmeticOpCode, pure)]
11pub enum Arithmetic {
12    #[operation(commutative)]
13    Add(BinaryOperator),
14    #[operation(commutative)]
15    SaturatingAdd(BinaryOperator),
16    Fma(FmaOperator),
17    Sub(BinaryOperator),
18    SaturatingSub(BinaryOperator),
19    #[operation(commutative)]
20    Mul(BinaryOperator),
21    Div(BinaryOperator),
22    Abs(UnaryOperator),
23    Exp(UnaryOperator),
24    Log(UnaryOperator),
25    Log1p(UnaryOperator),
26    Cos(UnaryOperator),
27    Sin(UnaryOperator),
28    Tan(UnaryOperator),
29    Tanh(UnaryOperator),
30    Sinh(UnaryOperator),
31    Cosh(UnaryOperator),
32    ArcCos(UnaryOperator),
33    ArcSin(UnaryOperator),
34    ArcTan(UnaryOperator),
35    ArcSinh(UnaryOperator),
36    ArcCosh(UnaryOperator),
37    ArcTanh(UnaryOperator),
38    Degrees(UnaryOperator),
39    Radians(UnaryOperator),
40    ArcTan2(BinaryOperator),
41    Powf(BinaryOperator),
42    Powi(BinaryOperator),
43    Sqrt(UnaryOperator),
44    InverseSqrt(UnaryOperator),
45    Round(UnaryOperator),
46    Floor(UnaryOperator),
47    Ceil(UnaryOperator),
48    Trunc(UnaryOperator),
49    Erf(UnaryOperator),
50    Recip(UnaryOperator),
51    Clamp(ClampOperator),
52    Modulo(BinaryOperator),
53    Neg(UnaryOperator),
54    #[operation(commutative)]
55    Max(BinaryOperator),
56    #[operation(commutative)]
57    Min(BinaryOperator),
58    Remainder(BinaryOperator),
59    Magnitude(UnaryOperator),
60    Normalize(UnaryOperator),
61    #[operation(commutative)]
62    Dot(BinaryOperator),
63    #[operation(commutative)]
64    MulHi(BinaryOperator),
65}
66
67impl Display for Arithmetic {
68    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
69        match self {
70            Arithmetic::Add(op) => write!(f, "{} + {}", op.lhs, op.rhs),
71            Arithmetic::SaturatingAdd(op) => write!(f, "saturating_add({}, {})", op.lhs, op.rhs),
72            Arithmetic::Fma(op) => write!(f, "{} * {} + {}", op.a, op.b, op.c),
73            Arithmetic::Sub(op) => write!(f, "{} - {}", op.lhs, op.rhs),
74            Arithmetic::SaturatingSub(op) => write!(f, "saturating_sub({}, {})", op.lhs, op.rhs),
75            Arithmetic::Mul(op) => write!(f, "{} * {}", op.lhs, op.rhs),
76            Arithmetic::Div(op) => write!(f, "{} / {}", op.lhs, op.rhs),
77            Arithmetic::Abs(op) => write!(f, "{}.abs()", op.input),
78            Arithmetic::Exp(op) => write!(f, "{}.exp()", op.input),
79            Arithmetic::Log(op) => write!(f, "{}.log()", op.input),
80            Arithmetic::Log1p(op) => write!(f, "{}.log_1p()", op.input),
81            Arithmetic::Cos(op) => write!(f, "{}.cos()", op.input),
82            Arithmetic::Sin(op) => write!(f, "{}.sin()", op.input),
83            Arithmetic::Tan(op) => write!(f, "{}.tan()", op.input),
84            Arithmetic::Tanh(op) => write!(f, "{}.tanh()", op.input),
85            Arithmetic::Sinh(op) => write!(f, "{}.sinh()", op.input),
86            Arithmetic::Cosh(op) => write!(f, "{}.cosh()", op.input),
87            Arithmetic::ArcCos(op) => write!(f, "{}.acos()", op.input),
88            Arithmetic::ArcSin(op) => write!(f, "{}.asin()", op.input),
89            Arithmetic::ArcTan(op) => write!(f, "{}.atan()", op.input),
90            Arithmetic::ArcSinh(op) => write!(f, "{}.asinh()", op.input),
91            Arithmetic::ArcCosh(op) => write!(f, "{}.acosh()", op.input),
92            Arithmetic::ArcTanh(op) => write!(f, "{}.atanh()", op.input),
93            Arithmetic::Degrees(op) => write!(f, "{}.degrees()", op.input),
94            Arithmetic::Radians(op) => write!(f, "{}.radians()", op.input),
95            Arithmetic::ArcTan2(op) => write!(f, "{}.atan2({})", op.lhs, op.rhs),
96            Arithmetic::Powf(op) => write!(f, "{}.pow({})", op.lhs, op.rhs),
97            Arithmetic::Powi(op) => write!(f, "{}.powi({})", op.lhs, op.rhs),
98            Arithmetic::Sqrt(op) => write!(f, "{}.sqrt()", op.input),
99            Arithmetic::InverseSqrt(op) => write!(f, "{}.inverse_sqrt()", op.input),
100            Arithmetic::Round(op) => write!(f, "{}.round()", op.input),
101            Arithmetic::Floor(op) => write!(f, "{}.floor()", op.input),
102            Arithmetic::Ceil(op) => write!(f, "{}.ceil()", op.input),
103            Arithmetic::Trunc(op) => write!(f, "{}.trunc()", op.input),
104            Arithmetic::Erf(op) => write!(f, "{}.erf()", op.input),
105            Arithmetic::Recip(op) => write!(f, "{}.recip()", op.input),
106            Arithmetic::Clamp(op) => {
107                write!(f, "{}.clamp({}, {})", op.input, op.min_value, op.max_value)
108            }
109            Arithmetic::Modulo(op) => write!(f, "{} % {}", op.lhs, op.rhs),
110            Arithmetic::Neg(op) => write!(f, "-{}", op.input),
111            Arithmetic::Max(op) => write!(f, "{}.max({})", op.lhs, op.rhs),
112            Arithmetic::Min(op) => write!(f, "{}.min({})", op.lhs, op.rhs),
113            Arithmetic::Remainder(op) => write!(f, "{} rem {}", op.lhs, op.rhs),
114            Arithmetic::Magnitude(op) => write!(f, "{}.length()", op.input),
115            Arithmetic::Normalize(op) => write!(f, "{}.normalize()", op.input),
116            Arithmetic::Dot(op) => write!(f, "{}.dot({})", op.lhs, op.rhs),
117            Arithmetic::MulHi(op) => write!(f, "mul_hi({}, {})", op.lhs, op.rhs),
118        }
119    }
120}
121
122#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
123#[derive(Debug, Clone, TypeHash, PartialEq, Eq, Hash, OperationArgs)]
124#[allow(missing_docs)]
125pub struct ClampOperator {
126    pub input: Variable,
127    pub min_value: Variable,
128    pub max_value: Variable,
129}
130
131#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
132#[derive(Debug, Clone, TypeHash, PartialEq, Eq, Hash, OperationArgs)]
133#[allow(missing_docs)]
134pub struct ReadGlobalOperator {
135    pub variable: Variable,
136}
137
138#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
139#[derive(Debug, Clone, TypeHash, PartialEq, Eq, Hash)]
140#[allow(missing_docs)]
141pub struct ReadGlobalWithLayoutOperator {
142    pub variable: Variable,
143    pub tensor_read_pos: usize,
144    pub tensor_layout_pos: usize,
145}
146
147#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
148#[derive(Debug, Clone, TypeHash, PartialEq, Eq, Hash, OperationArgs)]
149#[allow(missing_docs)]
150pub struct FmaOperator {
151    pub a: Variable,
152    pub b: Variable,
153    pub c: Variable,
154}