@@ -80,8 +80,8 @@ def ExecuteRegionOp : SCF_Op<"execute_region", [
80
80
DeclareOpInterfaceMethods<RegionBranchOpInterface>]> {
81
81
let summary = "operation that executes its region exactly once";
82
82
let description = [{
83
- The `execute_region` operation is used to allow multiple blocks within SCF
84
- and other operations which can hold only one block. The `execute_region`
83
+ The `scf. execute_region` operation is used to allow multiple blocks within SCF
84
+ and other operations which can hold only one block. The `scf. execute_region`
85
85
operation executes the region held exactly once and cannot have any operands.
86
86
As such, its region has no arguments. All SSA values that dominate the op can
87
87
be accessed inside the op. The op's region can have multiple blocks and the
@@ -344,7 +344,7 @@ def ForallOp : SCF_Op<"forall", [
344
344
345
345
The only allowed terminator is `scf.forall.in_parallel`.
346
346
`scf.forall` returns one value per `shared_out` operand. The
347
- actions of the `in_parallel` terminators specify how to combine the
347
+ actions of the `scf.forall. in_parallel` terminators specify how to combine the
348
348
partial results of all parallel invocations into a full value, in some
349
349
unspecified order. The "destination" of each such op must be a `shared_out`
350
350
block argument of the `scf.forall` op.
@@ -633,7 +633,7 @@ def InParallelOp : SCF_Op<"forall.in_parallel", [
633
633
] # GraphRegionNoTerminator.traits> {
634
634
let summary = "terminates a `forall` block";
635
635
let description = [{
636
- `scf.forall.in_parallel` is a designated terminator for
636
+ The `scf.forall.in_parallel` is a designated terminator for
637
637
the `scf.forall` operation.
638
638
639
639
It has a single region with a single block that contains a flat list of ops.
@@ -778,7 +778,7 @@ def ParallelOp : SCF_Op<"parallel",
778
778
HasParallelRegion]> {
779
779
let summary = "parallel for operation";
780
780
let description = [{
781
- The " scf.parallel" operation represents a loop nest taking 4 groups of SSA
781
+ The ` scf.parallel` operation represents a loop nest taking 4 groups of SSA
782
782
values as operands that represent the lower bounds, upper bounds, steps and
783
783
initial values, respectively. The operation defines a variadic number of
784
784
SSA values for its induction variables. It has one region capturing the
@@ -787,7 +787,7 @@ def ParallelOp : SCF_Op<"parallel",
787
787
machine word. The steps are values of type index, required to be positive.
788
788
The lower and upper bounds specify a half-open range: the range includes
789
789
the lower bound but does not include the upper bound. The initial values
790
- have the same types as results of " scf.parallel" . If there are no results,
790
+ have the same types as results of ` scf.parallel` . If there are no results,
791
791
the keyword `init` can be omitted.
792
792
793
793
Semantically we require that the iteration space can be iterated in any
@@ -796,17 +796,17 @@ def ParallelOp : SCF_Op<"parallel",
796
796
797
797
The parallel loop operation supports reduction of values produced by
798
798
individual iterations into a single result. This is modeled using the
799
- " scf.reduce" terminator operation (see " scf.reduce" for details). The i-th
800
- result of an " scf.parallel" operation is associated with the i-th initial
801
- value operand, the i-th operand of the " scf.reduce" operation (the value to
802
- be reduced) and the i-th region of the " scf.reduce" operation (the reduction
799
+ ` scf.reduce` terminator operation (see ` scf.reduce` for details). The i-th
800
+ result of an ` scf.parallel` operation is associated with the i-th initial
801
+ value operand, the i-th operand of the ` scf.reduce` operation (the value to
802
+ be reduced) and the i-th region of the ` scf.reduce` operation (the reduction
803
803
function). Consequently, we require that the number of results of an
804
- " scf.parallel" op matches the number of initial values and the the number of
805
- reductions in the " scf.reduce" terminator.
804
+ ` scf.parallel` op matches the number of initial values and the the number of
805
+ reductions in the ` scf.reduce` terminator.
806
806
807
807
The body region must contain exactly one block that terminates with a
808
- " scf.reduce" operation. If an " scf.parallel" op has no reductions, the
809
- terminator has no operands and no regions. The " scf.parallel" parser will
808
+ ` scf.reduce` operation. If an ` scf.parallel` op has no reductions, the
809
+ terminator has no operands and no regions. The ` scf.parallel` parser will
810
810
automatically insert the terminator for ops that have no reductions if it is
811
811
absent.
812
812
@@ -875,25 +875,25 @@ def ReduceOp : SCF_Op<"reduce", [
875
875
DeclareOpInterfaceMethods<RegionBranchTerminatorOpInterface>]> {
876
876
let summary = "reduce operation for scf.parallel";
877
877
let description = [{
878
- " scf.reduce" is the terminator for " scf.parallel" operations. It can model
878
+ The ` scf.reduce` operation is the terminator for ` scf.parallel` operations. It can model
879
879
an arbitrary number of reductions. It has one region per reduction. Each
880
880
region has one block with two arguments which have the same type as the
881
- corresponding operand of " scf.reduce" . The operands of the op are the values
881
+ corresponding operand of ` scf.reduce` . The operands of the op are the values
882
882
that should be reduce; one value per reduction.
883
883
884
884
The i-th reduction (i.e., the i-th region and the i-th operand) corresponds
885
- the i-th initial value and the i-th result of the enclosing " scf.parallel"
885
+ the i-th initial value and the i-th result of the enclosing ` scf.parallel`
886
886
op.
887
887
888
- The " scf.reduce" operation contains regions whose entry blocks expect two
888
+ The ` scf.reduce` operation contains regions whose entry blocks expect two
889
889
arguments of the same type as the corresponding operand. As the iteration
890
890
order of the enclosing parallel loop and hence reduction order is
891
891
unspecified, the results of the reductions may be non-deterministic unless
892
892
the reductions are associative and commutative.
893
893
894
- The result of a reduction region (" scf.reduce.return" operand) must have the
895
- same type as the corresponding " scf.reduce" operand and the corresponding
896
- " scf.parallel" initial value.
894
+ The result of a reduction region (` scf.reduce.return` operand) must have the
895
+ same type as the corresponding ` scf.reduce` operand and the corresponding
896
+ ` scf.parallel` initial value.
897
897
898
898
Example:
899
899
@@ -929,9 +929,9 @@ def ReduceReturnOp :
929
929
SCF_Op<"reduce.return", [HasParent<"ReduceOp">, Pure, Terminator]> {
930
930
let summary = "terminator for reduce operation";
931
931
let description = [{
932
- " scf.reduce.return" is a special terminator operation for the block inside
933
- " scf.reduce" regions. It terminates the region. It should have the same
934
- operand type as the corresponding operand of the enclosing " scf.reduce" op.
932
+ The ` scf.reduce.return` operation is a special terminator operation for the block inside
933
+ ` scf.reduce` regions. It terminates the region. It should have the same
934
+ operand type as the corresponding operand of the enclosing ` scf.reduce` op.
935
935
936
936
Example:
937
937
@@ -1172,12 +1172,12 @@ def YieldOp : SCF_Op<"yield", [Pure, ReturnLike, Terminator,
1172
1172
"WhileOp"]>]> {
1173
1173
let summary = "loop yield and termination operation";
1174
1174
let description = [{
1175
- " scf.yield" yields an SSA value from the SCF dialect op region and
1175
+ The ` scf.yield` operation yields an SSA value from the SCF dialect op region and
1176
1176
terminates the regions. The semantics of how the values are yielded is
1177
1177
defined by the parent operation.
1178
- If " scf.yield" has any operands, the operands must match the parent
1178
+ If ` scf.yield` has any operands, the operands must match the parent
1179
1179
operation's results.
1180
- If the parent operation defines no values, then the " scf.yield" may be
1180
+ If the parent operation defines no values, then the ` scf.yield` may be
1181
1181
left out in the custom syntax and the builders will insert one implicitly.
1182
1182
Otherwise, it has to be present in the syntax to indicate which values are
1183
1183
yielded.
0 commit comments