Skip to content

Commit 47db5b1

Browse files
committed
Fix documention
1 parent 3180cd0 commit 47db5b1

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

mlir/include/mlir/Dialect/Vector/IR/VectorOps.td

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1714,6 +1714,7 @@ def Vector_LoadOp : Vector_Op<"load", [
17141714
load operation. It must be a positive power of 2. The operation must access
17151715
memory at an address aligned to this boundary. Violations may lead to
17161716
architecture-specific faults or performance penalties.
1717+
A value of 0 indicates no specific alignment requirement.
17171718
}];
17181719

17191720
let arguments = (ins Arg<AnyMemRef, "the reference to load from",
@@ -1829,6 +1830,7 @@ def Vector_StoreOp : Vector_Op<"store", [
18291830
store operation. It must be a positive power of 2. The operation must access
18301831
memory at an address aligned to this boundary. Violations may lead to
18311832
architecture-specific faults or performance penalties.
1833+
A value of 0 indicates no specific alignment requirement.
18321834
}];
18331835

18341836
let arguments = (ins
@@ -1917,6 +1919,7 @@ def Vector_MaskedLoadOp :
19171919
load operation. It must be a positive power of 2. The operation must access
19181920
memory at an address aligned to this boundary. Violations may lead to
19191921
architecture-specific faults or performance penalties.
1922+
A value of 0 indicates no specific alignment requirement.
19201923
}];
19211924
let extraClassDeclaration = [{
19221925
MemRefType getMemRefType() {
@@ -2009,6 +2012,7 @@ def Vector_MaskedStoreOp :
20092012
store operation. It must be a positive power of 2. The operation must access
20102013
memory at an address aligned to this boundary. Violations may lead to
20112014
architecture-specific faults or performance penalties.
2015+
A value of 0 indicates no specific alignment requirement.
20122016
}];
20132017
let extraClassDeclaration = [{
20142018
MemRefType getMemRefType() {
@@ -2083,6 +2087,12 @@ def Vector_GatherOp :
20832087
during progressively lowering to bring other memory operations closer to
20842088
hardware ISA support for a gather.
20852089

2090+
An optional `alignment` attribute allows to specify the byte alignment of the
2091+
scatter operation. It must be a positive power of 2. The operation must access
2092+
memory at an address aligned to this boundary. Violations may lead to
2093+
architecture-specific faults or performance penalties.
2094+
A value of 0 indicates no specific alignment requirement.
2095+
20862096
Examples:
20872097

20882098
```mlir
@@ -2182,6 +2192,7 @@ def Vector_ScatterOp :
21822192
scatter operation. It must be a positive power of 2. The operation must access
21832193
memory at an address aligned to this boundary. Violations may lead to
21842194
architecture-specific faults or performance penalties.
2195+
A value of 0 indicates no specific alignment requirement.
21852196

21862197
Examples:
21872198

@@ -2265,6 +2276,7 @@ def Vector_ExpandLoadOp :
22652276
load operation. It must be a positive power of 2. The operation must access
22662277
memory at an address aligned to this boundary. Violations may lead to
22672278
architecture-specific faults or performance penalties.
2279+
A value of 0 indicates no specific alignment requirement.
22682280

22692281
Note, at the moment this Op is only available for fixed-width vectors.
22702282

@@ -2353,6 +2365,7 @@ def Vector_CompressStoreOp :
23532365
store operation. It must be a positive power of 2. The operation must access
23542366
memory at an address aligned to this boundary. Violations may lead to
23552367
architecture-specific faults or performance penalties.
2368+
A value of 0 indicates no specific alignment requirement.
23562369

23572370
Note, at the moment this Op is only available for fixed-width vectors.
23582371

0 commit comments

Comments
 (0)