Skip to content

Affine

affine

Affine = Dialect('affine', [ApplyOp, ForOp, ParallelOp, IfOp, StoreOp, LoadOp, MinOp, YieldOp, VectorLoadOp, VectorStoreOp], []) module-attribute

ApplyOp

Bases: IRDLOperation

Source code in xdsl/dialects/affine.py 
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
@irdl_op_definition
class ApplyOp(IRDLOperation):
    name = "affine.apply"

    mapOperands = var_operand_def(IndexType)
    map = prop_def(AffineMapAttr)
    result = result_def(IndexType)

    traits = traits_def(Pure())

    def __init__(self, map_operands: Sequence[SSAValue], affine_map: AffineMapAttr):
        super().__init__(
            operands=[map_operands],
            properties={"map": affine_map},
            result_types=[IndexType()],
        )

    def verify_(self) -> None:
        if len(self.mapOperands) != self.map.data.num_dims + self.map.data.num_symbols:
            raise VerifyException(
                f"{self.name} expects "
                f"{self.map.data.num_dims + self.map.data.num_symbols} operands, but "
                f"got {len(self.mapOperands)}. The number of map operands must match "
                "the sum of the dimensions and symbols of its map."
            )
        if len(self.map.data.results) != 1:
            raise VerifyException("affine.apply expects a unidimensional map.")

    @classmethod
    def parse(cls, parser: Parser) -> ApplyOp:
        pos = parser.pos
        m = parser.parse_attribute()
        if not isinstance(m, AffineMapAttr):
            parser.raise_error("Expected affine map attr", at_position=pos)
        dims = parser.parse_optional_comma_separated_list(
            parser.Delimiter.PAREN, lambda: parser.parse_operand()
        )
        if dims is None:
            dims = []
        syms = parser.parse_optional_comma_separated_list(
            parser.Delimiter.SQUARE, lambda: parser.parse_operand()
        )
        if syms is None:
            syms = []
        return ApplyOp(dims + syms, m)

    def print(self, printer: Printer):
        m = self.map.data
        operands = tuple(self.mapOperands)
        assert len(operands) == m.num_dims + m.num_symbols, f"{len(operands)} {m}"
        printer.print_string(" ")
        printer.print_attribute(self.map)
        printer.print_string(" (")
        if m.num_dims:
            printer.print_list(
                operands[: m.num_dims], lambda el: printer.print_operand(el)
            )
        printer.print_string(")")

        if m.num_symbols:
            printer.print_string("[")
            printer.print_list(
                operands[m.num_dims :], lambda el: printer.print_operand(el)
            )
            printer.print_string("]")

name = 'affine.apply' class-attribute instance-attribute

mapOperands = var_operand_def(IndexType) class-attribute instance-attribute

map = prop_def(AffineMapAttr) class-attribute instance-attribute

result = result_def(IndexType) class-attribute instance-attribute

traits = traits_def(Pure()) class-attribute instance-attribute

__init__(map_operands: Sequence[SSAValue], affine_map: AffineMapAttr)

Source code in xdsl/dialects/affine.py 
77
78
79
80
81
82
def __init__(self, map_operands: Sequence[SSAValue], affine_map: AffineMapAttr):
    super().__init__(
        operands=[map_operands],
        properties={"map": affine_map},
        result_types=[IndexType()],
    )

verify_() -> None

Source code in xdsl/dialects/affine.py 
84
85
86
87
88
89
90
91
92
93
def verify_(self) -> None:
    if len(self.mapOperands) != self.map.data.num_dims + self.map.data.num_symbols:
        raise VerifyException(
            f"{self.name} expects "
            f"{self.map.data.num_dims + self.map.data.num_symbols} operands, but "
            f"got {len(self.mapOperands)}. The number of map operands must match "
            "the sum of the dimensions and symbols of its map."
        )
    if len(self.map.data.results) != 1:
        raise VerifyException("affine.apply expects a unidimensional map.")

parse(parser: Parser) -> ApplyOp classmethod

Source code in xdsl/dialects/affine.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
@classmethod
def parse(cls, parser: Parser) -> ApplyOp:
    pos = parser.pos
    m = parser.parse_attribute()
    if not isinstance(m, AffineMapAttr):
        parser.raise_error("Expected affine map attr", at_position=pos)
    dims = parser.parse_optional_comma_separated_list(
        parser.Delimiter.PAREN, lambda: parser.parse_operand()
    )
    if dims is None:
        dims = []
    syms = parser.parse_optional_comma_separated_list(
        parser.Delimiter.SQUARE, lambda: parser.parse_operand()
    )
    if syms is None:
        syms = []
    return ApplyOp(dims + syms, m)

print(printer: Printer)

Source code in xdsl/dialects/affine.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
def print(self, printer: Printer):
    m = self.map.data
    operands = tuple(self.mapOperands)
    assert len(operands) == m.num_dims + m.num_symbols, f"{len(operands)} {m}"
    printer.print_string(" ")
    printer.print_attribute(self.map)
    printer.print_string(" (")
    if m.num_dims:
        printer.print_list(
            operands[: m.num_dims], lambda el: printer.print_operand(el)
        )
    printer.print_string(")")

    if m.num_symbols:
        printer.print_string("[")
        printer.print_list(
            operands[m.num_dims :], lambda el: printer.print_operand(el)
        )
        printer.print_string("]")

ForOp dataclass

Bases: IRDLOperation

