classiq 0.38.0__py3-none-any.whl → 0.39.0__py3-none-any.whl

classiq/interface/generator/functions/{core_lib_declarations/quantum_functions/std_lib_functions.py → builtins/open_lib_functions.py}

@@ -6,6 +6,7 @@ from classiq.interface.model.quantum_function_declaration import (
 
 QFT_STEP = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "qft_step",
     "param_decls": {},
     "port_declarations": {
@@ -21,6 +22,7 @@ QFT_STEP = QuantumFunctionDeclaration.parse_raw(
 
 QFT = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "qft",
     "param_decls": {},
     "port_declarations": {
@@ -36,6 +38,7 @@ QFT = QuantumFunctionDeclaration.parse_raw(
 
 QPE_FLEXIBLE = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "qpe_flexible",
     "param_decls": {},
     "port_declarations": {
@@ -87,6 +90,7 @@ QPE_FLEXIBLE = QuantumFunctionDeclaration.parse_raw(
 
 QPE = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "qpe",
     "param_decls": {},
     "port_declarations": {
@@ -122,34 +126,9 @@ QPE = QuantumFunctionDeclaration.parse_raw(
 }"""
 )
 
-STANDARD_QPE = QuantumFunctionDeclaration.parse_raw(
-    """{
-    "name": "standard_qpe",
-    "param_decls": {
-        "precision": {
-            "kind": "int"
-        }
-    },
-    "port_declarations": {
-        "phase": {
-            "name": "phase",
-            "size": {
-                "expr": "precision"
-            },
-            "direction": "inout"
-        }
-    },
-    "operand_declarations": {
-        "unitary": {
-            "name": "unitary"
-        }
-    },
-    "positional_arg_declarations": []
-}"""
-)
-
 SINGLE_PAULI = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "single_pauli",
     "param_decls": {
         "slope": {
@@ -197,6 +176,7 @@ SINGLE_PAULI = QuantumFunctionDeclaration.parse_raw(
 
 LINEAR_PAULI_ROTATIONS = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "linear_pauli_rotations",
     "param_decls": {
         "bases": {
@@ -235,85 +215,107 @@ LINEAR_PAULI_ROTATIONS = QuantumFunctionDeclaration.parse_raw(
 
 AMPLITUDE_ESTIMATION = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "amplitude_estimation",
-    "param_decls": {
-        "num_phase_qubits": {
-            "kind": "int"
-        },
-        "num_unitary_qubits": {
-            "kind": "int"
-        }
-    },
+    "param_decls": {},
     "port_declarations": {
-        "phase_port": {
-            "name": "phase_port",
+        "phase": {
+            "name": "phase",
             "quantum_type": {
-                "kind": "qnum",
-                "size": {
-                    "expr": "num_phase_qubits"
-                },
-                "is_signed": {
-                    "expr": "False"
-                },
-                "fraction_digits": {
-                    "expr": "num_phase_qubits"
-                }
-            },
-            "size": {
-                "expr": "num_phase_qubits"
+                "kind": "qnum"
             },
-            "direction": "output"
+            "direction": "inout"
         },
-        "unitary_port": {
-            "name": "unitary_port",
-            "size": {
-                "expr": "num_unitary_qubits"
+        "packed_vars": {
+            "name": "packed_vars",
+            "quantum_type": {
+                "length": null,
+                "kind": "qvec"
             },
-            "direction": "output"
+            "direction": "inout"
         }
     },
     "operand_declarations": {
-        "sp_op": {
-            "name": "sp_op",
-            "param_decls": {
-                "num_unitary_qubits": {
-                    "kind": "int"
-                }
-            },
-            "port_declarations": {
-                "spq": {
-                    "name": "spq",
-                    "size": {
-                        "expr": "num_unitary_qubits"
+        "oracle": {
+            "name": "oracle",
+            "positional_arg_declarations": [
+                {
+                    "name": "arg0",
+                    "quantum_type": {
+                        "length": null,
+                        "kind": "qvec"
                     },
                     "direction": "inout"
                 }
-            }
+            ],
+            "is_list": false
         },
-        "oracle_op": {
-            "name": "oracle_op",
-            "param_decls": {
-                "num_unitary_qubits": {
-                    "kind": "int"
-                }
-            },
-            "port_declarations": {
-                "oq": {
-                    "name": "oq",
-                    "size": {
-                        "expr": "num_unitary_qubits"
+        "space_transform": {
+            "name": "space_transform",
+            "positional_arg_declarations": [
+                {
+                    "name": "arg0",
+                    "quantum_type": {
+                        "length": null,
+                        "kind": "qvec"
                     },
                     "direction": "inout"
                 }
-            }
+            ],
+            "is_list": false
         }
     },
-    "positional_arg_declarations": []
+    "positional_arg_declarations": [
+        {
+            "name": "oracle",
+            "positional_arg_declarations": [
+                {
+                    "name": "arg0",
+                    "quantum_type": {
+                        "length": null,
+                        "kind": "qvec"
+                    },
+                    "direction": "inout"
+                }
+            ],
+            "is_list": false
+        },
+        {
+            "name": "space_transform",
+            "positional_arg_declarations": [
+                {
+                    "name": "arg0",
+                    "quantum_type": {
+                        "length": null,
+                        "kind": "qvec"
+                    },
+                    "direction": "inout"
+                }
+            ],
+            "is_list": false
+        },
+        {
+            "name": "phase",
+            "quantum_type": {
+                "kind": "qnum"
+            },
+            "direction": "inout"
+        },
+        {
+            "name": "packed_vars",
+            "quantum_type": {
+                "length": null,
+                "kind": "qvec"
+            },
+            "direction": "inout"
+        }
+    ]
 }"""
 )
 
 PHASE_ORACLE = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "phase_oracle",
     "param_decls": {},
     "port_declarations": {
@@ -385,6 +387,7 @@ PHASE_ORACLE = QuantumFunctionDeclaration.parse_raw(
 
 REFLECT_ABOUT_ZERO = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "reflect_about_zero",
     "param_decls": {},
     "port_declarations": {
@@ -413,6 +416,7 @@ REFLECT_ABOUT_ZERO = QuantumFunctionDeclaration.parse_raw(
 
 GROVER_DIFFUSER = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "grover_diffuser",
     "param_decls": {},
     "port_declarations": {
@@ -470,6 +474,7 @@ GROVER_DIFFUSER = QuantumFunctionDeclaration.parse_raw(
 
 GROVER_OPERATOR = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "grover_operator",
     "param_decls": {},
     "port_declarations": {
@@ -555,6 +560,7 @@ GROVER_OPERATOR = QuantumFunctionDeclaration.parse_raw(
 
 GROVER_SEARCH = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "grover_search",
     "param_decls": {
         "reps": {
@@ -622,6 +628,7 @@ GROVER_SEARCH = QuantumFunctionDeclaration.parse_raw(
 
 HADAMARD_TRANSFORM = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "hadamard_transform",
     "param_decls": {},
     "port_declarations": {
@@ -637,6 +644,7 @@ HADAMARD_TRANSFORM = QuantumFunctionDeclaration.parse_raw(
 
 APPLY_TO_ALL = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "apply_to_all",
     "param_decls": {},
     "port_declarations": {
@@ -665,6 +673,7 @@ APPLY_TO_ALL = QuantumFunctionDeclaration.parse_raw(
 
 ALLOCATE_NUM = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "allocate_num",
     "param_decls": {
         "num_qubits": {
@@ -702,6 +711,7 @@ ALLOCATE_NUM = QuantumFunctionDeclaration.parse_raw(
 
 QAOA_MIXER_LAYER = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "qaoa_mixer_layer",
     "param_decls": {
         "b": {
@@ -721,6 +731,7 @@ QAOA_MIXER_LAYER = QuantumFunctionDeclaration.parse_raw(
 
 QAOA_COST_LAYER = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "qaoa_cost_layer",
     "param_decls": {
         "g": {
@@ -747,6 +758,7 @@ QAOA_COST_LAYER = QuantumFunctionDeclaration.parse_raw(
 
 QAOA_LAYER = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "qaoa_layer",
     "param_decls": {
         "g": {
@@ -776,6 +788,7 @@ QAOA_LAYER = QuantumFunctionDeclaration.parse_raw(
 
 QAOA_INIT = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "qaoa_init",
     "param_decls": {},
     "port_declarations": {
@@ -791,6 +804,7 @@ QAOA_INIT = QuantumFunctionDeclaration.parse_raw(
 
 QAOA_PENALTY = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "qaoa_penalty",
     "param_decls": {
         "num_qubits": {
@@ -826,6 +840,7 @@ QAOA_PENALTY = QuantumFunctionDeclaration.parse_raw(
 
 FULL_HEA = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "full_hea",
     "param_decls": {
         "num_qubits": {
@@ -916,6 +931,7 @@ FULL_HEA = QuantumFunctionDeclaration.parse_raw(
 
 SWAP_TEST = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "swap_test",
     "param_decls": {},
     "port_declarations": {
@@ -974,6 +990,7 @@ SWAP_TEST = QuantumFunctionDeclaration.parse_raw(
 
 PREPARE_GHZ_STATE = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "prepare_ghz_state",
     "param_decls": {
         "size": {
@@ -1012,6 +1029,7 @@ PREPARE_GHZ_STATE = QuantumFunctionDeclaration.parse_raw(
 
 PREPARE_EXPONENTIAL_STATE = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "prepare_exponential_state",
     "param_decls": {
         "rate": {
@@ -1050,6 +1068,7 @@ PREPARE_EXPONENTIAL_STATE = QuantumFunctionDeclaration.parse_raw(
 
 PREPARE_BELL_STATE = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "prepare_bell_state",
     "param_decls": {
         "state_num": {
@@ -1092,6 +1111,7 @@ PREPARE_BELL_STATE = QuantumFunctionDeclaration.parse_raw(
 
 INPLACE_PREPARE_INT = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "inplace_prepare_int",
     "param_decls": {
         "value": {
@@ -1130,6 +1150,7 @@ INPLACE_PREPARE_INT = QuantumFunctionDeclaration.parse_raw(
 
 PREPARE_INT = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "prepare_int",
     "param_decls": {
         "value": {
@@ -1166,6 +1187,7 @@ PREPARE_INT = QuantumFunctionDeclaration.parse_raw(
 
 SWITCH = QuantumFunctionDeclaration.parse_raw(
     """{
+    "source_ref": null,
     "name": "switch",
     "param_decls": {
         "selector": {
@@ -1196,12 +1218,15 @@ SWITCH = QuantumFunctionDeclaration.parse_raw(
 }"""
 )
 
+OPEN_LIB_DECLS = [
+    func for func in vars().values() if isinstance(func, QuantumFunctionDeclaration)
+]
+
 __all__ = [
     "QFT_STEP",
     "QFT",
     "QPE_FLEXIBLE",
     "QPE",
-    "STANDARD_QPE",
     "SINGLE_PAULI",
     "LINEAR_PAULI_ROTATIONS",
     "AMPLITUDE_ESTIMATION",
@@ -1226,4 +1251,5 @@ __all__ = [
     "INPLACE_PREPARE_INT",
     "PREPARE_INT",
     "SWITCH",
+    "OPEN_LIB_DECLS",
 ]

classiq/interface/generator/functions/builtins/quantum_operators.py

@@ -0,0 +1,37 @@
+from typing import Any
+
+from classiq.interface.model.quantum_function_declaration import (
+    QuantumFunctionDeclaration,
+    QuantumOperandDeclaration,
+)
+
+
+def get_single_empty_operand_operator(
+    operator_name: str, **kwargs: Any
+) -> QuantumFunctionDeclaration:
+    operand_field_name = "operand"
+    return QuantumFunctionDeclaration(
+        name=operator_name,
+        operand_declarations={
+            operand_field_name: QuantumOperandDeclaration(name=operand_field_name)
+        },
+        **kwargs,
+    )
+
+
+PERMUTE_OPERATOR = QuantumFunctionDeclaration(
+    name="permute",
+    operand_declarations={
+        "functions": QuantumOperandDeclaration(
+            name="functions",
+            is_list=True,
+        )
+    },
+)
+
+APPLY_OPERATOR = get_single_empty_operand_operator(operator_name="apply")
+
+STD_QMOD_OPERATORS = [
+    PERMUTE_OPERATOR,
+    APPLY_OPERATOR,
+]

classiq/interface/generator/functions/classical_type.py

@@ -6,20 +6,18 @@ from pydantic import Extra, Field
 from sympy import IndexedBase, Symbol
 from typing_extensions import Annotated
 
+from classiq.interface.ast_node import HashableASTNode
 from classiq.interface.generator.expressions.enums.ladder_operator import (
     LadderOperator as LadderOperatorEnum,
 )
 from classiq.interface.generator.expressions.enums.pauli import Pauli as PauliEnum
 from classiq.interface.generator.expressions.expression_types import RuntimeExpression
-from classiq.interface.helpers.hashable_pydantic_base_model import (
-    HashablePydanticBaseModel,
-)
 from classiq.interface.helpers.pydantic_model_helpers import values_with_discriminator
 
 NamedSymbol = Union[IndexedBase, Symbol]
 
 
-class ClassicalType(HashablePydanticBaseModel):
+class ClassicalType(HashableASTNode):
     def as_symbolic(self, name: str) -> Union[NamedSymbol, List[NamedSymbol]]:
         return Symbol(name)
 

classiq/interface/generator/functions/function_declaration.py

@@ -2,12 +2,12 @@ import abc
 from typing import Dict
 
 import pydantic
-from pydantic.main import BaseModel
 
+from classiq.interface.ast_node import ASTNode
 from classiq.interface.generator.functions.classical_type import ConcreteClassicalType
 
 
-class FunctionDeclaration(BaseModel, abc.ABC):
+class FunctionDeclaration(ASTNode, abc.ABC):
     """
     Facilitates the creation of a common function interface object.
     """

classiq/interface/generator/hartree_fock.py

@@ -1,6 +1,12 @@
+from typing import Any, Union
+
 import pydantic
 
-from classiq.interface.chemistry.ground_state_problem import CHEMISTRY_PROBLEMS
+from classiq.interface.chemistry.ground_state_problem import (
+    CHEMISTRY_PROBLEMS,
+    HamiltonianProblem,
+    MoleculeProblem,
+)
 from classiq.interface.generator.chemistry_function_params import (
     ChemistryFunctionParams,
 )
@@ -10,7 +16,9 @@ from classiq.exceptions import ClassiqValueError
 
 class HartreeFock(ChemistryFunctionParams):
     @pydantic.validator("gs_problem")
-    def validate_gs_problem(cls, gs_problem):
+    def validate_gs_problem(
+        cls, gs_problem: Any
+    ) -> Union[MoleculeProblem, HamiltonianProblem]:
         if not isinstance(gs_problem, CHEMISTRY_PROBLEMS):
             raise ClassiqValueError(
                 f"ground state problem must be of type {CHEMISTRY_PROBLEMS}"

classiq/interface/generator/model/classical_main_validator.py

@@ -1,7 +1,7 @@
 import ast
 from typing import Dict, List
 
-from classiq.model.model import DEFAULT_RESULT_NAME
+from classiq.executor import DEFAULT_RESULT_NAME
 
 STANDARD_CMAIN_BODY_LENGTH = 2  # assignment of sample call, save statement
 

classiq/interface/generator/model/model.py

@@ -26,10 +26,10 @@ from classiq.interface.generator.types.struct_declaration import StructDeclarati
 from classiq.interface.helpers.pydantic_model_helpers import nameables_to_dict
 from classiq.interface.helpers.validation_helpers import is_list_unique
 from classiq.interface.helpers.versioned_model import VersionedModel
+from classiq.interface.model.quantum_register import QReg, QRegGenericAlias
 
 from classiq import ForeignFunctionDefinition as SynthesisForeignFunctionDefinition
 from classiq.exceptions import ClassiqValueError
-from classiq.quantum_register import QReg, QRegGenericAlias
 
 MAIN_FUNCTION_NAME = "main"
 CLASSICAL_ENTRY_FUNCTION_NAME = "cmain"

classiq/interface/generator/quantum_function_call.py

@@ -80,7 +80,7 @@ class WirePair(HashablePydanticBaseModel):
     out_wire: WireName
 
 
-SUFFIX_RANDOMIZER = random.Random()
+SUFFIX_RANDOMIZER = random.Random()  # noqa: S311
 
 
 def split_wire_pair_to_wires(

classiq/interface/generator/types/struct_declaration.py

@@ -2,15 +2,13 @@ from typing import Any, ClassVar, Dict, Mapping
 
 import pydantic
 
+from classiq.interface.ast_node import HashableASTNode
 from classiq.interface.generator.functions.classical_type import ConcreteClassicalType
-from classiq.interface.helpers.hashable_pydantic_base_model import (
-    HashablePydanticBaseModel,
-)
 
 from classiq.exceptions import ClassiqValueError
 
 
-class StructDeclaration(HashablePydanticBaseModel):
+class StructDeclaration(HashableASTNode):
     name: str
 
     variables: Dict[str, ConcreteClassicalType] = pydantic.Field(

classiq/interface/model/call_synthesis_data.py

@@ -1,5 +1,5 @@
 import dataclasses
-from typing import Any, List, Mapping
+from typing import Any, Iterator, List, Mapping
 
 from sympy import sympify
 
@@ -61,8 +61,8 @@ class CallSynthesisData(Mapping):
     def __getitem__(self, key: str) -> Any:
         return dataclasses.asdict(self)[key]
 
-    def __iter__(self):
+    def __iter__(self) -> Iterator[str]:
         return iter(dataclasses.asdict(self))
 
-    def __len__(self):
+    def __len__(self) -> int:
         return len(dataclasses.asdict(self))

classiq/interface/model/classical_if.py

@@ -0,0 +1,13 @@
+from typing import TYPE_CHECKING
+
+from classiq.interface.generator.expressions.expression import Expression
+from classiq.interface.model.quantum_statement import QuantumOperation
+
+if TYPE_CHECKING:
+    from classiq.interface.model.statement_block import StatementBlock
+
+
+class ClassicalIf(QuantumOperation):
+    condition: Expression
+    then: "StatementBlock"
+    else_: "StatementBlock"

classiq/interface/model/classical_parameter_declaration.py

@@ -1,8 +1,7 @@
-import pydantic
-
+from classiq.interface.ast_node import ASTNode
 from classiq.interface.generator.functions.classical_type import ConcreteClassicalType
 
 
-class ClassicalParameterDeclaration(pydantic.BaseModel):
+class ClassicalParameterDeclaration(ASTNode):
     name: str
     classical_type: ConcreteClassicalType

classiq/interface/model/control.py

@@ -0,0 +1,16 @@
+from typing import TYPE_CHECKING, Union
+
+from classiq.interface.model.handle_binding import (
+    HandleBinding,
+    SlicedHandleBinding,
+    SubscriptHandleBinding,
+)
+from classiq.interface.model.quantum_statement import QuantumOperation
+
+if TYPE_CHECKING:
+    from classiq.interface.model.statement_block import StatementBlock
+
+
+class Control(QuantumOperation):
+    control: Union[SlicedHandleBinding, SubscriptHandleBinding, HandleBinding]
+    body: "StatementBlock"

classiq/interface/model/handle_binding.py

@@ -1,9 +1,10 @@
-from pydantic import BaseModel, Extra
+from pydantic import Extra
 
+from classiq.interface.ast_node import ASTNode
 from classiq.interface.generator.expressions.expression import Expression
 
 
-class HandleBinding(BaseModel):
+class HandleBinding(ASTNode):
     name: str
 
     class Config:

classiq/interface/model/invert.py

@@ -0,0 +1,10 @@
+from typing import TYPE_CHECKING
+
+from classiq.interface.model.quantum_statement import QuantumOperation
+
+if TYPE_CHECKING:
+    from classiq.interface.model.statement_block import StatementBlock
+
+
+class Invert(QuantumOperation):
+    body: "StatementBlock"

classiq/interface/model/model.py

@@ -3,6 +3,7 @@ from typing import Any, Dict, List, Literal, NewType, Optional, Set
 
 import pydantic
 
+from classiq.interface.ast_node import ASTNode
 from classiq.interface.executor.execution_preferences import ExecutionPreferences
 from classiq.interface.generator.constant import Constant
 from classiq.interface.generator.functions.port_declaration import (
@@ -51,7 +52,7 @@ class VersionedSerializedModel(VersionedModel):
     model: SerializedModel
 
 
-class Model(VersionedModel):
+class Model(VersionedModel, ASTNode):
     """
     All the relevant data for generating quantum circuit in one place.
     """

classiq/interface/model/power.py

@@ -0,0 +1,12 @@
+from typing import TYPE_CHECKING
+
+from classiq.interface.generator.expressions.expression import Expression
+from classiq.interface.model.quantum_statement import QuantumOperation
+
+if TYPE_CHECKING:
+    from classiq.interface.model.statement_block import StatementBlock
+
+
+class Power(QuantumOperation):
+    power: Expression
+    body: "StatementBlock"