Skip to content

Factory

This module defines a factory method that creates a compiler function based on an IRBuilder.

The compiler function, that can be generated using the factory, should be used to to compile a certain type of input, based on the front-end that is being used, to IR code. This is the first step of compilation, which is followed by a compilation from IR to the targeted backend.

ir_compiler_factory(builder)

Constructs an IR compiler function for a specific input type by using an IRBuilder.

The factory function uses an IRBuilder[InputType] to create an IR compiler function that converts an input of type InputType and returns a Model. The IR compiler must be named 'compile_to_model' by convention to ensure accessibility to other engines in the framework.

PARAMETER DESCRIPTION
builder

A concrete implementation of the generic class IRBuilder for a particular InputType.

TYPE: IRBuilder[InputType]

RETURNS DESCRIPTION
Callable[[InputType], Model]

A function that compiles an InputType object to the Qadence-IR (Model).
Source code in qadence2_ir/factory.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def ir_compiler_factory(builder: IRBuilder[InputType]) -> Callable[[InputType], Model]:
    """Constructs an IR compiler function for a specific input type by using an `IRBuilder`.

    The factory function uses an `IRBuilder[InputType]` to create an IR compiler function that
    converts an input of type `InputType` and returns a Model. The IR compiler must be named
    'compile_to_model' by convention to ensure accessibility to other engines in the framework.

    Args:
        builder: A concrete implementation of the generic class `IRBuilder` for a particular
            `InputType`.

    Returns:
        A function that compiles an `InputType` object to the Qadence-IR (`Model`).
    """

    def ir_compiler(input_obj: InputType) -> Model:
        register = builder.set_register(input_obj)
        directives = builder.set_directives(input_obj)
        settings = builder.settings(input_obj)

        ast = builder.parse_sequence(input_obj)
        input_variables = extract_inputs_variables(ast)
        instructions = build_instructions(ast)

        return Model(register, input_variables, instructions, directives, settings)

    return ir_compiler