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

classiq/interface/generator/arith/endianness.py

@@ -1,4 +1,4 @@
-from classiq._internals.enum_utils import StrEnum
+from classiq.interface.enum_utils import StrEnum
 
 
 class Endianness(StrEnum):

classiq/interface/generator/arith/extremum_operations.py

@@ -1,11 +1,14 @@
 import abc
-from typing import Any, Dict, Iterable
+from collections.abc import Iterable
+from typing import Any
 
 import pydantic
 
-from classiq.interface.generator.arith import argument_utils
+from classiq.interface.exceptions import ClassiqValueError
+from classiq.interface.generator.arith import argument_utils, number_utils
 from classiq.interface.generator.arith.argument_utils import RegisterOrConst
 from classiq.interface.generator.arith.arithmetic_operations import (
+    MODULO_WITH_FRACTION_PLACES_ERROR_MSG,
     ArithmeticOperationParams,
 )
 from classiq.interface.generator.arith.binary_ops import (
@@ -22,16 +25,18 @@ class Extremum(ArithmeticOperationParams):
     left_arg: RegisterOrConst
     right_arg: RegisterOrConst
 
-    @pydantic.root_validator(pre=True)
-    def _validate_one_is_register(cls, values: Dict[str, Any]) -> Dict[str, Any]:
-        left_arg = values.get("left_arg")
-        right_arg = values.get("right_arg")
-        if isinstance(left_arg, Numeric) and isinstance(right_arg, Numeric):
-            raise ValueError("One argument must be a register")
-        if left_arg is right_arg and isinstance(left_arg, pydantic.BaseModel):
-            # In case both arguments refer to the same object, copy it.
-            # This prevents changes performed on one argument from affecting the other.
-            values["right_arg"] = left_arg.copy(deep=True)
+    @pydantic.model_validator(mode="before")
+    @classmethod
+    def _validate_one_is_register(cls, values: Any) -> dict[str, Any]:
+        if isinstance(values, dict):
+            left_arg = values.get("left_arg")
+            right_arg = values.get("right_arg")
+            if isinstance(left_arg, Numeric) and isinstance(right_arg, Numeric):
+                raise ClassiqValueError("One argument must be a register")
+            if left_arg is right_arg and isinstance(left_arg, pydantic.BaseModel):
+                # In case both arguments refer to the same object, copy it.
+                # This prevents changes performed on one argument from affecting the other.
+                values["right_arg"] = left_arg.model_copy(deep=True)
         return values
 
     def _create_ios(self) -> None:
@@ -55,31 +60,77 @@ class Extremum(ArithmeticOperationParams):
     def _bound_calculator(cls, arg1: float, arg2: float) -> float:
         pass
 
+    @staticmethod
+    def _less_qubits_arg(
+        arg1: RegisterOrConst, arg2: RegisterOrConst
+    ) -> RegisterOrConst:
+        if not isinstance(arg1, RegisterArithmeticInfo):
+            return arg1
+        if not isinstance(arg2, RegisterArithmeticInfo):
+            return arg2
+        return arg1 if arg1.size <= arg2.size else arg2
+
+    @classmethod
+    @abc.abstractmethod
+    def preferred_arg(
+        cls, arg1: RegisterOrConst, arg2: RegisterOrConst
+    ) -> RegisterOrConst:
+        pass
+
     def _get_result_register(self) -> RegisterArithmeticInfo:
+        eff_left_arg = argument_utils.limit_fraction_places(
+            self.left_arg, self.machine_precision
+        )
+        eff_right_arg = argument_utils.limit_fraction_places(
+            self.right_arg, self.machine_precision
+        )
+        if argument_utils.arg_bounds_overlap((eff_left_arg, eff_right_arg)):
+            return self._get_general_case_result_register(eff_left_arg, eff_right_arg)
+        return argument_utils.as_arithmetic_info(
+            self.preferred_arg(eff_left_arg, eff_right_arg)
+        )
+
+    def _get_general_case_result_register(
+        self, eff_left_arg: RegisterOrConst, eff_right_arg: RegisterOrConst
+    ) -> RegisterArithmeticInfo:
         integer_part_size = max(
-            argument_utils.integer_part_size(self.left_arg),
-            argument_utils.integer_part_size(self.right_arg),
+            argument_utils.integer_part_size(eff_left_arg),
+            argument_utils.integer_part_size(eff_right_arg),
         )
         fraction_places = max(
-            self._compute_fraction_places(self.left_arg),
-            self._compute_fraction_places(self.right_arg),
+            argument_utils.fraction_places(eff_left_arg),
+            argument_utils.fraction_places(eff_right_arg),
         )
         required_size = integer_part_size + fraction_places
         bounds = (
             self._bound_calculator(
-                argument_utils.lower_bound(self.left_arg),
-                argument_utils.lower_bound(self.right_arg),
+                argument_utils.lower_bound(eff_left_arg),
+                argument_utils.lower_bound(eff_right_arg),
             ),
             self._bound_calculator(
-                argument_utils.upper_bound(self.left_arg),
-                argument_utils.upper_bound(self.right_arg),
+                argument_utils.upper_bound(eff_left_arg),
+                argument_utils.upper_bound(eff_right_arg),
             ),
         )
+        if self.output_size:
+            if fraction_places:
+                raise ValueError(MODULO_WITH_FRACTION_PLACES_ERROR_MSG)
+            max_bounds = RegisterArithmeticInfo.get_maximal_bounds(
+                size=self.output_size, is_signed=False, fraction_places=0
+            )
+            bounds = number_utils.bounds_cut(bounds, max_bounds)
+        size = self.output_size or required_size
+        is_signed = self._include_sign and min(bounds) < 0
         return RegisterArithmeticInfo(
-            size=self.output_size or required_size,
+            size=size,
             fraction_places=fraction_places,
-            is_signed=self._include_sign and min(bounds) < 0,
-            bounds=self._legal_bounds(bounds),
+            is_signed=is_signed,
+            bounds=self._legal_bounds(
+                bounds,
+                RegisterArithmeticInfo.get_maximal_bounds(
+                    size=size, is_signed=is_signed, fraction_places=fraction_places
+                ),
+            ),
         )
 
 
@@ -90,6 +141,17 @@ class Min(Extremum):
     def _bound_calculator(cls, arg1: float, arg2: float) -> float:
         return min(arg1, arg2)
 
+    @classmethod
+    def preferred_arg(
+        cls, arg1: RegisterOrConst, arg2: RegisterOrConst
+    ) -> RegisterOrConst:
+        min1, min2 = min(argument_utils.bounds(arg1)), min(argument_utils.bounds(arg2))
+        if min1 < min2:
+            return arg1
+        if min2 < min1:
+            return arg2
+        return cls._less_qubits_arg(arg1, arg2)
+
 
 class Max(Extremum):
     output_name = "max_value"
@@ -97,3 +159,14 @@ class Max(Extremum):
     @classmethod
     def _bound_calculator(cls, arg1: float, arg2: float) -> float:
         return max(arg1, arg2)
+
+    @classmethod
+    def preferred_arg(
+        cls, arg1: RegisterOrConst, arg2: RegisterOrConst
+    ) -> RegisterOrConst:
+        max1, max2 = max(argument_utils.bounds(arg1)), max(argument_utils.bounds(arg2))
+        if max1 > max2:
+            return arg1
+        if max2 > max1:
+            return arg2
+        return cls._less_qubits_arg(arg1, arg2)

classiq/interface/generator/arith/logical_ops.py

@@ -1,7 +1,10 @@
-from typing import Iterable, List, Optional
+from collections.abc import Iterable
+from typing import Optional
 
 import pydantic
+from pydantic import ConfigDict
 
+from classiq.interface.exceptions import ClassiqValueError
 from classiq.interface.generator.arith.argument_utils import RegisterOrConst
 from classiq.interface.generator.arith.arithmetic_operations import (
     ArithmeticOperationParams,
@@ -15,26 +18,28 @@ def get_arg_name(idx: int) -> str:
 
 
 class LogicalOps(ArithmeticOperationParams):
-    args: List[RegisterOrConst]
+    args: list[RegisterOrConst]
     target: Optional[RegisterArithmeticInfo]
-    _should_invert_node_list: List[str] = pydantic.PrivateAttr(default_factory=list)
+    _should_invert_node_list: list[str] = pydantic.PrivateAttr(default_factory=list)
 
-    def update_should_invert_node_list(self, invert_args: List[str]) -> None:
+    def update_should_invert_node_list(self, invert_args: list[str]) -> None:
         self._should_invert_node_list.extend(invert_args)
 
-    @pydantic.validator("output_size")
+    @pydantic.field_validator("output_size")
+    @classmethod
     def _validate_output_size(cls, output_size: Optional[int]) -> int:
         if output_size is not None and output_size != 1:
-            raise ValueError("logical operation output size must be 1")
+            raise ClassiqValueError("logical operation output size must be 1")
         return 1
 
-    @pydantic.validator("args")
+    @pydantic.field_validator("args")
+    @classmethod
     def _validate_inputs_sizes(
-        cls, arguments: List[RegisterOrConst]
-    ) -> List[RegisterOrConst]:
+        cls, arguments: list[RegisterOrConst]
+    ) -> list[RegisterOrConst]:
         for arg_idx, arg in enumerate(arguments):
             if isinstance(arg, RegisterArithmeticInfo) and not arg.is_boolean_register:
-                raise ValueError(
+                raise ClassiqValueError(
                     f"All inputs to logical and must be of size 1 (at argument #{arg_idx})"
                 )
         return arguments
@@ -63,8 +68,7 @@ class LogicalOps(ArithmeticOperationParams):
     def get_params_inplace_options(self) -> Iterable["LogicalOps"]:
         return ()
 
-    class Config:
-        arbitrary_types_allowed = True
+    model_config = ConfigDict(arbitrary_types_allowed=True)
 
 
 class LogicalAnd(LogicalOps):

classiq/interface/generator/arith/machine_precision.py

@@ -0,0 +1,3 @@
+from typing import Final
+
+DEFAULT_MACHINE_PRECISION: Final[int] = 8

classiq/interface/generator/arith/number_utils.py

@@ -1,7 +1,6 @@
-from typing import Tuple, Union
+from typing import Final, Union
 
-MAXIMAL_MACHINE_PRECISION: int = 20
-MAX_FRACTION_PLACES: int = 8
+MAXIMAL_MACHINE_PRECISION: Final[int] = 20
 
 
 def signed_int_to_unsigned(number: int) -> int:
@@ -13,7 +12,7 @@ def signed_int_to_unsigned(number: int) -> int:
     return number + 2 ** (number.bit_length() + 1 * not_power2)
 
 
-def _binary_to_int(bin_rep: str, is_signed: bool) -> int:
+def binary_to_int(bin_rep: str, is_signed: bool = False) -> int:
     negative_offset: int = -(2 ** len(bin_rep)) * (bin_rep[0] == "1") * is_signed
     return int(bin_rep, 2) + negative_offset
 
@@ -21,19 +20,19 @@ def _binary_to_int(bin_rep: str, is_signed: bool) -> int:
 def binary_to_float(
     bin_rep: str, fraction_part_size: int = 0, is_signed: bool = False
 ) -> float:
-    return _binary_to_int(bin_rep, is_signed) / 2**fraction_part_size
+    return binary_to_int(bin_rep, is_signed) / 2**fraction_part_size
 
 
 def binary_to_float_or_int(
     bin_rep: str, fraction_part_size: int = 0, is_signed: bool = False
 ) -> Union[float, int]:
     if fraction_part_size == 0:
-        return _binary_to_int(bin_rep, is_signed)
+        return binary_to_int(bin_rep, is_signed)
     return binary_to_float(bin_rep, fraction_part_size, is_signed)
 
 
-def _get_fraction_places(*, binary_value: str, machine_precision: int) -> int:
-    fraction_places = machine_precision
+def _get_fraction_places(*, binary_value: str) -> int:
+    fraction_places = MAXIMAL_MACHINE_PRECISION
     for bit in reversed(binary_value):
         if bit == "1" or fraction_places == 0:
             return fraction_places
@@ -41,82 +40,79 @@ def _get_fraction_places(*, binary_value: str, machine_precision: int) -> int:
     return fraction_places
 
 
-def get_int_representation_and_fraction_places(
-    float_value: float, *, machine_precision: int
-) -> Tuple[int, int]:
-    int_val = signed_int_to_unsigned(int(float_value * 2**machine_precision))
+def get_int_representation_and_fraction_places(float_value: float) -> tuple[int, int]:
+    int_val = signed_int_to_unsigned(int(float_value * 2**MAXIMAL_MACHINE_PRECISION))
     if int_val == 0:
         return 0, 0
-    fraction_places = _get_fraction_places(
-        binary_value=bin(int_val)[2:], machine_precision=machine_precision
-    )
-    int_val = int_val >> (machine_precision - fraction_places)
+    fraction_places = _get_fraction_places(binary_value=bin(int_val)[2:])
+    int_val = int_val >> (MAXIMAL_MACHINE_PRECISION - fraction_places)
     return int_val, fraction_places
 
 
-def fraction_places(float_value: float, *, machine_precision: int) -> int:
-    int_val = signed_int_to_unsigned(int(float_value * 2**machine_precision))
+def fraction_places(float_value: float) -> int:
+    int_val = signed_int_to_unsigned(int(float_value * 2**MAXIMAL_MACHINE_PRECISION))
     if int_val == 0:
         return 0
-    return _get_fraction_places(
-        binary_value=bin(int_val)[2:], machine_precision=machine_precision
-    )
+    return _get_fraction_places(binary_value=bin(int_val)[2:])
 
 
 def _bit_length(integer_representation: int) -> int:
     return 1 if integer_representation == 0 else integer_representation.bit_length()
 
 
-def binary_string(
-    float_value: float, *, machine_precision: int = MAXIMAL_MACHINE_PRECISION
-) -> str:
-    int_val, _ = get_int_representation_and_fraction_places(
-        float_value=float_value, machine_precision=machine_precision
-    )
+def binary_string(float_value: float) -> str:
+    int_val, _ = get_int_representation_and_fraction_places(float_value)
     bin_rep = bin(int_val)[2:]
-    size_diff = size(
-        float_value=float_value, machine_precision=machine_precision
-    ) - len(bin_rep)
+    size_diff = size(float_value=float_value) - len(bin_rep)
     extension_bit = "0" if float_value >= 0 else "1"
     return bin_rep[::-1] + extension_bit * size_diff
 
 
 def integer_part_size(float_value: float) -> int:
-    int_val, fraction_places = get_int_representation_and_fraction_places(
-        float_value=float_value, machine_precision=MAXIMAL_MACHINE_PRECISION
-    )
+    int_val, fraction_places = get_int_representation_and_fraction_places(float_value)
     return max(_bit_length(int_val) - fraction_places, 0)
 
 
-def size(float_value: float, *, machine_precision: int) -> int:
-    int_val, fraction_places = get_int_representation_and_fraction_places(
-        float_value=float_value, machine_precision=machine_precision
-    )
+def size(float_value: float) -> int:
+    int_val, fraction_places = get_int_representation_and_fraction_places(float_value)
     return max(_bit_length(int_val), fraction_places)
 
 
+def _is_extra_sign_bit_needed(*, lb: float, ub: float) -> bool:
+    integer_lb = lb * 2 ** fraction_places(lb)
+    max_represented_number = (
+        2 ** (len(binary_string(integer_lb)) - 1) - 1
+    ) / 2 ** fraction_places(lb)
+    return ub > max_represented_number
+
+
 def bounds_to_integer_part_size(lb: float, ub: float) -> int:
     lb, ub = min(lb, ub), max(lb, ub)
     ub_integer_part_size: int = integer_part_size(float_value=ub)
     lb_integer_part_size: int = integer_part_size(float_value=lb)
-    if lb == 0:
+    if lb >= 0:
         return ub_integer_part_size
-    if ub == 0:
+    if ub <= 0:
         return lb_integer_part_size
-    is_extra_bit_needed = lb < 0 < ub and ub_integer_part_size >= lb_integer_part_size
-    return max(ub_integer_part_size + 1 * is_extra_bit_needed, lb_integer_part_size)
+    return max(
+        ub_integer_part_size + 1 * _is_extra_sign_bit_needed(lb=lb, ub=ub),
+        lb_integer_part_size,
+    )
 
 
-def limit_fraction_places(number: float, *, machine_precision: int) -> float:
-    orig_bin_rep = binary_string(number, machine_precision=MAXIMAL_MACHINE_PRECISION)[
-        ::-1
-    ]
-    orig_fractions = fraction_places(
-        number, machine_precision=MAXIMAL_MACHINE_PRECISION
-    )
+def limit_fraction_places(number: float, machine_precision: int) -> float:
+    orig_bin_rep = binary_string(number)[::-1]
+    orig_fractions = fraction_places(number)
+
     removed_fractions = max(orig_fractions - machine_precision, 0)
     return binary_to_float(
         bin_rep=orig_bin_rep[: len(orig_bin_rep) - removed_fractions],
         fraction_part_size=orig_fractions - removed_fractions,
         is_signed=number < 0,
     )
+
+
+def bounds_cut(
+    bounds1: tuple[float, float], bounds2: tuple[float, float]
+) -> tuple[float, float]:
+    return max(min(bounds1), min(bounds2)), min(max(bounds1), max(bounds2))

classiq/interface/generator/arith/register_user_input.py

@@ -1,44 +1,87 @@
-from typing import Any, Dict, Optional
+from typing import Any, Optional
 
 import pydantic
+from pydantic import ConfigDict
+from pydantic_core.core_schema import ValidationInfo
 
+from classiq.interface.exceptions import ClassiqValueError
+from classiq.interface.generator.arith import number_utils
 from classiq.interface.helpers.custom_pydantic_types import PydanticFloatTuple
 from classiq.interface.helpers.hashable_pydantic_base_model import (
     HashablePydanticBaseModel,
 )
 
-from classiq.exceptions import ClassiqValueError
-
 
 class RegisterArithmeticInfo(HashablePydanticBaseModel):
-    size: pydantic.PositiveInt
+    size: pydantic.PositiveInt = pydantic.Field(default=1)
     is_signed: bool = pydantic.Field(default=False)
     fraction_places: pydantic.NonNegativeInt = pydantic.Field(default=0)
-    bounds: PydanticFloatTuple = pydantic.Field(default=None)
+    bypass_bounds_validation: bool = pydantic.Field(default=False)
+    bounds: PydanticFloatTuple = pydantic.Field(
+        default=None,
+        validate_default=True,
+    )
 
-    @pydantic.root_validator(pre=True)
-    def _remove_name(cls, values: Dict[str, Any]) -> Dict[str, Any]:
-        if "name" in values:
-            values.pop("name")
+    @pydantic.model_validator(mode="before")
+    @classmethod
+    def _remove_name(cls, values: Any, info: ValidationInfo) -> dict[str, Any]:
+        if isinstance(values, dict):
+            values = values.copy()
+        elif hasattr(values, "__dict__"):
+            values = values.__dict__.copy()
+        elif values is None and info.data:
+            values = info.data.copy()
+        else:
+            raise ValueError("Unsupported type for removing 'name'.")
+
+        values.pop("name", None)
         return values
 
-    @pydantic.validator("bounds", always=True)
-    def _validate_bounds(
-        cls, bounds: Optional[PydanticFloatTuple], values: Dict[str, Any]
-    ) -> PydanticFloatTuple:
-        if bounds is not None:
-            if min(bounds) < 0:
-                assert values.get("is_signed")
-            return tuple(bounds)  # type: ignore[return-value]
-        size = values.get("size")
-        if not isinstance(size, int):
-            raise ClassiqValueError("RegisterUserInput must have an integer size")
-        is_signed: bool = values.get("is_signed", False)
+    @staticmethod
+    def get_maximal_bounds(
+        *, size: int, is_signed: bool, fraction_places: int
+    ) -> tuple[float, float]:
         lb = 0 if not is_signed else -(2 ** (size - 1))
         ub = 2**size - 1 if not is_signed else 2 ** (size - 1) - 1
-        fraction_factor = float(2 ** -values.get("fraction_places", 0))
+        fraction_factor = float(2**-fraction_places)
         return (lb * fraction_factor, ub * fraction_factor)
 
+    @pydantic.field_validator("bounds", mode="before")
+    @classmethod
+    def _validate_bounds(
+        cls, bounds: Optional[PydanticFloatTuple], info: ValidationInfo
+    ) -> PydanticFloatTuple:
+        size = info.data.get("size")
+        is_signed = info.data.get("is_signed", False)
+        fraction_places = info.data.get("fraction_places", 0)
+        if not isinstance(size, int):
+            raise ClassiqValueError("RegisterArithmeticInfo must have an integer size")
+
+        maximal_bounds = cls.get_maximal_bounds(
+            size=size, is_signed=is_signed, fraction_places=fraction_places
+        )
+        if bounds is None:
+            return maximal_bounds
+
+        trimmed_bounds = (
+            number_utils.limit_fraction_places(min(bounds), fraction_places),
+            number_utils.limit_fraction_places(max(bounds), fraction_places),
+        )
+        if not info.data.get("bypass_bounds_validation", False):
+            assert min(trimmed_bounds) >= min(maximal_bounds), "Illegal bound min"
+            assert max(trimmed_bounds) <= max(maximal_bounds), "Illegal bound max"
+        return trimmed_bounds
+
+    def limit_fraction_places(self, machine_precision: int) -> "RegisterArithmeticInfo":
+        truncated_bits: int = max(self.fraction_places - machine_precision, 0)
+        return RegisterArithmeticInfo(
+            size=self.size - truncated_bits,
+            is_signed=self.is_signed,
+            fraction_places=self.fraction_places - truncated_bits,
+            bounds=self.bounds,
+            bypass_bounds_validation=self.bypass_bounds_validation,
+        )
+
     @property
     def is_boolean_register(self) -> bool:
         return (not self.is_signed) and (self.size == 1) and (self.fraction_places == 0)
@@ -51,8 +94,7 @@ class RegisterArithmeticInfo(HashablePydanticBaseModel):
     def integer_part_size(self) -> pydantic.NonNegativeInt:
         return self.size - self.fraction_places
 
-    class Config:
-        frozen = True
+    model_config = ConfigDict(frozen=True)
 
 
 class RegisterUserInput(RegisterArithmeticInfo):
@@ -62,12 +104,13 @@ class RegisterUserInput(RegisterArithmeticInfo):
         super().__init__(**data)
         self._fields_to_skip_in_hash = frozenset({"name"})
 
-    @pydantic.root_validator(pre=True)
-    def _remove_name(cls, values: Dict[str, Any]) -> Dict[str, Any]:
+    @pydantic.model_validator(mode="before")
+    @classmethod
+    def _remove_name(cls, values: Any, info: ValidationInfo) -> dict[str, Any]:
         return values
 
     def revalued(self, **kwargs: Any) -> "RegisterUserInput":
-        return self.copy(update=kwargs)
+        return self.model_copy(update=kwargs)
 
     @classmethod
     def from_arithmetic_info(