classiq 0.87.0__py3-none-any.whl → 0.89.0__py3-none-any.whl

classiq/interface/finance/log_normal_model_input.py

@@ -1,40 +0,0 @@
-from typing import Literal
-
-import numpy as np
-import pydantic
-from pydantic import ConfigDict
-
-from classiq.interface.finance.model_input import FinanceModelInput
-
-
-class LogNormalModelInput(FinanceModelInput):
-    kind: Literal["log_normal"] = pydantic.Field(default="log_normal")
-
-    num_qubits: pydantic.PositiveInt = pydantic.Field(
-        description="Number of qubits to represent the probability."
-    )
-    mu: pydantic.NonNegativeFloat = pydantic.Field(
-        description="Mean of the Normal distribution variable X s.t. ln(X) ~ log-normal."
-    )
-    sigma: pydantic.PositiveFloat = pydantic.Field(
-        description="Std of the Normal distribution variable X s.t. ln(X) ~ log-normal."
-    )
-
-    @property
-    def distribution_range(self) -> tuple[float, float]:
-        mean = np.exp(self.mu + self.sigma**2 / 2)
-        variance = (np.exp(self.sigma**2) - 1) * np.exp(2 * self.mu + self.sigma**2)
-        stddev = np.sqrt(variance)
-        low = np.maximum(0, mean - 3 * stddev)
-        high = mean + 3 * stddev
-        return low, high
-
-    @property
-    def num_model_qubits(self) -> int:
-        return self.num_qubits
-
-    @property
-    def num_output_qubits(self) -> int:
-        return self.num_qubits
-
-    model_config = ConfigDict(frozen=True)

classiq/interface/finance/model_input.py

@@ -1,22 +0,0 @@
-import abc
-
-from pydantic import ConfigDict
-
-from classiq.interface.helpers.hashable_pydantic_base_model import (
-    HashablePydanticBaseModel,
-)
-
-
-class FinanceModelInput(HashablePydanticBaseModel):
-    kind: str
-
-    @property
-    def num_output_qubits(self) -> int:
-        return 0
-
-    model_config = ConfigDict(frozen=True)
-
-    @property
-    @abc.abstractmethod
-    def distribution_range(self) -> tuple[float, float]:
-        pass

classiq/interface/generator/application_apis/finance_declarations.py