Source code in xdsl/dialects/affine.py 
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
@irdl_op_definition
class ForOp(IRDLOperation):
    name = "affine.for"

    lowerBoundOperands = var_operand_def(IndexType)
    upperBoundOperands = var_operand_def(IndexType)
    inits = var_operand_def()
    res = var_result_def()

    lowerBoundMap = prop_def(AffineMapAttr)
    upperBoundMap = prop_def(AffineMapAttr)
    step = prop_def(IntegerAttr)

    body = region_def()

    irdl_options = (AttrSizedOperandSegments(as_property=True),)

    # TODO this requires the ImplicitAffineTerminator trait instead of
    # NoTerminator
    # gh issue: https://github.com/xdslproject/xdsl/issues/1149

    def verify_(self) -> None:
        if len(self.inits) != len(self.results):
            raise VerifyException("Expected as many init operands as results.")
        if len(self.lowerBoundOperands) != (
            self.lowerBoundMap.data.num_dims + self.lowerBoundMap.data.num_symbols
        ):
            raise VerifyException(
                "Expected as many lower bound operands as lower bound dimensions and symbols."
            )
        if len(self.upperBoundOperands) != (
            self.upperBoundMap.data.num_dims + self.upperBoundMap.data.num_symbols
        ):
            raise VerifyException(
                "Expected as many upper bound operands as upper bound dimensions and symbols."
            )
        iter_types = self.inits.types
        if iter_types != self.result_types:
            raise VerifyException(
                "Expected all operands and result pairs to have matching types"
            )
        entry_block: Block = self.body.blocks[0]
        block_arg_types = (IndexType(), *iter_types)
        arg_types = entry_block.arg_types
        if block_arg_types != arg_types:
            raise VerifyException(
                "Expected BlockArguments to have the same types as the operands"
            )

    @staticmethod
    def from_region(
        lowerBoundOperands: Sequence[Operation | SSAValue],
        upperBoundOperands: Sequence[Operation | SSAValue],
        inits: Sequence[Operation | SSAValue],
        result_types: Sequence[Attribute],
        lower_bound: int | AffineMapAttr,
        upper_bound: int | AffineMapAttr,
        region: Region,
        step: int | IntegerAttr = 1,
    ) -> ForOp:
        if isinstance(lower_bound, int):
            lower_bound = AffineMapAttr(
                AffineMap(0, 0, (AffineExpr.constant(lower_bound),))
            )
        if isinstance(upper_bound, int):
            upper_bound = AffineMapAttr(
                AffineMap(0, 0, (AffineExpr.constant(upper_bound),))
            )
        if isinstance(step, int):
            step = IntegerAttr.from_index_int_value(step)
        properties: dict[str, Attribute] = {
            "lowerBoundMap": lower_bound,
            "upperBoundMap": upper_bound,
            "step": step,
        }
        return ForOp.build(
            operands=[lowerBoundOperands, upperBoundOperands, inits],
            result_types=[result_types],
            properties=properties,
            regions=[region],
        )

    @classmethod
    def parse(cls, parser: Parser) -> Self:
        unresolved_indvar = parser.parse_argument(expect_type=False)
        parser.parse_characters("=")

        lower_bound_map, lower_bound_operands = _parse_affine_for_bound(parser, "max")
        parser.parse_characters("to")
        upper_bound_map, upper_bound_operands = _parse_affine_for_bound(parser, "min")

        if parser.parse_optional_characters("step") is not None:
            step_pos = parser.pos
            step = parser.parse_integer(allow_boolean=False)
            if step < 0:
                parser.raise_error(
                    "expected step to be representable as a positive signed integer",
                    step_pos,
                )
        else:
            step = 1

        unresolved_iter_args: Sequence[Parser.UnresolvedArgument] = ()
        iter_arg_operands: Sequence[SSAValue] = ()
        iter_arg_types: Sequence[Attribute] = ()

        if parser.parse_optional_characters("iter_args") is not None:

            def parse_iter_arg() -> tuple[Parser.UnresolvedArgument, SSAValue]:
                arg = parser.parse_argument(expect_type=False)
                parser.parse_characters("=")
                return arg, parser.parse_operand()

            pairs = parser.parse_comma_separated_list(
                Parser.Delimiter.PAREN, parse_iter_arg
            )
            unresolved_iter_args = tuple(arg for arg, _ in pairs)
            iter_arg_operands = tuple(val for _, val in pairs)
            parser.parse_characters("->")

            # MLIR's `parseArrowTypeList` also accepts a single bare type
            # (no parens) when there is only one loop-carried value.
            if parser.parse_optional_punctuation("(") is not None:
                iter_arg_types = parser.parse_comma_separated_list(
                    Parser.Delimiter.NONE, parser.parse_type
                )
                parser.parse_punctuation(")")
            else:
                iter_arg_types = (parser.parse_type(),)

        iter_args = tuple(
            u_arg.resolve(t) for u_arg, t in zip(unresolved_iter_args, iter_arg_types)
        )
        indvar = unresolved_indvar.resolve(IndexType())
        body = parser.parse_region((indvar, *iter_args))

        # affine.for has no implicit-terminator trait (see TODO above), so the
        # terminator omitted from the printed form when there are no iter_args
        # must be re-inserted by hand here, mirroring `ensureTerminator`
        block = body.block
        if block.last_op is None or not isinstance(block.last_op, YieldOp):
            block.add_op(YieldOp.get())

        attributes = parser.parse_optional_attr_dict()

        for_op = cast(
            Self,
            cls.from_region(
                lower_bound_operands,
                upper_bound_operands,
                iter_arg_operands,
                iter_arg_types,
                lower_bound_map,
                upper_bound_map,
                body,
                step,
            ),
        )
        for_op.attributes |= attributes
        return for_op

    def print(self, printer: Printer):
        printer.print_string(" ")
        indvar, *block_iter_args = self.body.block.args
        printer.print_block_argument(indvar, print_type=False)
        printer.print_string(" = ")

        _print_affine_for_bound(
            printer, self.lowerBoundMap, self.lowerBoundOperands, "max"
        )
        printer.print_string(" to ")
        _print_affine_for_bound(
            printer, self.upperBoundMap, self.upperBoundOperands, "min"
        )

        if self.step.value.data != 1:
            printer.print_string(f" step {self.step.value.data}")

        print_block_terminators = False

        if self.inits:
            printer.print_string(" iter_args")

            with printer.in_parens():
                printer.print_list(
                    zip(block_iter_args, self.inits),
                    lambda pair: print_assignment(printer, *pair),
                )

            printer.print_string(" -> ")

            with printer.in_parens():
                printer.print_list(self.result_types, printer.print_attribute)

            print_block_terminators = True

        printer.print_string(" ")
        printer.print_region(
            self.body,
            print_entry_block_args=False,
            print_empty_block=False,
            print_block_terminators=print_block_terminators,
        )
        printer.print_op_attributes(self.attributes)

