classiq 0.37.1__py3-none-any.whl → 0.65.3__py3-none-any.whl

classiq/interface/model/quantum_function_call.py

@@ -1,166 +1,50 @@
-import itertools
-import re
-from typing import Any, Dict, List, Mapping, Optional, Sequence, Set, Union
+from collections.abc import Iterable, Mapping, Sequence
+from typing import (
+    Literal,
+    Optional,
+    Union,
+)
 
 import pydantic
-from pydantic import BaseModel
 
+from classiq.interface.exceptions import ClassiqError, ClassiqValueError
 from classiq.interface.generator.expressions.expression import Expression
-from classiq.interface.generator.function_params import NAME_REGEX
-from classiq.interface.generator.functions import FunctionDeclaration
 from classiq.interface.generator.functions.port_declaration import (
     PortDeclarationDirection,
 )
-from classiq.interface.generator.quantum_function_call import (
-    BAD_CALL_NAME_ERROR_MSG,
-    SUFFIX_MARKER,
-    randomize_suffix,
-)
-from classiq.interface.helpers.custom_pydantic_types import PydanticNonEmptyString
-from classiq.interface.model.bind_operation import BindOperation
 from classiq.interface.model.handle_binding import (
+    ConcreteHandleBinding,
     HandleBinding,
-    SlicedHandleBinding,
-    SubscriptHandleBinding,
-)
-from classiq.interface.model.inplace_binary_operation import InplaceBinaryOperation
-from classiq.interface.model.numeric_reinterpretation import (
-    NumericReinterpretationOperation,
-)
-from classiq.interface.model.operator_synthesis_data import OperatorSynthesisData
-from classiq.interface.model.quantum_expressions.amplitude_loading_operation import (
-    AmplitudeLoadingOperation,
-)
-from classiq.interface.model.quantum_expressions.arithmetic_operation import (
-    ArithmeticOperation,
 )
+from classiq.interface.model.port_declaration import AnonPortDeclaration
 from classiq.interface.model.quantum_function_declaration import (
     QuantumFunctionDeclaration,
-    QuantumOperandDeclaration,
 )
