Skip to content

Commit d34d47d

Browse files
authored
Update Generated docs (#6)
Update MLIR dialect documentation
1 parent 44d7987 commit d34d47d

File tree

1 file changed

+47
-21
lines changed

1 file changed

+47
-21
lines changed

docs/ForDevelopers/MLIR/Dialects/SubOperator/SubOperatorDialect.md

Lines changed: 47 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -171,8 +171,8 @@ Interfaces: `SubOperator`
171171

172172
<table>
173173
<tr><th>Attribute</th><th>MLIR Type</th><th>Description</th></tr>
174-
<tr><td><code>hash_member</code></td><td>::mlir::StringAttr</td><td>string attribute</td></tr>
175-
<tr><td><code>link_member</code></td><td>::mlir::StringAttr</td><td>string attribute</td></tr>
174+
<tr><td><code>hash_member</code></td><td>::lingodb::compiler::dialect::subop::MemberAttr</td><td><details><summary></summary><ul><li>References a member in a state, e.g., for specifying the members to sort for etc</li></ul></details></td></tr>
175+
<tr><td><code>link_member</code></td><td>::lingodb::compiler::dialect::subop::MemberAttr</td><td><details><summary></summary><ul><li>References a member in a state, e.g., for specifying the members to sort for etc</li></ul></details></td></tr>
176176
</table>
177177

178178
#### Operands:
@@ -513,7 +513,7 @@ Interfaces: `InferTypeOpInterface`, `StateUsingSubOperator`, `SubOperator`
513513
<table>
514514
<tr><th>Attribute</th><th>MLIR Type</th><th>Description</th></tr>
515515
<tr><td><code>ref</code></td><td>::lingodb::compiler::dialect::tuples::ColumnRefAttr</td><td></td></tr>
516-
<tr><td><code>mapping</code></td><td>::mlir::DictionaryAttr</td><td>dictionary of named attribute values</td></tr>
516+
<tr><td><code>mapping</code></td><td>::lingodb::compiler::dialect::subop::ColumnDefMemberMappingAttr</td><td><details><summary></summary><ul><li>A mapping from members to column definitions, e.g., for scans</li></ul></details></td></tr>
517517
</table>
518518

519519
#### Operands:
@@ -757,7 +757,7 @@ Interfaces: `ColumnFoldable`, `StateUsingSubOperator`, `SubOperator`
757757

758758
<table>
759759
<tr><th>Attribute</th><th>MLIR Type</th><th>Description</th></tr>
760-
<tr><td><code>mapping</code></td><td>::mlir::DictionaryAttr</td><td>dictionary of named attribute values</td></tr>
760+
<tr><td><code>mapping</code></td><td>::lingodb::compiler::dialect::subop::ColumnRefMemberMappingAttr</td><td><details><summary></summary><ul><li>A mapping from column references to members, e.g., for materializing operations</li></ul></details></td></tr>
761761
</table>
762762

763763
#### Operands:
@@ -887,7 +887,7 @@ Interfaces: `ContainsNestedSubOps`, `SubOperator`
887887
Syntax:
888888

889889
```
890-
operation ::= `subop.loop_continue` `(` $cond_state `:` type($cond_state) `[` $cond_member `]` `)` ($values^ `:` type($values))? attr-dict
890+
operation ::= `subop.loop_continue` `(` $cond_state `:` type($cond_state) `[`custom<CustMemberAttr>($cond_member) `]` `)` ($values^ `:` type($values))? attr-dict
891891
```
892892

893893

@@ -897,7 +897,7 @@ Traits: `Terminator`
897897

898898
<table>
899899
<tr><th>Attribute</th><th>MLIR Type</th><th>Description</th></tr>
900-
<tr><td><code>cond_member</code></td><td>::mlir::StringAttr</td><td>string attribute</td></tr>
900+
<tr><td><code>cond_member</code></td><td>::lingodb::compiler::dialect::subop::MemberAttr</td><td><details><summary></summary><ul><li>References a member in a state, e.g., for specifying the members to sort for etc</li></ul></details></td></tr>
901901
</table>
902902

903903
#### Operands:
@@ -965,7 +965,7 @@ Interfaces: `ColumnFoldable`, `StateUsingSubOperator`, `SubOperator`
965965

966966
<table>
967967
<tr><th>Attribute</th><th>MLIR Type</th><th>Description</th></tr>
968-
<tr><td><code>mapping</code></td><td>::mlir::DictionaryAttr</td><td>dictionary of named attribute values</td></tr>
968+
<tr><td><code>mapping</code></td><td>::lingodb::compiler::dialect::subop::ColumnRefMemberMappingAttr</td><td><details><summary></summary><ul><li>A mapping from column references to members, e.g., for materializing operations</li></ul></details></td></tr>
969969
</table>
970970

971971
#### Operands:
@@ -1220,7 +1220,7 @@ Effects: `MemoryEffects::Effect{}`
12201220

12211221
<table>
12221222
<tr><th>Attribute</th><th>MLIR Type</th><th>Description</th></tr>
1223-
<tr><td><code>mapping</code></td><td>::mlir::DictionaryAttr</td><td>dictionary of named attribute values</td></tr>
1223+
<tr><td><code>mapping</code></td><td>::lingodb::compiler::dialect::subop::ColumnDefMemberMappingAttr</td><td><details><summary></summary><ul><li>A mapping from members to column definitions, e.g., for scans</li></ul></details></td></tr>
12241224
</table>
12251225

12261226
#### Operands:
@@ -1331,7 +1331,7 @@ Interfaces: `StateUsingSubOperator`, `SubOperator`
13311331
<table>
13321332
<tr><th>Attribute</th><th>MLIR Type</th><th>Description</th></tr>
13331333
<tr><td><code>ref</code></td><td>::lingodb::compiler::dialect::tuples::ColumnRefAttr</td><td></td></tr>
1334-
<tr><td><code>mapping</code></td><td>::mlir::DictionaryAttr</td><td>dictionary of named attribute values</td></tr>
1334+
<tr><td><code>mapping</code></td><td>::lingodb::compiler::dialect::subop::ColumnRefMemberMappingAttr</td><td><details><summary></summary><ul><li>A mapping from column references to members, e.g., for materializing operations</li></ul></details></td></tr>
13351335
</table>
13361336

13371337
#### Operands:
@@ -1379,7 +1379,7 @@ Interfaces: `StateUsingSubOperator`, `SubOperator`
13791379
<table>
13801380
<tr><th>Attribute</th><th>MLIR Type</th><th>Description</th></tr>
13811381
<tr><td><code>resultId</code></td><td>::mlir::IntegerAttr</td><td>32-bit signless integer attribute</td></tr>
1382-
<tr><td><code>readState</code></td><td>::mlir::StringAttr</td><td>string attribute</td></tr>
1382+
<tr><td><code>readState</code></td><td>::lingodb::compiler::dialect::subop::MemberAttr</td><td><details><summary></summary><ul><li>References a member in a state, e.g., for specifying the members to sort for etc</li></ul></details></td></tr>
13831383
</table>
13841384

13851385
#### Operands:
@@ -1407,7 +1407,7 @@ Interfaces: `SubOperator`
14071407

14081408
<table>
14091409
<tr><th>Attribute</th><th>MLIR Type</th><th>Description</th></tr>
1410-
<tr><td><code>member</code></td><td>::mlir::StringAttr</td><td>string attribute</td></tr>
1410+
<tr><td><code>member</code></td><td>::lingodb::compiler::dialect::subop::MemberAttr</td><td><details><summary></summary><ul><li>References a member in a state, e.g., for specifying the members to sort for etc</li></ul></details></td></tr>
14111411
</table>
14121412

14131413
#### Operands:
@@ -1488,27 +1488,53 @@ Interfaces: `InferTypeOpInterface`, `StateUsingSubOperator`, `SubOperator`
14881488

14891489
## Attributes
14901490

1491-
### StateMembersAttr
1491+
### ColumnDefMemberMappingAttr
14921492

14931493

14941494

1495-
Syntax:
1495+
A mapping from members to column definitions, e.g., for scans
1496+
1497+
#### Parameters:
1498+
1499+
| Parameter | C++ type | Description |
1500+
| :-------: | :-------: | ----------- |
1501+
| mappingList | `llvm::SmallVector<std::pair<Member, tuples::ColumnDefAttr>>` | |
1502+
1503+
### ColumnRefMemberMappingAttr
1504+
1505+
1506+
1507+
A mapping from column references to members, e.g., for materializing operations
1508+
1509+
#### Parameters:
1510+
1511+
| Parameter | C++ type | Description |
1512+
| :-------: | :-------: | ----------- |
1513+
| mappingList | `llvm::SmallVector<std::pair<Member, tuples::ColumnRefAttr>>` | |
1514+
1515+
### MemberAttr
1516+
1517+
1518+
1519+
References a member in a state, e.g., for specifying the members to sort for etc
1520+
1521+
#### Parameters:
1522+
1523+
| Parameter | C++ type | Description |
1524+
| :-------: | :-------: | ----------- |
1525+
| member | `subop::Member` | |
1526+
1527+
### StateMembersAttr
14961528

1497-
```
1498-
#subop.state_members<
1499-
mlir::ArrayAttr, # names
1500-
mlir::ArrayAttr # types
1501-
>
1502-
```
15031529

15041530

1531+
A list of members that are part of the state
15051532

15061533
#### Parameters:
15071534

15081535
| Parameter | C++ type | Description |
15091536
| :-------: | :-------: | ----------- |
1510-
| names | `mlir::ArrayAttr` | |
1511-
| types | `mlir::ArrayAttr` | |
1537+
| memberList | `llvm::SmallVector<Member>` | |
15121538

15131539
## Types
15141540

0 commit comments

Comments
 (0)