Skip to content

Commit ff11eea

Browse files
committed
update docs
1 parent 10cfbcf commit ff11eea

File tree

1 file changed

+24
-21
lines changed

1 file changed

+24
-21
lines changed

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

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ def Polynomial_Dialect : Dialect {
3939
%a = polynomial.constant <1 + x**2 - 3x**3> : polynomial.polynomial<#ring>
4040

4141
// A constant polynomial in a ring with i32 coefficients, modulo (x^1024 + 1)
42-
#modulus = #polynomial.polynomial<1 + x**1024>
42+
#modulus = #polynomial.int_polynomial<1 + x**1024>
4343
#ring = #polynomial.ring<coefficientType=i32, polynomialModulus=#modulus>
4444
%a = polynomial.constant <1 + x**2 - 3x**3> : polynomial.polynomial<#ring>
4545

4646
// A constant polynomial in a ring with i32 coefficients, with a polynomial
4747
// modulus of (x^1024 + 1) and a coefficient modulus of 17.
48-
#modulus = #polynomial.polynomial<1 + x**1024>
48+
#modulus = #polynomial.int_polynomial<1 + x**1024>
4949
#ring = #polynomial.ring<coefficientType=i32, coefficientModulus=17:i32, polynomialModulus=#modulus>
5050
%a = polynomial.constant <1 + x**2 - 3x**3> : polynomial.polynomial<#ring>
5151
```
@@ -126,7 +126,7 @@ def Polynomial_RingAttr : Polynomial_Attr<"Ring", "ring"> {
126126
`x**1024 - 1`.
127127

128128
```mlir
129-
#poly_mod = #polynomial.polynomial<-1 + x**1024>
129+
#poly_mod = #polynomial.int_polynomial<-1 + x**1024>
130130
#ring = #polynomial.ring<coefficientType=i32,
131131
coefficientModulus=4294967291:i32,
132132
polynomialModulus=#poly_mod>
@@ -210,10 +210,10 @@ def Polynomial_AddOp : Polynomial_BinaryOp<"add", [Commutative]> {
210210

211211
```mlir
212212
// add two polynomials modulo x^1024 - 1
213-
#poly = #polynomial.polynomial<x**1024 - 1>
213+
#poly = #polynomial.int_polynomial<x**1024 - 1>
214214
#ring = #polynomial.ring<coefficientType=i32, coefficientModulus=65536:i32, polynomialModulus=#poly>
215-
%0 = polynomial.constant #polynomial.polynomial<1 + x**2> : !polynomial.polynomial<#ring>
216-
%1 = polynomial.constant #polynomial.polynomial<x**5 - x + 1> : !polynomial.polynomial<#ring>
215+
%0 = polynomial.constant #polynomial.int_polynomial<1 + x**2> : !polynomial.polynomial<#ring>
216+
%1 = polynomial.constant #polynomial.int_polynomial<x**5 - x + 1> : !polynomial.polynomial<#ring>
217217
%2 = polynomial.add %0, %1 : !polynomial.polynomial<#ring>
218218
```
219219
}];
@@ -234,10 +234,10 @@ def Polynomial_SubOp : Polynomial_BinaryOp<"sub"> {
234234

235235
```mlir
236236
// subtract two polynomials modulo x^1024 - 1
237-
#poly = #polynomial.polynomial<x**1024 - 1>
237+
#poly = #polynomial.int_polynomial<x**1024 - 1>
238238
#ring = #polynomial.ring<coefficientType=i32, coefficientModulus=65536:i32, polynomialModulus=#poly>
239-
%0 = polynomial.constant #polynomial.polynomial<1 + x**2> : !polynomial.polynomial<#ring>
240-
%1 = polynomial.constant #polynomial.polynomial<x**5 - x + 1> : !polynomial.polynomial<#ring>
239+
%0 = polynomial.constant #polynomial.int_polynomial<1 + x**2> : !polynomial.polynomial<#ring>
240+
%1 = polynomial.constant #polynomial.int_polynomial<x**5 - x + 1> : !polynomial.polynomial<#ring>
241241
%2 = polynomial.sub %0, %1 : !polynomial.polynomial<#ring>
242242
```
243243
}];
@@ -258,10 +258,10 @@ def Polynomial_MulOp : Polynomial_BinaryOp<"mul", [Commutative]> {
258258

259259
```mlir
260260
// multiply two polynomials modulo x^1024 - 1
261-
#poly = #polynomial.polynomial<x**1024 - 1>
261+
#poly = #polynomial.int_polynomial<x**1024 - 1>
262262
#ring = #polynomial.ring<coefficientType=i32, coefficientModulus=65536:i32, polynomialModulus=#poly>
263-
%0 = polynomial.constant #polynomial.polynomial<1 + x**2> : !polynomial.polynomial<#ring>
264-
%1 = polynomial.constant #polynomial.polynomial<x**5 - x + 1> : !polynomial.polynomial<#ring>
263+
%0 = polynomial.constant #polynomial.int_polynomial<1 + x**2> : !polynomial.polynomial<#ring>
264+
%1 = polynomial.constant #polynomial.int_polynomial<x**5 - x + 1> : !polynomial.polynomial<#ring>
265265
%2 = polynomial.mul %0, %1 : !polynomial.polynomial<#ring>
266266
```
267267
}];
@@ -283,9 +283,9 @@ def Polynomial_MulScalarOp : Polynomial_Op<"mul_scalar", [
283283

284284
```mlir
285285
// multiply two polynomials modulo x^1024 - 1
286-
#poly = #polynomial.polynomial<x**1024 - 1>
286+
#poly = #polynomial.int_polynomial<x**1024 - 1>
287287
#ring = #polynomial.ring<coefficientType=i32, coefficientModulus=65536:i32, polynomialModulus=#poly>
288-
%0 = polynomial.constant #polynomial.polynomial<1 + x**2> : !polynomial.polynomial<#ring>
288+
%0 = polynomial.constant #polynomial.int_polynomial<1 + x**2> : !polynomial.polynomial<#ring>
289289
%1 = arith.constant 3 : i32
290290
%2 = polynomial.mul_scalar %0, %1 : !polynomial.polynomial<#ring>, i32
291291
```
@@ -314,9 +314,9 @@ def Polynomial_LeadingTermOp: Polynomial_Op<"leading_term"> {
314314
Example:
315315

316316
```mlir
317-
#poly = #polynomial.polynomial<x**1024 - 1>
317+
#poly = #polynomial.int_polynomial<x**1024 - 1>
318318
#ring = #polynomial.ring<coefficientType=i32, coefficientModulus=65536:i32, polynomialModulus=#poly>
319-
%0 = polynomial.constant #polynomial.polynomial<1 + x**2> : !polynomial.polynomial<#ring>
319+
%0 = polynomial.constant #polynomial.int_polynomial<1 + x**2> : !polynomial.polynomial<#ring>
320320
%1, %2 = polynomial.leading_term %0 : !polynomial.polynomial<#ring> -> (index, i32)
321321
```
322322
}];
@@ -337,7 +337,7 @@ def Polynomial_MonomialOp: Polynomial_Op<"monomial"> {
337337
Example:
338338

339339
```mlir
340-
#poly = #polynomial.polynomial<x**1024 - 1>
340+
#poly = #polynomial.int_polynomial<x**1024 - 1>
341341
#ring = #polynomial.ring<coefficientType=i32, coefficientModulus=65536:i32, polynomialModulus=#poly>
342342
%deg = arith.constant 1023 : index
343343
%five = arith.constant 5 : i32
@@ -377,7 +377,7 @@ def Polynomial_FromTensorOp : Polynomial_Op<"from_tensor", [Pure]> {
377377
Example:
378378

379379
```mlir
380-
#poly = #polynomial.polynomial<x**1024 - 1>
380+
#poly = #polynomial.int_polynomial<x**1024 - 1>
381381
#ring = #polynomial.ring<coefficientType=i32, coefficientModulus=65536:i32, polynomialModulus=#poly>
382382
%two = arith.constant 2 : i32
383383
%five = arith.constant 5 : i32
@@ -416,7 +416,7 @@ def Polynomial_ToTensorOp : Polynomial_Op<"to_tensor", [Pure]> {
416416
Example:
417417

418418
```mlir
419-
#poly = #polynomial.polynomial<x**1024 - 1>
419+
#poly = #polynomial.int_polynomial<x**1024 - 1>
420420
#ring = #polynomial.ring<coefficientType=i32, coefficientModulus=65536:i32, polynomialModulus=#poly>
421421
%two = arith.constant 2 : i32
422422
%five = arith.constant 5 : i32
@@ -443,9 +443,12 @@ def Polynomial_ConstantOp : Op<Polynomial_Dialect, "constant", [Pure]> {
443443
Example:
444444

445445
```mlir
446-
#poly = #polynomial.polynomial<x**1024 - 1>
446+
#poly = #polynomial.int_polynomial<x**1024 - 1>
447447
#ring = #polynomial.ring<coefficientType=i32, coefficientModulus=65536:i32, polynomialModulus=#poly>
448-
%0 = polynomial.constant #polynomial.polynomial<1 + x**2> : !polynomial.polynomial<#ring>
448+
%0 = polynomial.constant #polynomial.int_polynomial<1 + x**2> : !polynomial.polynomial<#ring>
449+
450+
#float_ring = #polynomial.ring<coefficientType=f32>
451+
%0 = polynomial.constant #polynomial.float_polynomial<0.5 + 1.3e06 x**2> : !polynomial.polynomial<#float_ring>
449452
```
450453
}];
451454
let arguments = (ins Polynomial_AnyPolynomialAttr:$value);

0 commit comments

Comments
 (0)