jijmodeling 0.10.15__cp310-cp310-win_amd64.whl → 1.11.0__cp310-cp310-win_amd64.whl

jijmodeling/expression/condition.py

@@ -1,362 +0,0 @@
-from __future__ import annotations
-
-import abc as _abc
-import typing as tp
-import uuid
-
-from abc import abstractmethod
-
-import jijmodeling.exceptions.exceptions as _exceptions
-import jijmodeling.expression.expression as _expression
-import jijmodeling.expression.serializable as _serializable
-
-
-class Condition(metaclass=_serializable.Serializable):
-    def __init__(self) -> None:
-        self._uuid = uuid.uuid4().hex
-
-    def __and__(self, other):
-        return AndOperator(self, other)
-
-    def __xor__(self, other):
-        return XorOperator(self, other)
-
-    def __or__(self, other):
-        return OrOperator(self, other)
-
-    @abstractmethod
-    def expressions(self) -> tp.List[_expression.Expression]:
-        pass
-
-    @property
-    def uuid(self) -> str:
-        return self._uuid
-
-
-class NoneCondition(Condition):
-    def expressions(self) -> tp.List[_expression.Expression]:
-        return []
-
-    @classmethod
-    def operation(cls) -> bool:
-        return True
-
-    def _make_latex(self) -> str:
-        """
-        Outputs a latex representation.
-
-        If `self._latex_repr` is not None, it
-        will take precedence. If you want to get the latex representation of
-        child objects in `_default_repr_latex_` of each class, use the method.
-
-        Returns:
-            str: latex representation.
-        """
-        return ""
-
-
-class CompareCondition(Condition, metaclass=_abc.ABCMeta):
-    mark = ""
-
-    def __init__(
-        self,
-        left: tp.Union[_expression.Expression, _expression.NumericValue],
-        right: tp.Union[_expression.Expression, _expression.NumericValue],
-        uuid: tp.Optional[str] = None,
-    ) -> None:
-        _left: _expression.Expression = (
-            left
-            if isinstance(left, _expression.Expression)
-            else _expression.Number(left)
-        )
-        _right: _expression.Expression = (
-            right
-            if isinstance(right, _expression.Expression)
-            else _expression.Number(right)
-        )
-
-        super().__init__()
-        if not _left.is_operatable():
-            raise _exceptions.ModelingError(f"{_left} is not operatable.")
-        if not _right.is_operatable():
-            raise _exceptions.ModelingError(f"{_right} is not operatable.")
-
-        self._left = _left
-        self._right = _right
-        # Set uuid
-        if uuid is not None:
-            self._uuid = uuid
-
-    def __repr__(self) -> str:
-        return str(self.left) + self.mark + str(self.right)
-
-    def _make_latex(self) -> str:
-        """
-        Outputs a latex representation.
-
-        If `self._latex_repr` is not None, it
-        will take precedence. If you want to get the latex representation of
-        child objects in `_default_repr_latex_` of each class, use the method.
-
-        Returns:
-            str: latex representation.
-        """
-        latex_str = r"{} {} {}".format(
-            self.left._make_latex(), self.mark, self.right._make_latex()
-        )
-        return latex_str
-
-    def _repr_latex_(self) -> str:
-        """
-        Latex representation for Jupyter notebook.
-
-        Returns:
-            str: latex string
-        """
-        return f"${self._make_latex()}$"
-
-    @property
-    def left(self) -> _expression.Expression:
-        return self._left
-
-    @property
-    def right(self) -> _expression.Expression:
-        return self._right
-
-    def expressions(self) -> tp.List[_expression.Expression]:
-        return [self.left, self.right]
-
-    @classmethod
-    @abstractmethod
-    def operation(cls, left, right) -> bool:
-        pass
-
-
-class Equal(CompareCondition):
-    mark = "="
-
-    def __init__(
-        self,
-        left: tp.Union[_expression.Expression, _expression.NumericValue],
-        right: tp.Union[_expression.Expression, _expression.NumericValue],
-        uuid: tp.Optional[str] = None,
-    ) -> None:
-        _left = (
-            left
-            if isinstance(left, _expression.Expression)
-            else _expression.Number(left)
-        )
-        _right = (
-            right
-            if isinstance(right, _expression.Expression)
-            else _expression.Number(right)
-        )
-        super().__init__(_left, _right, uuid)
-
-    @classmethod
-    def operation(cls, left: tp.Any, right: tp.Any) -> bool:
-        equal: bool = left == right
-        return equal
-
-
-class NotEqual(CompareCondition):
-    mark = "!="
-
-    def __init__(
-        self,
-        left: tp.Union[_expression.Expression, _expression.NumericValue],
-        right: tp.Union[_expression.Expression, _expression.NumericValue],
-        uuid: tp.Optional[str] = None,
-    ) -> None:
-        super().__init__(left, right, uuid)
-
-    def _make_latex(self) -> str:
-        """
-        Outputs a latex representation.
-
-        If `self._latex_repr` is not None, it
-        will take precedence. If you want to get the latex representation of
-        child objects in `_default_repr_latex_` of each class, use the method.
-
-        Returns:
-            str: latex representation.
-        """
-        latex_str = r"{} \neq {}".format(
-            self.left._make_latex(), self.right._make_latex()
-        )
-        return latex_str
-
-    @classmethod
-    def operation(cls, left, right) -> bool:
-        not_eq: bool = left != right
-        return not_eq
-
-
-class LessThan(CompareCondition):
-    mark = "<"
-
-    def __init__(
-        self,
-        left: tp.Union[_expression.Expression, _expression.NumericValue],
-        right: tp.Union[_expression.Expression, _expression.NumericValue],
-        uuid: tp.Optional[str] = None,
-    ) -> None:
-        super().__init__(left, right, uuid)
-
-    @classmethod
-    def operation(cls, left, right) -> bool:
-        less_than: bool = left < right
-        return less_than
-
-
-class LessThanEqual(CompareCondition):
-    mark = "<="
-
-    def __init__(
-        self,
-        left: tp.Union[_expression.Expression, _expression.NumericValue],
-        right: tp.Union[_expression.Expression, _expression.NumericValue],
-        uuid: tp.Optional[str] = None,
-    ) -> None:
-        super().__init__(left, right, uuid)
-
-    def _make_latex(self) -> str:
-        """
-        Outputs a latex representation.
-
-        If `self._latex_repr` is not None, it
-        will take precedence. If you want to get the latex representation of
-        child objects in `_default_repr_latex_` of each class, use the method.
-
-        Returns:
-            str: latex representation.
-        """
-        latex_str = r"{} \leq {}".format(
-            self.left._make_latex(), self.right._make_latex()
-        )
-        return latex_str
-
-    @classmethod
-    def operation(cls, left, right) -> bool:
-        less_than_eq: bool = left <= right
-        return less_than_eq
-
-
-def equal(left: _expression.Expression, right: _expression.Expression) -> Equal:
-    """
-    Creadion an Equality condition object (Equal).
-
-    The equality operator `==` can also be used to generate an equality condition object.
-    Args:
-        left (Expression): left hand side expression
-        right (Expression): right hand side expression
-
-    Returns:
-        Equal: left `==` right
-    """
-    return Equal(left, right)
-
-
-def eq(left: _expression.Expression, right: _expression.Expression) -> Equal:
-    return equal(left, right)
-
-
-def neq(left: _expression.Expression, right: _expression.Expression) -> NotEqual:
-    """
-    Creadion a Non Equality condition object (NotEqual) The non equality.
-
-    operator `!=` can also be used to generate a non equality condition object.
-
-    Args:
-        left (Expression): left hand side expression
-        right (Expression): right hand side expression
-
-    Returns:
-        NotEqual: left `!=` right
-    """
-    return NotEqual(left, right)
-
-
-class ConditionOperator(Condition, metaclass=_abc.ABCMeta):
-    def __init__(
-        self,
-        left: Condition,
-        right: Condition,
-        uuid: tp.Optional[str] = None,
-    ) -> None:
-        super().__init__()
-        self._left = left
-        self._right = right
-        # Set uuid
-        if uuid is not None:
-            self._uuid = uuid
-
-    @property
-    def left(self) -> Condition:
-        return self._left
-
-    @property
-    def right(self) -> Condition:
-        return self._right
-
-    def expressions(self) -> tp.List[_expression.Expression]:
-        return self.left.expressions() + self.right.expressions()
-
-    @classmethod
-    @abstractmethod
-    def operation(cls, left: bool, right: bool) -> bool:
-        pass
-
-
-class AndOperator(ConditionOperator):
-    def __init__(
-        self,
-        left: Condition,
-        right: Condition,
-        uuid: tp.Optional[str] = None,
-    ) -> None:
-        super().__init__(left, right, uuid)
-
-    @classmethod
-    def operation(cls, left: bool, right: bool) -> bool:
-        and_ope: bool = left & right
-        return and_ope
-
-    def __repr__(self) -> str:
-        return "(" + str(self.left) + ") & (" + str(self.right) + ")"
-
-
-class XorOperator(ConditionOperator):
-    def __init__(
-        self,
-        left: Condition,
-        right: Condition,
-        uuid: tp.Optional[str] = None,
-    ) -> None:
-        super().__init__(left, right, uuid)
-
-    @classmethod
-    def operation(cls, left, right) -> bool:
-        xor: bool = left ^ right
-        return xor
-
-    def __repr__(self) -> str:
-        return str(self.left) + " xor " + str(self.right)
-
-
-class OrOperator(ConditionOperator):
-    def __init__(
-        self,
-        left: Condition,
-        right: Condition,
-        uuid: tp.Optional[str] = None,
-    ) -> None:
-        super().__init__(left, right, uuid)
-
-    @classmethod
-    def operation(cls, left, right) -> bool:
-        or_bool: bool = left | right
-        return or_bool
-
-    def __repr__(self) -> str:
-        return str(self.left) + " | " + str(self.right)