name = 'affine.for' class-attribute instance-attribute

lowerBoundOperands = var_operand_def(IndexType) class-attribute instance-attribute

upperBoundOperands = var_operand_def(IndexType) class-attribute instance-attribute

inits = var_operand_def() class-attribute instance-attribute

res = var_result_def() class-attribute instance-attribute

lowerBoundMap = prop_def(AffineMapAttr) class-attribute instance-attribute

upperBoundMap = prop_def(AffineMapAttr) class-attribute instance-attribute

step = prop_def(IntegerAttr) class-attribute instance-attribute

body = region_def() class-attribute instance-attribute

irdl_options = (AttrSizedOperandSegments(as_property=True),) class-attribute instance-attribute

verify_() -> None

Source code in xdsl/dialects/affine.py 
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
def verify_(self) -> None:
    if len(self.inits) != len(self.results):
        raise VerifyException("Expected as many init operands as results.")
    if len(self.lowerBoundOperands) != (
        self.lowerBoundMap.data.num_dims + self.lowerBoundMap.data.num_symbols
    ):
        raise VerifyException(
            "Expected as many lower bound operands as lower bound dimensions and symbols."
        )
    if len(self.upperBoundOperands) != (
        self.upperBoundMap.data.num_dims + self.upperBoundMap.data.num_symbols
    ):
        raise VerifyException(
            "Expected as many upper bound operands as upper bound dimensions and symbols."
        )
    iter_types = self.inits.types
    if iter_types != self.result_types:
        raise VerifyException(
            "Expected all operands and result pairs to have matching types"
        )
    entry_block: Block = self.body.blocks[0]
    block_arg_types = (IndexType(), *iter_types)
    arg_types = entry_block.arg_types
    if block_arg_types != arg_types:
        raise VerifyException(
            "Expected BlockArguments to have the same types as the operands"
        )

from_region(lowerBoundOperands: Sequence[Operation | SSAValue], upperBoundOperands: Sequence[Operation | SSAValue], inits: Sequence[Operation | SSAValue], result_types: Sequence[Attribute], lower_bound: int | AffineMapAttr, upper_bound: int | AffineMapAttr, region: Region, step: int | IntegerAttr = 1) -> ForOp staticmethod

Source code in xdsl/dialects/affine.py 
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
@staticmethod
def from_region(
    lowerBoundOperands: Sequence[Operation | SSAValue],
    upperBoundOperands: Sequence[Operation | SSAValue],
    inits: Sequence[Operation | SSAValue],
    result_types: Sequence[Attribute],
    lower_bound: int | AffineMapAttr,
    upper_bound: int | AffineMapAttr,
    region: Region,
    step: int | IntegerAttr = 1,
) -> ForOp:
    if isinstance(lower_bound, int):
        lower_bound = AffineMapAttr(
            AffineMap(0, 0, (AffineExpr.constant(lower_bound),))
        )
    if isinstance(upper_bound, int):
        upper_bound = AffineMapAttr(
            AffineMap(0, 0, (AffineExpr.constant(upper_bound),))
        )
    if isinstance(step, int):
        step = IntegerAttr.from_index_int_value(step)
    properties: dict[str, Attribute] = {
        "lowerBoundMap": lower_bound,
        "upperBoundMap": upper_bound,
        "step": step,
    }
    return ForOp.build(
        operands=[lowerBoundOperands, upperBoundOperands, inits],
        result_types=[result_types],
        properties=properties,
        regions=[region],
    )

parse(parser: Parser) -> Self classmethod

