Skip to content

Commit 431bf8a

Browse files
committed
update docs one last time
1 parent 74470e3 commit 431bf8a

File tree

2 files changed

+30
-13
lines changed

2 files changed

+30
-13
lines changed

mlir/include/mlir/Dialect/Polynomial/IR/Polynomial.td

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ def Polynomial_AddOp : Polynomial_BinaryOp<"add", [Commutative]> {
5252
// add two polynomials modulo x^1024 - 1
5353
#poly = #polynomial.int_polynomial<x**1024 - 1>
5454
#ring = #polynomial.ring<coefficientType=i32, coefficientModulus=65536:i32, polynomialModulus=#poly>
55-
%0 = polynomial.constant #polynomial.int_polynomial<1 + x**2> : !polynomial.polynomial<#ring>
56-
%1 = polynomial.constant #polynomial.int_polynomial<x**5 - x + 1> : !polynomial.polynomial<#ring>
55+
%0 = polynomial.constant int<1 + x**2> : !polynomial.polynomial<#ring>
56+
%1 = polynomial.constant int<x**5 - x + 1> : !polynomial.polynomial<#ring>
5757
%2 = polynomial.add %0, %1 : !polynomial.polynomial<#ring>
5858
```
5959
}];
@@ -76,8 +76,8 @@ def Polynomial_SubOp : Polynomial_BinaryOp<"sub"> {
7676
// subtract two polynomials modulo x^1024 - 1
7777
#poly = #polynomial.int_polynomial<x**1024 - 1>
7878
#ring = #polynomial.ring<coefficientType=i32, coefficientModulus=65536:i32, polynomialModulus=#poly>
79-
%0 = polynomial.constant #polynomial.int_polynomial<1 + x**2> : !polynomial.polynomial<#ring>
80-
%1 = polynomial.constant #polynomial.int_polynomial<x**5 - x + 1> : !polynomial.polynomial<#ring>
79+
%0 = polynomial.constant int<1 + x**2> : !polynomial.polynomial<#ring>
80+
%1 = polynomial.constant int<x**5 - x + 1> : !polynomial.polynomial<#ring>
8181
%2 = polynomial.sub %0, %1 : !polynomial.polynomial<#ring>
8282
```
8383
}];
@@ -101,8 +101,8 @@ def Polynomial_MulOp : Polynomial_BinaryOp<"mul", [Commutative]> {
101101
// multiply two polynomials modulo x^1024 - 1
102102
#poly = #polynomial.int_polynomial<x**1024 - 1>
103103
#ring = #polynomial.ring<coefficientType=i32, coefficientModulus=65536:i32, polynomialModulus=#poly>
104-
%0 = polynomial.constant #polynomial.int_polynomial<1 + x**2> : !polynomial.polynomial<#ring>
105-
%1 = polynomial.constant #polynomial.int_polynomial<x**5 - x + 1> : !polynomial.polynomial<#ring>
104+
%0 = polynomial.constant int<1 + x**2> : !polynomial.polynomial<#ring>
105+
%1 = polynomial.constant int<x**5 - x + 1> : !polynomial.polynomial<#ring>
106106
%2 = polynomial.mul %0, %1 : !polynomial.polynomial<#ring>
107107
```
108108
}];
@@ -126,7 +126,7 @@ def Polynomial_MulScalarOp : Polynomial_Op<"mul_scalar", [
126126
// multiply two polynomials modulo x^1024 - 1
127127
#poly = #polynomial.int_polynomial<x**1024 - 1>
128128
#ring = #polynomial.ring<coefficientType=i32, coefficientModulus=65536:i32, polynomialModulus=#poly>
129-
%0 = polynomial.constant #polynomial.int_polynomial<1 + x**2> : !polynomial.polynomial<#ring>
129+
%0 = polynomial.constant int<1 + x**2> : !polynomial.polynomial<#ring>
130130
%1 = arith.constant 3 : i32
131131
%2 = polynomial.mul_scalar %0, %1 : !polynomial.polynomial<#ring>, i32
132132
```
@@ -157,7 +157,7 @@ def Polynomial_LeadingTermOp: Polynomial_Op<"leading_term"> {
157157
```mlir
158158
#poly = #polynomial.int_polynomial<x**1024 - 1>
159159
#ring = #polynomial.ring<coefficientType=i32, coefficientModulus=65536:i32, polynomialModulus=#poly>
160-
%0 = polynomial.constant #polynomial.int_polynomial<1 + x**2> : !polynomial.polynomial<#ring>
160+
%0 = polynomial.constant int<1 + x**2> : !polynomial.polynomial<#ring>
161161
%1, %2 = polynomial.leading_term %0 : !polynomial.polynomial<#ring> -> (index, i32)
162162
```
163163
}];
@@ -285,12 +285,11 @@ def Polynomial_ConstantOp : Op<Polynomial_Dialect, "constant",
285285
Example:
286286

