Source code for gamspy._algebra.domain

from __future__ import annotations

from typing import TYPE_CHECKING

import gamspy._algebra.condition as condition
import gamspy.utils as utils
from gamspy.exceptions import ValidationError

if TYPE_CHECKING:
    from gamspy import Alias, Set
    from gamspy._symbols.implicits import ImplicitSet




class Domain:
    """
    Domain class needed for where statements on multidimensional index list
    in operations

    Parameters
    ----------
    sets: tuple[Set | str]

    Examples
    --------
    >>> from gamspy import Container, Set, Ord, Card, Variable, Equation, Sum, Domain
    >>> m = Container()
    >>> X = Set(m, name="X", records=[f"I{i}" for i in range(1, 22)])
    >>> Y = Set(m, name="Y", records=[f"J{j}" for j in range(1, 22)])
    >>> inside = Set(m, name="inside", domain=[X, Y])
    >>> inside[X, Y].where[~((Ord(X) == 1) & (Ord(X) == Card(X)))] = True
    >>> f = Variable(m, name="f", domain=[X, Y], type="positive")
    >>> obj = Variable(m, name="obj")
    >>> objfun = Equation(m, name="objfun", type="regular")
    >>> objfun[...] = obj == Sum(Domain(X, Y).where[inside[X, Y]], f[X.lead(1), Y] - f[X, Y])

    """

    def __init__(self, *sets: tuple[Set | Alias | ImplicitSet]) -> None:
        self._sanity_check(sets)
        self.sets = sets
        self.container = self._find_container()  # type: ignore
        self.where = condition.Condition(self)

    def __repr__(self) -> str:
        return f"Domain(sets={self.sets})"

    def _sanity_check(self, sets: tuple[Set | Alias | ImplicitSet, ...]):
        if len(sets) < 2:
            error_message = (
                f"Domain requires at least 2 sets but found {len(sets)}. "
            )
            if len(sets) == 1:
                error_message += f"You can directly limit the domain with {sets[0].name}.where[<your_limitation>]."
            raise ValidationError(error_message)

        if all(not hasattr(set, "container") for set in sets):
            raise ValidationError(
                "At least one of the sets in the domain must be a Set or Alias"
            )

    def _find_container(self):
        for set in self.sets:
            if hasattr(set, "container"):
                return set.container



    def gamsRepr(self) -> str:
        """
        Representation of this Domain in GAMS language.

        Returns
        -------
        str

        Examples
        --------
        >>> from gamspy import Container, Set, Domain
        >>> m = Container()
        >>> X = Set(m, name="x", records=[f"I{i}" for i in range(1, 22)])
        >>> Y = Set(m, name="y", records=[f"J{j}" for j in range(1, 22)])
        >>> Domain(X, Y).gamsRepr()
        '(x,y)'

        """
        return utils._get_domain_str(self.sets)




    def latexRepr(self) -> str:
        """
        Representation of this Domain in Latex.

        Returns
        -------
        str
        """
        return utils._get_domain_str(self.sets)[1:-1]