Source code in xdsl/dialects/affine.py 
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
@classmethod
def parse(cls, parser: Parser) -> Self:
    unresolved_indvar = parser.parse_argument(expect_type=False)
    parser.parse_characters("=")

    lower_bound_map, lower_bound_operands = _parse_affine_for_bound(parser, "max")
    parser.parse_characters("to")
    upper_bound_map, upper_bound_operands = _parse_affine_for_bound(parser, "min")

    if parser.parse_optional_characters("step") is not None:
        step_pos = parser.pos
        step = parser.parse_integer(allow_boolean=False)
        if step < 0:
            parser.raise_error(
                "expected step to be representable as a positive signed integer",
                step_pos,
            )
    else:
        step = 1

    unresolved_iter_args: Sequence[Parser.UnresolvedArgument] = ()
    iter_arg_operands: Sequence[SSAValue] = ()
    iter_arg_types: Sequence[Attribute] = ()

    if parser.parse_optional_characters("iter_args") is not None:

        def parse_iter_arg() -> tuple[Parser.UnresolvedArgument, SSAValue]:
            arg = parser.parse_argument(expect_type=False)
            parser.parse_characters("=")
            return arg, parser.parse_operand()

        pairs = parser.parse_comma_separated_list(
            Parser.Delimiter.PAREN, parse_iter_arg
        )
        unresolved_iter_args = tuple(arg for arg, _ in pairs)
        iter_arg_operands = tuple(val for _, val in pairs)
        parser.parse_characters("->")

        # MLIR's `parseArrowTypeList` also accepts a single bare type
        # (no parens) when there is only one loop-carried value.
        if parser.parse_optional_punctuation("(") is not None:
            iter_arg_types = parser.parse_comma_separated_list(
                Parser.Delimiter.NONE, parser.parse_type
            )
            parser.parse_punctuation(")")
        else:
            iter_arg_types = (parser.parse_type(),)

    iter_args = tuple(
        u_arg.resolve(t) for u_arg, t in zip(unresolved_iter_args, iter_arg_types)
    )
    indvar = unresolved_indvar.resolve(IndexType())
    body = parser.parse_region((indvar, *iter_args))

    # affine.for has no implicit-terminator trait (see TODO above), so the
    # terminator omitted from the printed form when there are no iter_args
    # must be re-inserted by hand here, mirroring `ensureTerminator`
    block = body.block
    if block.last_op is None or not isinstance(block.last_op, YieldOp):
        block.add_op(YieldOp.get())

    attributes = parser.parse_optional_attr_dict()

    for_op = cast(
        Self,
        cls.from_region(
            lower_bound_operands,
            upper_bound_operands,
            iter_arg_operands,
            iter_arg_types,
            lower_bound_map,
            upper_bound_map,
            body,
            step,
        ),
    )
    for_op.attributes |= attributes
    return for_op

print(printer: Printer)

Source code in xdsl/dialects/affine.py 
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
def print(self, printer: Printer):
    printer.print_string(" ")
    indvar, *block_iter_args = self.body.block.args
    printer.print_block_argument(indvar, print_type=False)
    printer.print_string(" = ")

    _print_affine_for_bound(
        printer, self.lowerBoundMap, self.lowerBoundOperands, "max"
    )
    printer.print_string(" to ")
    _print_affine_for_bound(
        printer, self.upperBoundMap, self.upperBoundOperands, "min"
    )

    if self.step.value.data != 1:
        printer.print_string(f" step {self.step.value.data}")

    print_block_terminators = False

    if self.inits:
        printer.print_string(" iter_args")

        with printer.in_parens():
            printer.print_list(
                zip(block_iter_args, self.inits),
                lambda pair: print_assignment(printer, *pair),
            )

        printer.print_string(" -> ")

        with printer.in_parens():
            printer.print_list(self.result_types, printer.print_attribute)

        print_block_terminators = True

    printer.print_string(" ")
    printer.print_region(
        self.body,
        print_entry_block_args=False,
        print_empty_block=False,
        print_block_terminators=print_block_terminators,
    )
    printer.print_op_attributes(self.attributes)

IfOp dataclass

Bases: IRDLOperation

See external documentation.

Source code in xdsl/dialects/affine.py 
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
@irdl_op_definition
class IfOp(IRDLOperation):
    """
    See external [documentation](https://mlir.llvm.org/docs/Dialects/Affine/#affineif-affineaffineifop).
    """

    name = "affine.if"

    args = var_operand_def(IndexType)
    res = var_result_def()

    condition = prop_def(AffineSetAttr)

    then_region = region_def("single_block")
    else_region = region_def()

    traits = traits_def(RecursiveMemoryEffect(), RecursivelySpeculatable())

name = 'affine.if' class-attribute instance-attribute

args = var_operand_def(IndexType) class-attribute instance-attribute

res = var_result_def() class-attribute instance-attribute

condition = prop_def(AffineSetAttr) class-attribute instance-attribute

then_region = region_def('single_block') class-attribute instance-attribute

else_region = region_def() class-attribute instance-attribute

traits = traits_def(RecursiveMemoryEffect(), RecursivelySpeculatable()) class-attribute instance-attribute

ParallelOp dataclass

Bases: IRDLOperation

See external documentation.

Source code in xdsl/dialects/affine.py 
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
@irdl_op_definition
class ParallelOp(IRDLOperation):
    """
    See external [documentation](https://mlir.llvm.org/docs/Dialects/Affine/#affineparallel-affineaffineparallelop).
    """

    name = "affine.parallel"

    map_operands = var_operand_def(IndexType)

    reductions = prop_def(ArrayAttr[StringAttr])
    lowerBoundsMap = prop_def(AffineMapAttr)
    lowerBoundsGroups = prop_def(DenseIntElementsAttr)
    upperBoundsMap = prop_def(AffineMapAttr)
    upperBoundsGroups = prop_def(DenseIntElementsAttr)
    steps = prop_def(ArrayAttr[IntegerAttr[IntegerType]])

    res = var_result_def()

    body = region_def("single_block")

    def verify_(self) -> None:
        if (
            len(self.operands)
            != len(self.results)
            + self.lowerBoundsMap.data.num_dims
            + self.upperBoundsMap.data.num_dims
            + self.lowerBoundsMap.data.num_symbols
            + self.upperBoundsMap.data.num_symbols
        ):
            raise VerifyException(
                "Expected as many operands as results, lower bound args and upper bound args."
            )

        if sum(self.lowerBoundsGroups.get_values()) != len(
            self.lowerBoundsMap.data.results
        ):
            raise VerifyException("Expected a lower bound group for each lower bound")
        if sum(self.upperBoundsGroups.get_values()) != len(
            self.upperBoundsMap.data.results
        ):
            raise VerifyException("Expected an upper bound group for each upper bound")

name = 'affine.parallel' class-attribute instance-attribute

map_operands = var_operand_def(IndexType) class-attribute instance-attribute

reductions = prop_def(ArrayAttr[StringAttr]) class-attribute instance-attribute