287287
```mlir
288-
#poly = #polynomial.int_polynomial<x**1024 - 1>
289-
#ring = #polynomial.ring<coefficientType=i32, coefficientModulus=65536:i32, polynomialModulus=#poly>
290-
%0 = polynomial.constant #polynomial.int_polynomial<1 + x**2> : !polynomial.polynomial<#ring>
288+
!int_poly_ty = !polynomial.polynomial<ring=<coefficientType=i32>>
289+
%0 = polynomial.constant int<1 + x**2> : !int_poly_ty
291290

292-
#float_ring = #polynomial.ring<coefficientType=f32>
293-
%0 = polynomial.constant #polynomial.float_polynomial<0.5 + 1.3e06 x**2> : !polynomial.polynomial<#float_ring>
291+
!float_poly_ty = !polynomial.polynomial<ring=<coefficientType=f32>>
292+
%1 = polynomial.constant float<0.5 + 1.3e06 x**2> : !float_poly_ty
294293
```
295294
}];
296295
let arguments = (ins Polynomial_AnyTypedPolynomialAttr:$value);

mlir/include/mlir/Dialect/Polynomial/IR/PolynomialAttributes.td

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,15 @@ def Polynomial_FloatPolynomialAttr : Polynomial_Attr<"FloatPolynomial", "float_p
7575
def Polynomial_TypedIntPolynomialAttr : Polynomial_Attr<
7676
"TypedIntPolynomial", "typed_int_polynomial", [TypedAttrInterface]> {
7777
let summary = "a typed int_polynomial";
78+
let description = [{
79+
Example:
80+
81+
```mlir
82+
!poly_ty = !polynomial.polynomial<ring=<coefficientType=i32>>
83+
#poly = int<1 x**7 + 4> : !poly_ty
84+
#poly_verbose = #polynomial.typed_int_polynomial<1 x**7 + 4> : !poly_ty
85+
```
86+
}];
7887
let parameters = (ins "::mlir::Type":$type, "::mlir::polynomial::IntPolynomialAttr":$value);
7988
let assemblyFormat = "$value `:` $type";
8089
let builders = [
@@ -98,6 +107,15 @@ def Polynomial_TypedIntPolynomialAttr : Polynomial_Attr<
98107
def Polynomial_TypedFloatPolynomialAttr : Polynomial_Attr<
99108
"TypedFloatPolynomial", "typed_float_polynomial", [TypedAttrInterface]> {
100109
let summary = "a typed float_polynomial";
110+
let description = [{
111+
Example:
112+
113+
```mlir
114+
!poly_ty = !polynomial.polynomial<ring=<coefficientType=f32>>
115+
#poly = float<1.4 x**7 + 4.5> : !poly_ty
116+
#poly_verbose = #polynomial.typed_float_polynomial<1.4 x**7 + 4.5> : !poly_ty
117+
```
118+
}];
101119
let parameters = (ins "::mlir::Type":$type, "::mlir::polynomial::FloatPolynomialAttr":$value);
102120
let assemblyFormat = "$value `:` $type";
103121
let builders = [

0 commit comments

Comments
 (0)