Source code for unified_planning.model.parameter

# Copyright 2021-2023 AIPlan4EU project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
"""
This module defines the Parameter class. Both actions and fluents use this class to represent their parameters.
"""


from typing import Optional
from unified_planning.environment import Environment, get_environment
import unified_planning as up




class Parameter:
    """
    Represents an :func:`action parameter <unified_planning.model.Action.parameters>` or a :func:`fluent parameter <unified_planning.model.Fluent.signature>`.
    A `Parameter` has a :func:`name <unified_planning.model.Parameter.name>`, and a :func:`Type <unified_planning.model.Parameter.type>`.

    The Parameter class is immutable.
    """

    def __init__(
        self,
        name: str,
        typename: "up.model.types.Type",
        environment: Optional[Environment] = None,
    ):
        self._name = name
        self._typename = typename
        self._env = get_environment(environment)
        assert self._env.type_manager.has_type(
            typename
        ), "type of parameter does not belong to the same environment given to the parameter"

    def __repr__(self) -> str:
        return f"{str(self.type)} {self.name}"

    def __eq__(self, oth: object) -> bool:
        if isinstance(oth, Parameter):
            return (
                self._name == oth._name
                and self._typename == oth._typename
                and self._env == oth._env
            )
        else:
            return False

    def __hash__(self) -> int:
        return hash(self._name) + hash(self._typename)

    @property
    def name(self) -> str:
        """Returns the `Parameter` `name`."""
        return self._name

    @property
    def type(self) -> "up.model.types.Type":
        """Returns the `Parameter` `type`."""
        return self._typename

    @property
    def environment(self) -> "Environment":
        """Return the `Parameter` `Environment`"""
        return self._env

    #
    # Infix operators
    #

    def __add__(self, right):
        return self._env.expression_manager.Plus(self, right)

    def __radd__(self, left):
        return self._env.expression_manager.Plus(left, self)

    def __sub__(self, right):
        return self._env.expression_manager.Minus(self, right)

    def __rsub__(self, left):
        return self._env.expression_manager.Minus(left, self)

    def __mul__(self, right):
        return self._env.expression_manager.Times(self, right)

    def __rmul__(self, left):
        return self._env.expression_manager.Times(left, self)

    def __truediv__(self, right):
        return self._env.expression_manager.Div(self, right)

    def __rtruediv__(self, left):
        return self._env.expression_manager.Div(left, self)

    def __floordiv__(self, right):
        return self._env.expression_manager.Div(self, right)

    def __rfloordiv__(self, left):
        return self._env.expression_manager.Div(left, self)

    def __gt__(self, right):
        return self._env.expression_manager.GT(self, right)

    def __ge__(self, right):
        return self._env.expression_manager.GE(self, right)

    def __lt__(self, right):
        return self._env.expression_manager.LT(self, right)

    def __le__(self, right):
        return self._env.expression_manager.LE(self, right)

    def __pos__(self):
        return self._env.expression_manager.Plus(0, self)

    def __neg__(self):
        return self._env.expression_manager.Minus(0, self)



    def Equals(self, right):
        return self._env.expression_manager.Equals(self, right)




    def And(self, *other):
        return self._env.expression_manager.And(self, *other)


    def __and__(self, *other):
        return self._env.expression_manager.And(self, *other)

    def __rand__(self, *other):
        return self._env.expression_manager.And(*other, self)



    def Or(self, *other):
        return self._env.expression_manager.Or(self, *other)


    def __or__(self, *other):
        return self._env.expression_manager.Or(self, *other)

    def __ror__(self, *other):
        return self._env.expression_manager.Or(*other, self)



    def Not(self):
        return self._env.expression_manager.Not(self)


    def __invert__(self):
        return self._env.expression_manager.Not(self)



    def Xor(self, *other):
        em = self._env.expression_manager
        return em.And(em.Or(self, *other), em.Not(em.And(self, *other)))


    def __xor__(self, *other):
        em = self._env.expression_manager
        return em.And(em.Or(self, *other), em.Not(em.And(self, *other)))

    def __rxor__(self, other):
        em = self._env.expression_manager
        return em.And(em.Or(*other, self), em.Not(em.And(*other, self)))



    def Implies(self, right):
        return self._env.expression_manager.Implies(self, right)




    def Iff(self, right):
        return self._env.expression_manager.Iff(self, right)