lowerBoundsMap = prop_def(AffineMapAttr) class-attribute instance-attribute

lowerBoundsGroups = prop_def(DenseIntElementsAttr) class-attribute instance-attribute

upperBoundsMap = prop_def(AffineMapAttr) class-attribute instance-attribute

upperBoundsGroups = prop_def(DenseIntElementsAttr) class-attribute instance-attribute

steps = prop_def(ArrayAttr[IntegerAttr[IntegerType]]) class-attribute instance-attribute

res = var_result_def() class-attribute instance-attribute

body = region_def('single_block') class-attribute instance-attribute

verify_() -> None

Source code in xdsl/dialects/affine.py 
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
def verify_(self) -> None:
    if (
        len(self.operands)
        != len(self.results)
        + self.lowerBoundsMap.data.num_dims
        + self.upperBoundsMap.data.num_dims
        + self.lowerBoundsMap.data.num_symbols
        + self.upperBoundsMap.data.num_symbols
    ):
        raise VerifyException(
            "Expected as many operands as results, lower bound args and upper bound args."
        )

    if sum(self.lowerBoundsGroups.get_values()) != len(
        self.lowerBoundsMap.data.results
    ):
        raise VerifyException("Expected a lower bound group for each lower bound")
    if sum(self.upperBoundsGroups.get_values()) != len(
        self.upperBoundsMap.data.results
    ):
        raise VerifyException("Expected an upper bound group for each upper bound")

StoreOp

Bases: IRDLOperation

Source code in xdsl/dialects/affine.py 
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
@irdl_op_definition
class StoreOp(IRDLOperation):
    name = "affine.store"

    T: ClassVar = VarConstraint("T", AnyAttr())

    value = operand_def(T)
    memref = operand_def(MemRefType.constr(T))
    indices = var_operand_def(IndexType)
    map = prop_def(AffineMapAttr)

    def __init__(
        self,
        value: SSAValue,
        memref: SSAValue,
        indices: Sequence[SSAValue],
        map: AffineMapAttr | None = None,
    ):
        if map is None:
            if not isa(memref_type := memref.type, MemRefType):
                raise ValueError(
                    "affine.store memref operand must be of type MemRefType"
                )

            map = _map_or_identity_attr(map, memref_type)

        super().__init__(
            operands=(value, memref, indices),
            properties={"map": map},
        )

    @classmethod
    def parse(cls, parser: Parser) -> StoreOp:
        value = parser.parse_unresolved_operand()
        parser.parse_punctuation(",")
        memref, affine_map, indices, memref_type = _parse_affine_memref_access(parser)
        resolved_value = parser.resolve_operand(value, memref_type.get_element_type())
        return StoreOp(resolved_value, memref, indices, AffineMapAttr(affine_map))

    def print(self, printer: Printer):
        printer.print_string(" ")
        printer.print_ssa_value(self.value)
        printer.print_string(", ")

        _print_affine_memref_access(
            printer, self.memref, self.map.data, self.indices, self.memref.type
        )

name = 'affine.store' class-attribute instance-attribute

T: ClassVar = VarConstraint('T', AnyAttr()) class-attribute instance-attribute

value = operand_def(T) class-attribute instance-attribute

memref = operand_def(MemRefType.constr(T)) class-attribute instance-attribute

indices = var_operand_def(IndexType) class-attribute instance-attribute

map = prop_def(AffineMapAttr) class-attribute instance-attribute

__init__(value: SSAValue, memref: SSAValue, indices: Sequence[SSAValue], map: AffineMapAttr | None = None)

Source code in xdsl/dialects/affine.py 
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
def __init__(
    self,
    value: SSAValue,
    memref: SSAValue,
    indices: Sequence[SSAValue],
    map: AffineMapAttr | None = None,
):
    if map is None:
        if not isa(memref_type := memref.type, MemRefType):
            raise ValueError(
                "affine.store memref operand must be of type MemRefType"
            )

        map = _map_or_identity_attr(map, memref_type)

    super().__init__(
        operands=(value, memref, indices),
        properties={"map": map},
    )

parse(parser: Parser) -> StoreOp classmethod

Source code in xdsl/dialects/affine.py 
648
649
650
651
652
653
654
@classmethod
def parse(cls, parser: Parser) -> StoreOp:
    value = parser.parse_unresolved_operand()
    parser.parse_punctuation(",")
    memref, affine_map, indices, memref_type = _parse_affine_memref_access(parser)
    resolved_value = parser.resolve_operand(value, memref_type.get_element_type())
    return StoreOp(resolved_value, memref, indices, AffineMapAttr(affine_map))

print(printer: Printer)

Source code in xdsl/dialects/affine.py 
656
657
658
659
660
661
662
663
def print(self, printer: Printer):
    printer.print_string(" ")
    printer.print_ssa_value(self.value)
    printer.print_string(", ")

    _print_affine_memref_access(
        printer, self.memref, self.map.data, self.indices, self.memref.type
    )

LoadOp

Bases: IRDLOperation