@@ -1,108 +0,0 @@
-from collections.abc import Mapping
-from enum import Enum
-
-from classiq.interface.generator.expressions.expression import Expression
-from classiq.interface.generator.functions.classical_function_declaration import (
-    ClassicalFunctionDeclaration,
-)
-from classiq.interface.generator.functions.classical_type import Real
-from classiq.interface.generator.functions.port_declaration import (
-    PortDeclarationDirection,
-)
-from classiq.interface.generator.functions.type_modifier import TypeModifier
-from classiq.interface.generator.functions.type_name import Struct
-from classiq.interface.model.classical_parameter_declaration import (
-    ClassicalParameterDeclaration,
-)
-from classiq.interface.model.port_declaration import PortDeclaration
-from classiq.interface.model.quantum_function_declaration import (
-    NamedParamsQuantumFunctionDeclaration,
-)
-from classiq.interface.model.quantum_type import QuantumBit, QuantumBitvector
-
-FUNCTION_PORT_NAME = "func_port"
-OBJECTIVE_PORT_NAME = "obj_port"
-
-
-class FinanceModelType(Enum):
-    LogNormal = "log_normal"
-    Gaussian = "gaussian"
-
-
-FINANCE_FUNCTION_PORT_SIZE_MAPPING: Mapping[FinanceModelType, str] = {
-    FinanceModelType.Gaussian: "get_field(finance_model, 'num_qubits') + get_field(get_field(finance_model, 'rhos'), 'len') + floor(log(sum(get_field(finance_model, 'loss')), 2)) + 1",
-    FinanceModelType.LogNormal: "get_field(finance_model, 'num_qubits')",
-}
-
-
-def _generate_finance_function(
-    finance_model: FinanceModelType,
-) -> NamedParamsQuantumFunctionDeclaration:
-    return NamedParamsQuantumFunctionDeclaration(
-        name=f"{finance_model.value}_finance",
-        positional_arg_declarations=[
-            ClassicalParameterDeclaration(
-                name="finance_model",
-                classical_type=Struct(name=f"{finance_model.name}Model"),
-            ),
-            ClassicalParameterDeclaration(
-                name="finance_function", classical_type=Struct(name="FinanceFunction")
-            ),
-            PortDeclaration(
-                name=FUNCTION_PORT_NAME,
-                quantum_type=QuantumBitvector(
-                    length=Expression(
-                        expr=FINANCE_FUNCTION_PORT_SIZE_MAPPING[finance_model]
-                    )
-                ),
-                direction=PortDeclarationDirection.Inout,
-                type_modifier=TypeModifier.Mutable,
-            ),
-            PortDeclaration(
-                name=OBJECTIVE_PORT_NAME,
-                quantum_type=QuantumBit(),
-                direction=PortDeclarationDirection.Inout,
-                type_modifier=TypeModifier.Mutable,
-            ),
-        ],
-    )
-
-
-LOG_NORMAL_FINANCE_FUNCTION = _generate_finance_function(FinanceModelType.LogNormal)
-
-GAUSSIAN_FINANCE_FUNCTION = _generate_finance_function(FinanceModelType.Gaussian)
-
-LOG_NORMAL_FINANCE_POST_PROCESS = ClassicalFunctionDeclaration(
-    name="log_normal_finance_post_process",
-    positional_parameters=[
-        ClassicalParameterDeclaration(
-            name="finance_model", classical_type=Struct(name="LogNormalModel")
-        ),
-        ClassicalParameterDeclaration(
-            name="estimation_method", classical_type=Struct(name="FinanceFunction")
-        ),
-        ClassicalParameterDeclaration(name="probability", classical_type=Real()),
-    ],
-    return_type=Real(),
-)
-
-GAUSSIAN_FINANCE_POST_PROCESS = ClassicalFunctionDeclaration(
-    name="gaussian_finance_post_process",
-    positional_parameters=[
-        ClassicalParameterDeclaration(
-            name="finance_model", classical_type=Struct(name="GaussianModel")
-        ),
-        ClassicalParameterDeclaration(
-            name="estimation_method", classical_type=Struct(name="FinanceFunction")
-        ),
-        ClassicalParameterDeclaration(name="probability", classical_type=Real()),
-    ],
-    return_type=Real(),
-)
-
-__all__ = [
-    "GAUSSIAN_FINANCE_FUNCTION",
-    "GAUSSIAN_FINANCE_POST_PROCESS",
-    "LOG_NORMAL_FINANCE_FUNCTION",
-    "LOG_NORMAL_FINANCE_POST_PROCESS",
-]

classiq/interface/generator/expressions/enums/finance_functions.py

@@ -1,12 +0,0 @@
-from classiq.interface.generator.types.builtin_enum_declarations import (
-    FinanceFunctionType,
-)
-
-
-def get_finance_function_dict() -> dict[str, "FinanceFunctionType"]:
-    return {
-        "var": FinanceFunctionType.VAR,
-        "expected shortfall": FinanceFunctionType.SHORTFALL,
-        "x**2": FinanceFunctionType.X_SQUARE,
-        "european call option": FinanceFunctionType.EUROPEAN_CALL_OPTION,
-    }

classiq/interface/generator/finance.py

