Skip to content

Constraint

Bases: QuadraticProgramElement

Abstract Constraint Class.

Source code in q3as/quadratic/problems/constraint.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
class Constraint(QuadraticProgramElement):
    """Abstract Constraint Class."""

    Sense = ConstraintSense

    def __init__(
        self, quadratic_program: Any, name: str, sense: ConstraintSense, rhs: float
    ) -> None:
        """Initializes the constraint.

        Args:
            quadratic_program: The parent QuadraticProgram.
            name: The name of the constraint.
            sense: The sense of the constraint.
            rhs: The right-hand-side of the constraint.
        """
        super().__init__(quadratic_program)
        self._name = name
        self._sense = sense
        self._rhs = rhs

    @property
    def name(self) -> str:
        """Returns the name of the constraint.

        Returns:
            The name of the constraint.
        """
        return self._name

    @property
    def sense(self) -> ConstraintSense:
        """Returns the sense of the constraint.

        Returns:
            The sense of the constraint.
        """
        return self._sense

    @sense.setter
    def sense(self, sense: ConstraintSense) -> None:
        """Sets the sense of the constraint.

        Args:
            sense: The sense of the constraint.
        """
        self._sense = sense

    @property
    def rhs(self) -> float:
        """Returns the right-hand-side of the constraint.

        Returns:
            The right-hand-side of the constraint.
        """
        return self._rhs

    @rhs.setter
    def rhs(self, rhs: float) -> None:
        """Sets the right-hand-side of the constraint.

        Args:
            rhs: The right-hand-side of the constraint.
        """
        self._rhs = rhs

    @abstractmethod
    def evaluate(self, x: Union[ndarray, List, Dict[Union[int, str], float]]) -> float:
        """Evaluate left-hand-side of constraint for given values of variables.

        Args:
            x: The values to be used for the variables.

        Returns:
            The left-hand-side of the constraint.
        """
        raise NotImplementedError()

name: str property

Returns the name of the constraint.

Returns:

Type Description
str

The name of the constraint.

rhs: float property writable

Returns the right-hand-side of the constraint.

Returns:

Type Description
float

The right-hand-side of the constraint.

sense: ConstraintSense property writable

Returns the sense of the constraint.

Returns:

Type Description
ConstraintSense

The sense of the constraint.

__init__(quadratic_program, name, sense, rhs)

Initializes the constraint.

Parameters:

Name Type Description Default
quadratic_program Any

The parent QuadraticProgram.

 required
name str

The name of the constraint.

 required
sense ConstraintSense

The sense of the constraint.

 required
rhs float

The right-hand-side of the constraint.

 required
Source code in q3as/quadratic/problems/constraint.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
def __init__(
    self, quadratic_program: Any, name: str, sense: ConstraintSense, rhs: float
) -> None:
    """Initializes the constraint.

    Args:
        quadratic_program: The parent QuadraticProgram.
        name: The name of the constraint.
        sense: The sense of the constraint.
        rhs: The right-hand-side of the constraint.
    """
    super().__init__(quadratic_program)
    self._name = name
    self._sense = sense
    self._rhs = rhs

evaluate(x) abstractmethod

Evaluate left-hand-side of constraint for given values of variables.

Parameters:

Name Type Description Default
x Union[ndarray, List, Dict[Union[int, str], float]]

The values to be used for the variables.

 required

Returns:

Type Description
float

The left-hand-side of the constraint.
Source code in q3as/quadratic/problems/constraint.py 
152
153
154
155
156
157
158
159
160
161
162
@abstractmethod
def evaluate(self, x: Union[ndarray, List, Dict[Union[int, str], float]]) -> float:
    """Evaluate left-hand-side of constraint for given values of variables.

    Args:
        x: The values to be used for the variables.

    Returns:
        The left-hand-side of the constraint.
    """
    raise NotImplementedError()