Source code in xdsl/dialects/affine.py 
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
@irdl_op_definition
class LoadOp(IRDLOperation):
    name = "affine.load"

    T: ClassVar = VarConstraint("T", AnyAttr())

    memref = operand_def(MemRefType.constr(T))
    indices = var_operand_def(IndexType)

    result = result_def(T)

    map = prop_def(AffineMapAttr)

    def __init__(
        self,
        memref: SSAValue,
        indices: Sequence[SSAValue],
        map: AffineMapAttr | None = None,
        result_type: Attribute | None = None,
    ):
        if map is None:
            # Create identity map for memrefs with at least one dimension or () -> ()
            # for zero-dimensional memrefs.
            if not isinstance(memref.type, ShapedType):
                raise ValueError(
                    "affine.load memref operand must be of type ShapedType"
                )

            map = _map_or_identity_attr(map, memref.type)

        if result_type is None:
            if not isa(memref.type, ContainerType):
                raise ValueError(
                    "affine.load memref operand must be of type ContainerType"
                )

            result_type = memref.type.get_element_type()

        super().__init__(
            operands=(memref, indices),
            properties={"map": map},
            result_types=(result_type,),
        )

    @classmethod
    def parse(cls, parser: Parser) -> LoadOp:
        memref, affine_map, indices, memref_type = _parse_affine_memref_access(parser)
        result_type = memref_type.get_element_type()

        return LoadOp(memref, indices, AffineMapAttr(affine_map), result_type)

    def print(self, printer: Printer):
        printer.print_string(" ")
        _print_affine_memref_access(
            printer, self.memref, self.map.data, self.indices, self.memref.type
        )

name = 'affine.load' class-attribute instance-attribute

T: ClassVar = VarConstraint('T', AnyAttr()) class-attribute instance-attribute

memref = operand_def(MemRefType.constr(T)) class-attribute instance-attribute

indices = var_operand_def(IndexType) class-attribute instance-attribute

result = result_def(T) class-attribute instance-attribute

map = prop_def(AffineMapAttr) class-attribute instance-attribute

__init__(memref: SSAValue, indices: Sequence[SSAValue], map: AffineMapAttr | None = None, result_type: Attribute | None = None)

Source code in xdsl/dialects/affine.py 
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
def __init__(
    self,
    memref: SSAValue,
    indices: Sequence[SSAValue],
    map: AffineMapAttr | None = None,
    result_type: Attribute | None = None,
):
    if map is None:
        # Create identity map for memrefs with at least one dimension or () -> ()
        # for zero-dimensional memrefs.
        if not isinstance(memref.type, ShapedType):
            raise ValueError(
                "affine.load memref operand must be of type ShapedType"
            )

        map = _map_or_identity_attr(map, memref.type)

    if result_type is None:
        if not isa(memref.type, ContainerType):
            raise ValueError(
                "affine.load memref operand must be of type ContainerType"
            )

        result_type = memref.type.get_element_type()

    super().__init__(
        operands=(memref, indices),
        properties={"map": map},
        result_types=(result_type,),
    )

parse(parser: Parser) -> LoadOp classmethod

Source code in xdsl/dialects/affine.py 
710
711
712
713
714
715
@classmethod
def parse(cls, parser: Parser) -> LoadOp:
    memref, affine_map, indices, memref_type = _parse_affine_memref_access(parser)
    result_type = memref_type.get_element_type()

    return LoadOp(memref, indices, AffineMapAttr(affine_map), result_type)

print(printer: Printer)

Source code in xdsl/dialects/affine.py 
717
718
719
720
721
def print(self, printer: Printer):
    printer.print_string(" ")
    _print_affine_memref_access(
        printer, self.memref, self.map.data, self.indices, self.memref.type
    )

MinOp

Bases: IRDLOperation

Source code in xdsl/dialects/affine.py 
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
@irdl_op_definition
class MinOp(IRDLOperation):
    name = "affine.min"
    arguments = var_operand_def(IndexType())
    result = result_def(IndexType())

    map = prop_def(AffineMapAttr)

    def __init__(
        self,
        map_operands: Sequence[SSAValue | Operation],
        affine_map: AffineMapAttr,
    ):
        super().__init__(
            operands=[map_operands],
            properties={"map": affine_map},
            result_types=[IndexType()],
        )

    def verify_(self) -> None:
        if len(self.operands) != self.map.data.num_dims + self.map.data.num_symbols:
            raise VerifyException(
                f"{self.name} expects "
                f"{self.map.data.num_dims + self.map.data.num_symbols} "
                f"operands, but got {len(self.operands)}. The number of map operands "
                "must match the sum of the dimensions and symbols of its map."
            )

    @classmethod
    def parse(cls, parser: Parser) -> MinOp:
        pos = parser.pos
        m = parser.parse_attribute()
        if not isinstance(m, AffineMapAttr):
            parser.raise_error("Expected affine map attr", at_position=pos)
        dims = parser.parse_optional_comma_separated_list(
            parser.Delimiter.PAREN, lambda: parser.parse_operand()
        )
        if dims is None:
            dims = []
        syms = parser.parse_optional_comma_separated_list(
            parser.Delimiter.SQUARE, lambda: parser.parse_operand()
        )
        if syms is None:
            syms = []
        return MinOp(dims + syms, m)

    def print(self, printer: Printer):
        m = self.map.data
        operands = tuple(self.arguments)
        assert len(operands) == m.num_dims + m.num_symbols, f"{len(operands)} {m}"
        printer.print_string(" ")
        printer.print_attribute(self.map)
        printer.print_string(" (")
        if m.num_dims:
            printer.print_list(
                operands[: m.num_dims], lambda el: printer.print_operand(el)
            )
        printer.print_string(")")

        if m.num_symbols:
            printer.print_string("[")
            printer.print_list(
                operands[m.num_dims :], lambda el: printer.print_operand(el)
            )
            printer.print_string("]")

name = 'affine.min' class-attribute instance-attribute

arguments = var_operand_def(IndexType()) class-attribute instance-attribute

result = result_def(IndexType()) class-attribute instance-attribute

map = prop_def(AffineMapAttr) class-attribute instance-attribute

__init__(map_operands: Sequence[SSAValue | Operation], affine_map: AffineMapAttr)