jijmodeling/expression/constraint.py

@@ -1,340 +0,0 @@
-from __future__ import annotations
-
-from typing import List, Optional, Tuple, Union
-
-from typeguard import check_type, typechecked
-
-import jijmodeling.exceptions.exceptions as _exceptions
-import jijmodeling.expression.condition as _condition
-import jijmodeling.expression.expression as _expression
-import jijmodeling.expression.serializable as _serializable
-import jijmodeling.expression.sum as _sum
-import jijmodeling.expression.variables.variable as _variable
-
-
-class Penalty(metaclass=_serializable.Serializable):
-    """
-    Penalty term without constraint.
-
-    Incorporate it into the model as a penalty term. It is not evaluated
-    as a constraint, so it is not used to determine if a solution is
-    feasible. However, it is evaluated separately from the objective
-    function. It is mainly used to include conditions that you want to
-    treat as soft constraints as penalty terms. The penalty class can
-    also be used when you would like to express the constraint as a
-    penalty that you define, rather than one that is automatically
-    changed by QUBO.
-    """
-
-    def __init__(
-        self,
-        label: str,
-        penalty_term: _expression.Expression,
-        forall: Union[
-            _variable.Element,
-            Tuple[_variable.Element, Optional[_condition.Condition]],
-            List[
-                Union[
-                    _variable.Element,
-                    Tuple[_variable.Element, Optional[_condition.Condition]],
-                ]
-            ],
-        ] = [],
-        with_multiplier: bool = True,
-    ):
-        """
-        Initialize
-
-        Args:
-            label (str): label of penalty term
-            penalty_term (Expression): penalty term
-            with_multiplier (bool, optional): with multiplier or not. Defaults to True.
-
-        Examples:
-            ```python
-            >>> import jijmodeling as jm
-            >>> n = jm.Placeholder('n')
-            >>> x = jm.Binary('x', shape=n)
-            >>> pe = jm.Penalty('p', (x[:]-1)**2) # one-hot constraint
-            ```
-        """
-        self._label = label
-        self._penalty_term = penalty_term
-        self._with_multiplier = with_multiplier
-
-        # convert forall to list-type object
-        forall_list = forall if isinstance(forall, list) else [forall]
-        # element type from users
-        IndexType = Union[
-            _variable.Element, Tuple[_variable.Element, Optional[_condition.Condition]]
-        ]
-
-        @typechecked
-        def convert_to_element(
-            index: IndexType,
-        ) -> Tuple[_variable.Element, _condition.Condition]:
-            if isinstance(index, tuple):  # Tuple[ElementType, Condition]
-                elem, cond = index
-                if cond is not None:
-                    return (elem, cond)
-                else:
-                    return (elem, _condition.NoneCondition())
-            else:  # ElementType
-                return (index, _condition.NoneCondition())
-
-        ForallType = List[Tuple[_variable.Element, _condition.Condition]]
-        self._forall: ForallType = [convert_to_element(elem) for elem in forall_list]
-
-        # type validation
-        check_type("self.label", self.label, str)
-        check_type("self._penalty_term", self._penalty_term, _expression.Expression)
-        check_type("self._with_multiplier", self._with_multiplier, bool)
-
-    @property
-    def label(self) -> str:
-        return self._label
-
-    @property
-    def penalty_term(self) -> _expression.Expression:
-        """Penalty term (without multiplier)."""
-        return self._penalty_term
-
-    @property
-    def with_multiplier(self) -> bool:
-        """Penalty term has lagrange muliplier or not."""
-        return self._with_multiplier
-
-    @property
-    def forall(self):
-        return self._forall
-
-    def children(self):
-        return [self.penalty_term]
-
-    def __repr__(self) -> str:
-        return f"Pena({self.label}: {self.penalty_term})"
-
-
-ConstraintConditionType = Union[_condition.Equal, _condition.LessThanEqual]
-ConstraintCondTypeValue = (_condition.Equal, _condition.LessThanEqual)
-
-
-class Constraint(metaclass=_serializable.Serializable):
-    """Constraint of optimization model."""
-
-    def __init__(
-        self,
-        label: str,
-        condition: Union[_expression.Expression, ConstraintConditionType],
-        forall: Union[
-            _variable.Element,
-            Tuple[_variable.Element, Optional[_condition.Condition]],
-            List[
-                Union[
-                    _variable.Element,
-                    Tuple[_variable.Element, Optional[_condition.Condition]],
-                ]
-            ],
-        ] = [],
-        with_penalty: bool = True,
-        with_multiplier: bool = True,
-        left_lower: Union[
-            _expression.NumericValue, _expression.Expression, None
-        ] = None,
-        auto_qubo: Optional[bool] = None,
-    ):
-        """
-        Initialize
-
-        Args:
-            label (str): label of consraint
-            condition (Union[CompareCondition, Expression]): constraint condition.
-            forall (Element | Tuple[Element, Optional[Condition]] | List[Element | Tuple[Element, Optional[Condition]]], optional): forall indices.
-            Defaults to [].
-            with_penalty (bool, optional): Add constraints as penalty. Defaults to True.
-            with_multiplier (bool, optional): prod a multiplier on the penalty term. Defaults to True.
-            left_lower: left hand side lower value. usually used for slack variables
-            auto_qubo: auto qubo convert.
-
-        Examples:
-            ```python
-            >>> import jijmodeling as jm
-            >>> n = jm.Placeholder("n")
-            >>> x = jm.Binary("x", shape=(n, ))
-            >>> term = jm.Constraint("const", x[:] == 1)
-            ```
-
-            constraint with forall
-
-            ```python
-            >>> import jijmodeling as jm
-            >>> d = jm.Placeholder("d", dim=1)
-            >>> n = d.shape[0]
-            >>> x = jm.Binary("x", shape=(n, n))
-            >>> i = jm.Element("i", n)
-            >>> term = jm.Constraint("const2", x[i, :] == 1, forall=(i, d[i] > 0))
-            ```
-
-        Raises:
-            TypeError: condition is not `CompareCondition` or `Experssion`.
-            ExpressionValiddteError: right hand side has a desicision variable.
-            TypeError: `left_lower` is not `numbers.Number` or `Expression`.
-            TypeError: forall is not `Element`, `dict`, `tuple` or `list`.
-            ExpressionIndexError: The indices have not been reduced and remains. Ex: `Sum(i, x[i,j,k]) == 1, forall=[j]`, In this case "k" is needed in forall.
-            ExpressionIndexError: The conditions of indices have inconsistency.
-        """
-
-        self._label = label
-        self._with_penalty = with_penalty
-        self._with_multiplier = with_multiplier
-
-        # auto_qubo setting (automatically disabled if order >= 2 or term is
-        # not a Condition)
-        import jijmodeling.expression.utils as _utils
-
-        if isinstance(condition, ConstraintCondTypeValue):
-            order = max(
-                _utils.get_order(condition.left), _utils.get_order(condition.right)
-            )
-            if order >= 2 and auto_qubo is None:
-                auto_qubo = False
-        elif isinstance(condition, _expression.Expression):
-            if auto_qubo is None:
-                auto_qubo = False
-        else:
-            raise TypeError(
-                "condition of Constraint is <=, == or Expression, not {}.".format(
-                    condition.__class__.__name__
-                )
-            )
-
-        self._auto_qubo: bool = auto_qubo if auto_qubo is not None else True
-
-        # convert Expression to Condition object
-        self._condition: ConstraintConditionType = (
-            condition
-            if isinstance(condition, _condition.CompareCondition)
-            else _condition.Equal(condition, _expression.Number(0))
-        )
-
-        # convert number object to Number object
-        self._left_lower: Optional[_expression.Expression] = (
-            _expression.Number(left_lower)
-            if isinstance(left_lower, (int, float))
-            else left_lower
-        )
-
-        # convert forall to list-type object
-        forall_list = forall if isinstance(forall, list) else [forall]
-        # element type from users
-        IndexType = Union[
-            _variable.Element, Tuple[_variable.Element, Optional[_condition.Condition]]
-        ]
-
-        @typechecked
-        def convert_to_element(
-            index: IndexType,
-        ) -> Tuple[_variable.Element, _condition.Condition]:
-            if isinstance(index, tuple):  # Tuple[ElementType, Condition]
-                elem, cond = index
-                if cond is not None:
-                    return (elem, cond)
-                else:
-                    return (elem, _condition.NoneCondition())
-            else:  # ElementType
-                return (index, _condition.NoneCondition())
-
-        ForallType = List[Tuple[_variable.Element, _condition.Condition]]
-        self._forall: ForallType = [convert_to_element(elem) for elem in forall_list]
-
-        # type validation
-        LeftLowerType = Optional[_expression.Expression]
-        check_type("self.label", self.label, str)
-        check_type("self._condition", self._condition, _condition.CompareCondition)
-        check_type("self._forall", self._forall, ForallType)
-        check_type("self._with_penalty", self._with_penalty, bool)
-        check_type("self._with_multiplier", self._with_multiplier, bool)
-        check_type("self._left_lower", self._left_lower, LeftLowerType)
-        check_type("self._auto_qubo", self._auto_qubo, bool)
-
-        import jijmodeling.expression.extract as _extract
-
-        if isinstance(self._left_lower, _expression.Expression):
-            if _extract.has_decivar(self._left_lower):
-                raise _exceptions.CannotContainDecisionVarError(
-                    "You cannot include decision variables in left_lower."
-                )
-
-        # check forall index reduction
-        indices = _utils.condition_indices(self._condition)
-        forall_labels = [index[0].label for index in self._forall]
-        for index in indices:
-            if index.label not in forall_labels:
-                raise _exceptions.ExpressionIndexError(
-                    "Constraint cannot have unreducted subscripts."
-                    + " Please check your formulation or"
-                    + f" use forall to reduct index '{index.label}'."
-                )
-        # condition index check
-        # 添字に対する条件に入る添字間の依存性に矛盾がないようにする
-        # 例えば [(i, i < j), j] は j が外のループで処理されるので良いが,
-        # [j, (i, i < j)] は jが内側のループで処理されるのでダメ.
-        for i, (_, cond) in enumerate(self._forall):
-            if isinstance(cond, _condition.NoneCondition):
-                continue
-            cond_indices = _utils.condition_indices(cond)
-            for ind in cond_indices:
-                # 条件に含まれている添字が内側のforallに含まれているか確認する
-                if not (ind.label in forall_labels[: i + 1]):
-                    raise _exceptions.ExpressionIndexError(
-                        "Check the conditions you are including in forall. There is a discrepancy in the subscript dependency."
-                    )
-
-    @property
-    def label(self) -> str:
-        return self._label
-
-    @property
-    def condition(self) -> ConstraintConditionType:
-        return self._condition
-
-    @property
-    def term(
-        self,
-    ) -> Union[_condition.Equal, _condition.LessThanEqual, _condition.LessThan]:
-        return self.condition
-
-    @property
-    def with_penalty(self) -> bool:
-        return self._with_penalty
-
-    @property
-    def with_multiplier(self) -> bool:
-        return self._with_multiplier
-
-    @property
-    def forall(self) -> List[Tuple[_variable.Element, _condition.Condition]]:
-        return self._forall
-
-    @property
-    def left_lower(self) -> Optional[_expression.Expression]:
-        return self._left_lower
-
-    @property
-    def auto_qubo(self):
-        return self._auto_qubo
-
-    def _forall_to_sum(self, expression):
-        indices = self.forall[::-1]
-        if indices is None:
-            return expression
-        term = expression
-        for i, index in enumerate(indices):
-            if index is None:
-                return expression
-            cond = indices[i][1]
-            term = _sum.Sum((index[0], cond), term)
-        return term
-
-    def __repr__(self):
-        return "Cons(" + self.label + ")[" + str(self.condition) + "]"