-from classiq.interface.model.quantum_if_operation import QuantumIfOperation
-from classiq.interface.model.quantum_statement import QuantumOperation
-from classiq.interface.model.validation_handle import get_unique_handle_names
-from classiq.interface.model.variable_declaration_statement import (
-    VariableDeclarationStatement,
+from classiq.interface.model.quantum_lambda_function import (
+    OperandIdentifier,
+    QuantumOperand,
 )
+from classiq.interface.model.quantum_statement import HandleMetadata, QuantumOperation
 
-from classiq.exceptions import ClassiqError, ClassiqValueError
-
-
-def _validate_no_duplicated_ports(
-    inputs: Mapping[str, HandleBinding],
-    outputs: Mapping[str, HandleBinding],
-    inouts: Mapping[str, HandleBinding],
-) -> None:
-    inputs_and_inouts = inputs.keys() & inouts.keys()
-    if inputs_and_inouts:
-        raise ClassiqValueError(
-            f"{inputs_and_inouts} are used as ports in both inputs and inouts"
-        )
-
-    outputs_and_inouts = outputs.keys() & inouts.keys()
-    if outputs_and_inouts:
-        raise ClassiqValueError(
-            f"{outputs_and_inouts} are used as ports in both outputs and inouts"
-        )
-
-
-def _validate_no_duplicated_handles(
-    inputs: Mapping[str, HandleBinding],
-    outputs: Mapping[str, HandleBinding],
-    inouts: Mapping[str, HandleBinding],
-) -> None:
-    inputs_and_inouts = get_unique_handle_names(inputs) & get_unique_handle_names(
-        inouts
-    )
-    if inputs_and_inouts:
-        raise ClassiqValueError(
-            f"{inputs_and_inouts} are used as handles in both inputs and inouts"
-        )
-
-    outputs_and_inouts = get_unique_handle_names(outputs) & get_unique_handle_names(
-        inouts
-    )
-    if outputs_and_inouts:
-        raise ClassiqValueError(
-            f"{outputs_and_inouts} are used as handles in both outputs and inouts"
-        )
-
-
-def _validate_no_mixing_sliced_and_whole_handles(
-    inouts: Mapping[str, HandleBinding],
-) -> None:
-    inout_handle_names_to_types = {
-        handle_name: {type(handle) for handle in handles}
-        for handle_name, handles in itertools.groupby(
-            inouts.values(), lambda handle: handle.name
-        )
-    }
-    invalid_handles = [
-        handle
-        for handle, types in inout_handle_names_to_types.items()
-        if len(types) > 1
-    ]
-    if invalid_handles:
-        raise ClassiqValueError(
-            f"Inout handles {', '.join(invalid_handles)} mix sliced and whole handles"
-        )
-
-
-ArgValue = Union[Expression, "QuantumOperand", SlicedHandleBinding, HandleBinding]
-
-
-class OperandIdentifier(BaseModel):
-    name: str
-    index: Expression
+ArgValue = Union[
+    Expression,
+    QuantumOperand,
+    ConcreteHandleBinding,
+]
 
 
 class QuantumFunctionCall(QuantumOperation):
+    kind: Literal["QuantumFunctionCall"]
+
     function: Union[str, OperandIdentifier] = pydantic.Field(
         description="The function that is called"
     )
-    params: Dict[str, Expression] = pydantic.Field(default_factory=dict)
-    release_by_inverse: bool = pydantic.Field(
-        default=False, description="Release zero inputs in inverse call."
-    )
-    should_control: bool = pydantic.Field(
-        default=True,
-        description="False value indicates this call shouldn't be controlled even if the flow is controlled.",
-    )
-    inputs: Dict[str, HandleBinding] = pydantic.Field(
-        default_factory=dict,
-        description="A mapping from the input name to the wire it connects to",
-    )
-    inouts: Dict[
-        str, Union[SlicedHandleBinding, SubscriptHandleBinding, HandleBinding]
-    ] = pydantic.Field(
-        default_factory=dict,
-        description="A mapping from in/out name to the wires that connect to it",
-    )
-    outputs: Dict[str, HandleBinding] = pydantic.Field(
-        default_factory=dict,
-        description="A mapping from the output name to the wire it connects to",
-    )
-    name: PydanticNonEmptyString = pydantic.Field(
-        default=None,
-        description="The name of the function instance. "
-        "If not set, determined automatically.",
-    )
-    operands: Dict[str, "QuantumOperand"] = pydantic.Field(
-        description="Function calls passed to the operator",
-        default_factory=dict,
-    )
-    positional_args: List[ArgValue] = pydantic.Field(default_factory=list)
+    positional_args: list[ArgValue] = pydantic.Field(default_factory=list)
 
     _func_decl: Optional[QuantumFunctionDeclaration] = pydantic.PrivateAttr(
         default=None
     )
 
-    _operator_synthesis_data: OperatorSynthesisData = pydantic.PrivateAttr(
-        default_factory=OperatorSynthesisData
-    )
-
     @property
     def func_decl(self) -> QuantumFunctionDeclaration:
         if self._func_decl is None:
@@ -168,7 +52,7 @@ class QuantumFunctionCall(QuantumOperation):
 
         return self._func_decl
 
-    def set_func_decl(self, fd: Optional[FunctionDeclaration]) -> None:
+    def set_func_decl(self, fd: Optional[QuantumFunctionDeclaration]) -> None:
         if fd is not None and not isinstance(fd, QuantumFunctionDeclaration):
             raise ClassiqValueError(
                 "the declaration of a quantum function call cannot be set to a non-quantum function declaration."
@@ -183,352 +67,152 @@ class QuantumFunctionCall(QuantumOperation):
 
     @property
     def wiring_inputs(self) -> Mapping[str, HandleBinding]:
-        return self.inputs
+        return self._get_pos_port_args_by_direction(PortDeclarationDirection.Input)
 
     @property
-    def wiring_inouts(
-        self,
-    ) -> Mapping[
-        str, Union[SlicedHandleBinding, SubscriptHandleBinding, HandleBinding]
-    ]:
-        return self.inouts
+    def inputs(self) -> Sequence[HandleBinding]:
+        return [
+            handle
+            for _, _, handle in self._get_handles_by_direction(
+                PortDeclarationDirection.Input
+            )
+        ]
 
     @property
-    def wiring_outputs(self) -> Mapping[str, HandleBinding]:
-        return self.outputs
-
-    def get_positional_args(self) -> List[ArgValue]:
-        result: List[ArgValue] = self.positional_args
-        if not result:
-            result = list(self.params.values())
-            result.extend(self.operands.values())
-            result.extend(self.inputs.values())
-            result.extend(self.inouts.values())
-            result.extend(self.outputs.values())
-        return result
-
-    def __eq__(self, other: Any) -> bool:
-        return isinstance(other, QuantumFunctionCall) and self.name == other.name
-
-    def __hash__(self) -> int:
-        return hash(self.name)
-
-    @pydantic.validator("name", pre=True, always=True)
-    def _create_name(cls, name: Optional[str], values: Dict[str, Any]) -> str:
-        """
-        generates a name to a user defined-functions as follows:
-        <function_name>_<SUFFIX_MARKER>_<random_suffix>
-        """
-        if name is not None:
-            match = re.fullmatch(pattern=NAME_REGEX, string=name)
-            if match is None:
-                raise ValueError(BAD_CALL_NAME_ERROR_MSG)
-            return name
-
-        function = values.get("function")
-        if isinstance(function, OperandIdentifier):
-            function = function.name
-
-        suffix = f"{SUFFIX_MARKER}_{randomize_suffix()}"
-        if not function:
-            return name if name else suffix
-        return f"{function}_{suffix}"
+    def readable_inputs(self) -> Sequence[HandleMetadata]:
+        return [
+            HandleMetadata(
+                handle=handle,
+                readable_location=self._get_readable_location(param_idx, param),
+            )
+            for param_idx, param, handle in self._get_handles_by_direction(
+                PortDeclarationDirection.Input
+            )
+        ]
 
     @property
-    def pos_param_args(self) -> Dict[str, Expression]:
-        return dict(
-            zip(
-                self.func_decl.param_decls.keys(),
-                (
-                    param
-                    for param in self.positional_args
-                    if isinstance(param, Expression)
-                ),
-            )
-        )
+    def wiring_inouts(
+        self,
+    ) -> Mapping[str, ConcreteHandleBinding]:
+        return self._get_pos_port_args_by_direction(PortDeclarationDirection.Inout)
 
     @property
-    def pos_operand_args(self) -> Dict[str, "QuantumOperand"]:
-        return dict(
-            zip(
-                self.func_decl.operand_declarations.keys(),
-                (
-                    param
-                    for param in self.positional_args
-                    if not isinstance(param, (Expression, HandleBinding))
-                ),
+    def inouts(self) -> Sequence[HandleBinding]:
+        return [
+            handle
+            for _, _, handle in self._get_handles_by_direction(
+                PortDeclarationDirection.Inout
             )
-        )
+        ]
 
     @property
-    def pos_port_args(self) -> Dict[str, HandleBinding]:
-        return dict(
-            zip(
-                self.func_decl.port_declarations.keys(),
-                (
-                    param
-                    for param in self.positional_args
-                    if isinstance(param, HandleBinding)
-                ),
+    def readable_inouts(self) -> Sequence[HandleMetadata]:
+        return [
+            HandleMetadata(
+                handle=handle,
+                readable_location=self._get_readable_location(param_idx, param),
             )
-        )
-
-    def _update_pos_port_params(self) -> None:
-        for name, port_decl in self.func_decl.port_declarations.items():
-            if port_decl.direction == PortDeclarationDirection.Input:
-                self.inputs[name] = self.pos_port_args[name]
-            elif port_decl.direction == PortDeclarationDirection.Output:
-                self.outputs[name] = self.pos_port_args[name]
-            else:
-                self.inouts[name] = self.pos_port_args[name]
-
-    def _reduce_positional_args_to_keywords(self) -> None:
-        self.params.update(self.pos_param_args)
-        self.operands.update(self.pos_operand_args)
-        self._update_pos_port_params()
-
-    def resolve_function_decl(
-        self,
-        function_dict: Mapping[str, QuantumFunctionDeclaration],
-        check_operands: bool,
-    ) -> None:
-        if self._func_decl is None:
-            func_decl = function_dict.get(self.func_name)
-            if func_decl is None:
-                raise ClassiqValueError(
-                    f"Error resolving function {self.func_name}, the function is not found in included library."
-                )
-            self.set_func_decl(func_decl)
-
-        if self.positional_args:
-            self._reduce_positional_args_to_keywords()
-
-        _check_params_against_declaration(
-            set(self.params.keys()),
-            set(self.func_decl.param_decls.keys()),
-            self.func_decl.name,
-        )
-        _check_ports_against_declaration(self, self.func_decl)
-        _check_params_against_declaration(
-            set(self.operands.keys()),
-            set(self.func_decl.operand_declarations.keys()),
-            self.func_name,
-        )
-        if check_operands:
-            _check_operands_against_declaration(self, self.func_decl, function_dict)
-
-        for name, op in self.operands.items():
-            op_decl = self.func_decl.operand_declarations[name]
-            for qlambda in get_lambda_defs(op):
-                if isinstance(qlambda, QuantumLambdaFunction):
-                    qlambda.set_op_decl(op_decl)
+            for param_idx, param, handle in self._get_handles_by_direction(
+                PortDeclarationDirection.Inout
+            )
+        ]
 
     @property
-    def operator_synthesis_data(self) -> OperatorSynthesisData:
-        return self._operator_synthesis_data
-
-    def set_operator_synthesis_data(
-        self, operator_synthesis_data: OperatorSynthesisData
-    ) -> None:
-        self._operator_synthesis_data = operator_synthesis_data
-
-    @staticmethod
-    def _has_repetitions(name_list: Sequence[str]) -> bool:
-        return len(set(name_list)) < len(name_list)
-
-    @pydantic.root_validator()
-    def validate_handles(cls, values: Dict[str, Any]) -> Dict[str, Any]:
-        inputs = values.get("inputs", dict())
-        outputs = values.get("outputs", dict())
-        inouts = values.get("inouts", dict())
-
-        _validate_no_duplicated_ports(inputs, outputs, inouts)
-        _validate_no_duplicated_handles(inputs, outputs, inouts)
-        _validate_no_mixing_sliced_and_whole_handles(inouts)
-
-        return values
-
-
-ConcreteQuantumStatement = Union[
-    QuantumFunctionCall,
-    ArithmeticOperation,
-    AmplitudeLoadingOperation,
-    VariableDeclarationStatement,
-    BindOperation,
-    NumericReinterpretationOperation,
-    InplaceBinaryOperation,
-    QuantumIfOperation,
-]
-
-
-class QuantumLambdaFunction(BaseModel):
-    """
-    The definition of an anonymous function passed as operand to higher-level functions
-    """
-
-    rename_params: Dict[str, str] = pydantic.Field(
-        default_factory=dict,
-        description="Mapping of the declared param to the actual variable name used ",
-    )
-
-    body: List[ConcreteQuantumStatement] = pydantic.Field(
-        description="A list of function calls passed to the operator"
-    )
-
-    _func_decl: Optional[QuantumOperandDeclaration] = pydantic.PrivateAttr(default=None)
+    def wiring_outputs(self) -> Mapping[str, HandleBinding]:
+        return self._get_pos_port_args_by_direction(PortDeclarationDirection.Output)
 
     @property
-    def func_decl(self) -> Optional[QuantumOperandDeclaration]:
-        return self._func_decl
-
-    def set_op_decl(self, fd: QuantumOperandDeclaration) -> None:
-        self._func_decl = fd
-
-
-class LambdaListComprehension(BaseModel):
-    """
-    Specification of a list of lambda functions iteratively
-    """
-
-    count: Expression = pydantic.Field(
-        description="The number of lambda functions in the list"
-    )
-
-    index_var: str = pydantic.Field(
-        description="The name of the integer variable holding the iteration index"
-    )
-
-    func: QuantumLambdaFunction = pydantic.Field(
-        description="A lambda function definition replicated for index values 0 to count-1"
-    )
-
-
-QuantumCallable = Union[str, QuantumLambdaFunction]
-QuantumOperand = Union[QuantumCallable, List[QuantumCallable], LambdaListComprehension]
-
-QuantumFunctionCall.update_forward_refs()
-QuantumIfOperation.update_forward_refs(QuantumOperand=QuantumOperand)
-
-
-def get_lambda_defs(operand: QuantumOperand) -> List[QuantumCallable]:
-    if isinstance(operand, list):
-        return operand
-    elif isinstance(operand, LambdaListComprehension):
-        return [operand.func]
-    else:
-        return [operand]
-
-
-def _check_ports_against_declaration(
-    call: QuantumFunctionCall, decl: QuantumFunctionDeclaration
-) -> None:
-    call_input_names = set(call.inputs.keys())
-
-    _check_params_against_declaration(
-        call_input_names,
-        decl.ports_by_declaration_direction(PortDeclarationDirection.Input),
-        call.func_name,
-    )
-
-    call_output_names = set(call.outputs.keys())
-
-    _check_params_against_declaration(
-        call_output_names,
-        decl.ports_by_declaration_direction(PortDeclarationDirection.Output),
-        call.func_name,
-    )
-
-    inout_params = set(call.inouts.keys())
-
-    _check_params_against_declaration(
-        inout_params,
-        decl.ports_by_declaration_direction(PortDeclarationDirection.Inout),
-        call.func_name,
-    )
-
-
-def _check_operand_against_declaration(
-    call: QuantumFunctionCall,
-    operand_decl: QuantumOperandDeclaration,
-    operand_argument: QuantumOperand,
-    function_dict: Mapping[str, QuantumFunctionDeclaration],
-    in_list: bool = False,
-) -> None:
-    if isinstance(operand_argument, list):
-        if in_list:
-            raise ClassiqValueError(
-                f"{str(operand_argument)!r} argument to {call.func_decl.name!r} is not "
-                f"a valid operand. Nested operand lists are not permitted"
+    def outputs(self) -> Sequence[HandleBinding]:
+        return [
+            handle
+            for _, _, handle in self._get_handles_by_direction(
+                PortDeclarationDirection.Output
             )
-        for arg in operand_argument:
-            _check_operand_against_declaration(
-                call, operand_decl, arg, function_dict, in_list=True
+        ]
+
+    @property
+    def readable_outputs(self) -> Sequence[HandleMetadata]:
+        return [
+            HandleMetadata(
+                handle=handle,
+                readable_location=self._get_readable_location(param_idx, param),
             )
-        return
-    operand_arg_decl: QuantumFunctionDeclaration
-    if isinstance(operand_argument, str):
-        if operand_argument not in function_dict:
-            raise ClassiqValueError(
-                f"{operand_argument!r} argument to {call.func_decl.name!r} is not a "
-                f"registered function"
+            for param_idx, param, handle in self._get_handles_by_direction(
+                PortDeclarationDirection.Output
             )
-        operand_arg_decl = function_dict[operand_argument]
-    elif isinstance(operand_argument, QuantumLambdaFunction):
-        if operand_argument.func_decl is None:
-            return
-        operand_arg_decl = operand_argument.func_decl
-    elif isinstance(operand_argument, LambdaListComprehension):
-        if operand_argument.func.func_decl is None:
-            return
-        operand_arg_decl = operand_argument.func.func_decl
-    else:
-        raise ClassiqValueError(
-            f"{str(operand_argument)!r} argument to {call.func_decl.name!r} is not a "
-            f"valid operand"
-        )
-    num_arg_parameters = len(operand_arg_decl.get_positional_arg_decls())
-    num_decl_parameters = len(operand_decl.get_positional_arg_decls())
-    if num_arg_parameters != num_decl_parameters:
-        raise ClassiqValueError(
-            f"Signature of argument {operand_argument!r} to {call.func_decl.name!r} "
-            f"does not match the signature of parameter {operand_decl.name!r}. "
-            f"{operand_decl.name!r} accepts {num_decl_parameters} parameters but "
-            f"{operand_argument!r} accepts {num_arg_parameters} parameters"
-        )
+        ]
 
+    @property
+    def params(self) -> list[Expression]:
+        return [
+            param for param in self.positional_args if isinstance(param, Expression)
+        ]
 
-def _check_operands_against_declaration(
-    call: QuantumFunctionCall,
-    decl: QuantumFunctionDeclaration,
-    function_dict: Mapping[str, QuantumFunctionDeclaration],
-) -> None:
-    for operand_parameter, operand_argument in call.operands.items():
-        _check_operand_against_declaration(
-            call,
-            decl.operand_declarations[operand_parameter],
-            operand_argument,
-            function_dict,
-        )
+    @property
+    def params_dict(self) -> dict[str, Expression]:
+        return dict(zip(self.func_decl.param_names, self.params))
 
+    @property
+    def operands(self) -> list["QuantumOperand"]:
+        return [
+            param
+            for param in self.positional_args
+            if not isinstance(param, (Expression, HandleBinding))
+        ]
 
-def _check_params_against_declaration(
-    call_params: Set[str],
-    param_decls: Set[str],
-    callee_name: str,
-) -> None:
-    unknown_params = call_params - param_decls
-    if any(re.match(r"arg\d+", param) for param in unknown_params):
-        error_msg = (
-            f"Unsupported passing of named function {callee_name!r} as an operand."
-            "\nSuggestion: replace the named function with lambda function."
-        )
-    else:
-        error_msg = f"Unknown parameters {unknown_params} in call to {callee_name!r}."
-    if unknown_params:
-        raise ClassiqValueError(error_msg)
+    @property
+    def ports(self) -> list[HandleBinding]:
+        return [
+            param for param in self.positional_args if isinstance(param, HandleBinding)
+        ]
+
+    def _get_handles_by_direction(
+        self, direction: PortDeclarationDirection
+    ) -> list[tuple[int, AnonPortDeclaration, HandleBinding]]:
+        return [
+            (idx, port_decl, handle)
+            for idx, port_decl, handle in self._get_handles_with_declarations()
+            if direction == port_decl.direction
+        ]
+
+    def _get_pos_port_args_by_direction(
+        self, direction: PortDeclarationDirection
+    ) -> dict[str, HandleBinding]:
+        # This is a hack for handles to wires reduction tests,
+        # that initialize function definitions or calls not in the scope of a model,
+        # so there is no function resolution annotation.
+        if self._func_decl is None:
+            return dict()
+        return {
+            port_decl.get_name(): handle
+            for _, port_decl, handle in self._get_handles_with_declarations()
+            if direction == port_decl.direction
+        }
+
+    def _get_handles_with_declarations(
+        self,
+    ) -> Iterable[tuple[int, AnonPortDeclaration, HandleBinding]]:
+        return [
+            (idx, port, handle)
+            for idx, (port, handle) in enumerate(
+                zip(
+                    (port_decl for port_decl in self.func_decl.port_declarations),
+                    (
+                        param
+                        for param in self.positional_args
+                        if isinstance(param, HandleBinding)
+                    ),
+                )
+            )
+        ]
 
-    missing_params = param_decls - call_params
-    if missing_params:
-        raise ClassiqValueError(
-            f"Missing parameters {missing_params} in call to {callee_name!r}."
+    def _get_readable_location(
+        self, param_index: int, param_decl: AnonPortDeclaration
+    ) -> str:
+        param_name = (
+            repr(param_decl.name) if param_decl.name is not None else f"#{param_index}"
+        )
+        param_text = (
+            f" for parameter {param_name}" if len(self.positional_args) > 1 else ""
         )
+        return f"as an argument{param_text} of function {self.func_name!r}"