Source code in xdsl/dialects/affine.py 
732
733
734
735
736
737
738
739
740
741
def __init__(
    self,
    map_operands: Sequence[SSAValue | Operation],
    affine_map: AffineMapAttr,
):
    super().__init__(
        operands=[map_operands],
        properties={"map": affine_map},
        result_types=[IndexType()],
    )

verify_() -> None

Source code in xdsl/dialects/affine.py 
743
744
745
746
747
748
749
750
def verify_(self) -> None:
    if len(self.operands) != self.map.data.num_dims + self.map.data.num_symbols:
        raise VerifyException(
            f"{self.name} expects "
            f"{self.map.data.num_dims + self.map.data.num_symbols} "
            f"operands, but got {len(self.operands)}. The number of map operands "
            "must match the sum of the dimensions and symbols of its map."
        )

parse(parser: Parser) -> MinOp classmethod

Source code in xdsl/dialects/affine.py 
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
@classmethod
def parse(cls, parser: Parser) -> MinOp:
    pos = parser.pos
    m = parser.parse_attribute()
    if not isinstance(m, AffineMapAttr):
        parser.raise_error("Expected affine map attr", at_position=pos)
    dims = parser.parse_optional_comma_separated_list(
        parser.Delimiter.PAREN, lambda: parser.parse_operand()
    )
    if dims is None:
        dims = []
    syms = parser.parse_optional_comma_separated_list(
        parser.Delimiter.SQUARE, lambda: parser.parse_operand()
    )
    if syms is None:
        syms = []
    return MinOp(dims + syms, m)

print(printer: Printer)

Source code in xdsl/dialects/affine.py 
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
def print(self, printer: Printer):
    m = self.map.data
    operands = tuple(self.arguments)
    assert len(operands) == m.num_dims + m.num_symbols, f"{len(operands)} {m}"
    printer.print_string(" ")
    printer.print_attribute(self.map)
    printer.print_string(" (")
    if m.num_dims:
        printer.print_list(
            operands[: m.num_dims], lambda el: printer.print_operand(el)
        )
    printer.print_string(")")

    if m.num_symbols:
        printer.print_string("[")
        printer.print_list(
            operands[m.num_dims :], lambda el: printer.print_operand(el)
        )
        printer.print_string("]")

YieldOp dataclass

Bases: IRDLOperation

Source code in xdsl/dialects/affine.py 
791
792
793
794
795
796
797
798
799
800
801
802
@irdl_op_definition
class YieldOp(IRDLOperation):
    name = "affine.yield"
    arguments = var_operand_def()

    traits = traits_def(IsTerminator(), Pure())

    assembly_format = "attr-dict ($arguments^ `:` type($arguments))?"

    @staticmethod
    def get(*operands: SSAValue | Operation) -> YieldOp:
        return YieldOp.create(operands=[SSAValue.get(operand) for operand in operands])

name = 'affine.yield' class-attribute instance-attribute

arguments = var_operand_def() class-attribute instance-attribute

traits = traits_def(IsTerminator(), Pure()) class-attribute instance-attribute

assembly_format = 'attr-dict ($arguments^ `:` type($arguments))?' class-attribute instance-attribute

get(*operands: SSAValue | Operation) -> YieldOp staticmethod

Source code in xdsl/dialects/affine.py 
800
801
802
@staticmethod
def get(*operands: SSAValue | Operation) -> YieldOp:
    return YieldOp.create(operands=[SSAValue.get(operand) for operand in operands])

VectorLoadOp

Bases: IRDLOperation

Reads a slice from a MemRef into a vector.

See external documentation.

Source code in xdsl/dialects/affine.py 
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
@irdl_op_definition
class VectorLoadOp(IRDLOperation):
    """
    Reads a slice from a MemRef into a vector.

    See [external documentation](https://mlir.llvm.org/docs/Dialects/Affine/#affinevector_load-affineaffinevectorloadop).
    """

    name = "affine.vector_load"

    T: ClassVar = VarConstraint("T", AnyAttr())

    memref = operand_def(MemRefType.constr(T))
    indices = var_operand_def(IndexType)

    result = result_def(VectorType.constr(T))

    map = prop_def(AffineMapAttr)

    def __init__(
        self,
        memref: SSAValue[MemRefType],
        indices: Sequence[SSAValue[IndexType]],
        map: AffineMap | AffineMapAttr | None = None,
        result_type: VectorType | None = None,
    ):
        map = _map_or_identity_attr(map, memref.type)
        result_type = result_type or VectorType(memref.type.get_element_type(), [])

        super().__init__(
            operands=(memref, indices),
            properties={"map": map},
            result_types=[result_type],
        )

    @classmethod
    def parse(cls, parser: Parser) -> VectorLoadOp:
        memref, affine_map, indices, _ = _parse_affine_memref_access(parser)
        parser.parse_punctuation(",")
        result_type = parser.parse_type()

        if not isa(result_type, VectorType):
            parser.raise_error(
                f"Expected {cls.name} to return a {VectorType.name}, "
                + f"but found: {result_type}"
            )

        return VectorLoadOp(memref, indices, AffineMapAttr(affine_map), result_type)

    def print(self, printer: Printer):
        printer.print_string(" ")
        _print_affine_memref_access(
            printer, self.memref, self.map.data, self.indices, self.memref.type
        )
        printer.print_string(", ")
        printer.print_attribute(self.result.type)

name = 'affine.vector_load' class-attribute instance-attribute

T: ClassVar = VarConstraint('T', AnyAttr()) class-attribute instance-attribute

memref = operand_def(MemRefType.constr(T)) class-attribute instance-attribute

indices = var_operand_def(IndexType) class-attribute instance-attribute

result = result_def(VectorType.constr(T)) class-attribute instance-attribute

map = prop_def(AffineMapAttr) class-attribute instance-attribute