@@ -1,107 +0,0 @@
-from __future__ import annotations
-
-from typing import Union
-
-import pydantic
-
-from classiq.interface.finance.function_input import FinanceFunctionInput
-from classiq.interface.finance.gaussian_model_input import GaussianModelInput
-from classiq.interface.finance.log_normal_model_input import LogNormalModelInput
-from classiq.interface.generator import function_params
-from classiq.interface.generator.arith.register_user_input import RegisterUserInput
-from classiq.interface.generator.function_params import DEFAULT_ZERO_NAME
-
-FUNCTION_INPUT_NAME = "function_in"
-FUNCTION_OUTPUT_NAME = "function_out"
-OBJECTIVE_INPUT_NAME = "objective_in"
-OBJECTIVE_OUTPUT_NAME = "objective_out"
-DEFAULT_POST_INPUT_NAME = "post_function_input"
-
-
-class Finance(function_params.FunctionParams):
-    model: Union[GaussianModelInput, LogNormalModelInput] = pydantic.Field(
-        description="Load a financial model", discriminator="kind"
-    )
-    finance_function: FinanceFunctionInput = pydantic.Field(
-        description="The finance function to solve the model"
-    )
-
-    def _create_ios(self) -> None:
-        finance_model = FinanceModels(model=self.model)
-        # 1 for the objective qubit
-        function_size = sum(
-            reg.size for reg in finance_model._outputs.values() if reg is not None
-        )
-        self._inputs = {
-            FUNCTION_INPUT_NAME: RegisterUserInput(
-                name=FUNCTION_INPUT_NAME, size=function_size
-            ),
-            OBJECTIVE_INPUT_NAME: RegisterUserInput(name=OBJECTIVE_INPUT_NAME, size=1),
-        }
-        self._outputs = {
-            FUNCTION_OUTPUT_NAME: RegisterUserInput(
-                name=FUNCTION_OUTPUT_NAME, size=function_size
-            ),
-            OBJECTIVE_OUTPUT_NAME: RegisterUserInput(
-                name=OBJECTIVE_OUTPUT_NAME, size=1
-            ),
-        }
-
-
-DEFAULT_INPUT_NAME = "in"
-DEFAULT_OUTPUT_NAME = "out"
-DEFAULT_BERNOULLI_OUTPUT_NAME = "bernoulli_random_variables"
-
-
-class FinanceModels(function_params.FunctionParams):
-    model: Union[GaussianModelInput, LogNormalModelInput] = pydantic.Field(
-        description="Load a financial model"
-    )
-
-    def _create_ios(self) -> None:
-        self._outputs = {
-            DEFAULT_OUTPUT_NAME: RegisterUserInput(
-                name=DEFAULT_OUTPUT_NAME, size=self.model.num_output_qubits
-            )
-        }
-        if isinstance(self.model, GaussianModelInput):
-            self._inputs = {
-                DEFAULT_INPUT_NAME: RegisterUserInput(
-                    name=DEFAULT_INPUT_NAME, size=self.model.num_bernoulli_qubits
-                )
-            }
-            self._create_zero_input_registers(
-                {DEFAULT_ZERO_NAME: self.model.num_output_qubits}
-            )
-            self._outputs[DEFAULT_BERNOULLI_OUTPUT_NAME] = RegisterUserInput(
-                name=DEFAULT_BERNOULLI_OUTPUT_NAME,
-                size=self.model.num_bernoulli_qubits,
-            )
-        elif isinstance(self.model, LogNormalModelInput):
-            self._inputs = {
-                DEFAULT_INPUT_NAME: RegisterUserInput(
-                    name=DEFAULT_INPUT_NAME, size=self.model.num_model_qubits
-                )
-            }
-
-
-class FinancePayoff(function_params.FunctionParams):
-    finance_function: FinanceFunctionInput = pydantic.Field(
-        description="The finance function to solve the model"
-    )
-    num_qubits: pydantic.PositiveInt
-    distribution_range: tuple[float, float]
-
-    def _create_ios(self) -> None:
-        self._inputs = {
-            DEFAULT_INPUT_NAME: RegisterUserInput(
-                name=DEFAULT_INPUT_NAME, size=self.num_qubits
-            )
-        }
-        self._create_zero_input_registers({DEFAULT_ZERO_NAME: 1})
-        self._outputs = {
-            DEFAULT_OUTPUT_NAME: RegisterUserInput(name=DEFAULT_OUTPUT_NAME, size=1),
-            DEFAULT_POST_INPUT_NAME: RegisterUserInput(
-                name=DEFAULT_INPUT_NAME, size=self.num_qubits
-            ),
-        }

classiq/qmod/builtins/functions/finance.py

@@ -1,34 +0,0 @@
-from typing import Literal
-
-from classiq.qmod.builtins.structs import (
-    FinanceFunction,
-    GaussianModel,
-    LogNormalModel,
-)
-from classiq.qmod.qfunc import qfunc
-from classiq.qmod.qmod_variable import QArray, QBit
-
-
-@qfunc(external=True)
-def log_normal_finance(
-    finance_model: LogNormalModel,
-    finance_function: FinanceFunction,
-    func_port: QArray[QBit, Literal["get_field(finance_model, 'num_qubits')"]],
-    obj_port: QBit,
-) -> None:
-    pass
-
-
-@qfunc(external=True)
-def gaussian_finance(
-    finance_model: GaussianModel,
-    finance_function: FinanceFunction,
-    func_port: QArray[
-        QBit,
-        Literal[
-            "get_field(finance_model, 'num_qubits') + get_field(get_field(finance_model, 'rhos'), 'len') + floor(log(sum(get_field(finance_model, 'loss')), 2)) + 1"
-        ],
-    ],
-    obj_port: QBit,
-) -> None:
-    pass