__init__(memref: SSAValue[MemRefType], indices: Sequence[SSAValue[IndexType]], map: AffineMap | AffineMapAttr | None = None, result_type: VectorType | None = None)

Source code in xdsl/dialects/affine.py 
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
def __init__(
    self,
    memref: SSAValue[MemRefType],
    indices: Sequence[SSAValue[IndexType]],
    map: AffineMap | AffineMapAttr | None = None,
    result_type: VectorType | None = None,
):
    map = _map_or_identity_attr(map, memref.type)
    result_type = result_type or VectorType(memref.type.get_element_type(), [])

    super().__init__(
        operands=(memref, indices),
        properties={"map": map},
        result_types=[result_type],
    )

parse(parser: Parser) -> VectorLoadOp classmethod

Source code in xdsl/dialects/affine.py 
840
841
842
843
844
845
846
847
848
849
850
851
852
@classmethod
def parse(cls, parser: Parser) -> VectorLoadOp:
    memref, affine_map, indices, _ = _parse_affine_memref_access(parser)
    parser.parse_punctuation(",")
    result_type = parser.parse_type()

    if not isa(result_type, VectorType):
        parser.raise_error(
            f"Expected {cls.name} to return a {VectorType.name}, "
            + f"but found: {result_type}"
        )

    return VectorLoadOp(memref, indices, AffineMapAttr(affine_map), result_type)

print(printer: Printer)

Source code in xdsl/dialects/affine.py 
854
855
856
857
858
859
860
def print(self, printer: Printer):
    printer.print_string(" ")
    _print_affine_memref_access(
        printer, self.memref, self.map.data, self.indices, self.memref.type
    )
    printer.print_string(", ")
    printer.print_attribute(self.result.type)

VectorStoreOp

Bases: IRDLOperation

Writes a vector into a slice within a MemRef.

See external documentation.

Source code in xdsl/dialects/affine.py 
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
@irdl_op_definition
class VectorStoreOp(IRDLOperation):
    """
    Writes a vector into a slice within a MemRef.

    See [external documentation](https://mlir.llvm.org/docs/Dialects/Affine/#affinevector_store-affineaffinevectorstoreop).
    """

    name = "affine.vector_store"

    T: ClassVar = VarConstraint("T", AnyAttr())

    value = operand_def(VectorType.constr(T))
    memref = operand_def(MemRefType.constr(T))
    indices = var_operand_def(IndexType)

    map = prop_def(AffineMapAttr)

    def __init__(
        self,
        value: SSAValue,
        memref: SSAValue[MemRefType],
        indices: Sequence[SSAValue[IndexType]],
        map: AffineMap | AffineMapAttr | None = None,
    ):
        map = _map_or_identity_attr(map, memref.type)

        super().__init__(
            operands=(value, memref, indices),
            properties={"map": map},
        )

    @classmethod
    def parse(cls, parser: Parser) -> VectorStoreOp:
        value = parser.parse_unresolved_operand()
        parser.parse_punctuation(",")
        memref, affine_map, indices, _ = _parse_affine_memref_access(parser)

        parser.parse_punctuation(",")
        value_type = parser.parse_type()

        resolved_value = parser.resolve_operand(value, value_type)
        return VectorStoreOp(resolved_value, memref, indices, AffineMapAttr(affine_map))

    def print(self, printer: Printer):
        printer.print_string(" ")
        printer.print_ssa_value(self.value)
        printer.print_string(", ")

        _print_affine_memref_access(
            printer, self.memref, self.map.data, self.indices, self.memref.type
        )

        printer.print_string(", ")
        printer.print_attribute(self.value.type)

name = 'affine.vector_store' class-attribute instance-attribute

T: ClassVar = VarConstraint('T', AnyAttr()) class-attribute instance-attribute

value = operand_def(VectorType.constr(T)) class-attribute instance-attribute

memref = operand_def(MemRefType.constr(T)) class-attribute instance-attribute

indices = var_operand_def(IndexType) class-attribute instance-attribute

map = prop_def(AffineMapAttr) class-attribute instance-attribute

__init__(value: SSAValue, memref: SSAValue[MemRefType], indices: Sequence[SSAValue[IndexType]], map: AffineMap | AffineMapAttr | None = None)

Source code in xdsl/dialects/affine.py 
881
882
883
884
885
886
887
888
889
890
891
892
893
def __init__(
    self,
    value: SSAValue,
    memref: SSAValue[MemRefType],
    indices: Sequence[SSAValue[IndexType]],
    map: AffineMap | AffineMapAttr | None = None,
):
    map = _map_or_identity_attr(map, memref.type)

    super().__init__(
        operands=(value, memref, indices),
        properties={"map": map},
    )

parse(parser: Parser) -> VectorStoreOp classmethod

Source code in xdsl/dialects/affine.py 
895
896
897
898
899
900
901
902
903
904
905
@classmethod
def parse(cls, parser: Parser) -> VectorStoreOp:
    value = parser.parse_unresolved_operand()
    parser.parse_punctuation(",")
    memref, affine_map, indices, _ = _parse_affine_memref_access(parser)

    parser.parse_punctuation(",")
    value_type = parser.parse_type()

    resolved_value = parser.resolve_operand(value, value_type)
    return VectorStoreOp(resolved_value, memref, indices, AffineMapAttr(affine_map))

print(printer: Printer)

Source code in xdsl/dialects/affine.py 
907
908
909
910
911
912
913
914
915
916
917
def print(self, printer: Printer):
    printer.print_string(" ")
    printer.print_ssa_value(self.value)
    printer.print_string(", ")

    _print_affine_memref_access(
        printer, self.memref, self.map.data, self.indices, self.memref.type
    )

    printer.print_string(", ")
    printer.print_attribute(self.value.type)