Skip to content

LinearConstraint

Bases: Constraint

Representation of a linear constraint.

Source code in q3as/quadratic/problems/linear_constraint.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
class LinearConstraint(Constraint):
    """Representation of a linear constraint."""

    # Note: added, duplicating in effect that in Constraint, to avoid issues with Sphinx
    Sense = ConstraintSense

    def __init__(
        self,
        quadratic_program: Any,
        name: str,
        linear: Union[ndarray, spmatrix, List[float], Dict[Union[str, int], float]],
        sense: ConstraintSense,
        rhs: float,
    ) -> None:
        """
        Args:
            quadratic_program: The parent quadratic program.
            name: The name of the constraint.
            linear: The coefficients specifying the linear constraint.
            sense: The sense of the constraint.
            rhs: The right-hand-side of the constraint.
        """
        super().__init__(quadratic_program, name, sense, rhs)
        self._linear = LinearExpression(quadratic_program, linear)

    @property
    def linear(self) -> LinearExpression:
        """Returns the linear expression corresponding to the left-hand-side of the constraint.

        Returns:
            The left-hand-side linear expression.
        """
        return self._linear

    @linear.setter
    def linear(
        self,
        linear: Union[ndarray, spmatrix, List[float], Dict[Union[str, int], float]],
    ) -> None:
        """Sets the linear expression corresponding to the left-hand-side of the constraint.
        The coefficients can either be given by an array, a (sparse) 1d matrix, a list or a
        dictionary.

        Args:
            linear: The linear coefficients of the left-hand-side.
        """
        self._linear = LinearExpression(self.quadratic_program, linear)

    def evaluate(self, x: Union[ndarray, List, Dict[Union[int, str], float]]) -> float:
        """Evaluate the left-hand-side of the constraint.

        Args:
            x: The values of the variables to be evaluated.

        Returns:
            The left-hand-side of the constraint given the variable values.
        """
        return self.linear.evaluate(x)

    def __repr__(self):
        # pylint: disable=cyclic-import
        from ..translators.prettyprint import expr2str, DEFAULT_TRUNCATE

        lhs = expr2str(linear=self.linear, truncate=DEFAULT_TRUNCATE)
        return f"<{self.__class__.__name__}: {lhs} {self.sense.label} {self.rhs} '{self.name}'>"

    def __str__(self):
        # pylint: disable=cyclic-import
        from ..translators.prettyprint import expr2str

        lhs = expr2str(linear=self.linear)
        return f"{lhs} {self.sense.label} {self.rhs} '{self.name}'"

linear: LinearExpression property writable

Returns the linear expression corresponding to the left-hand-side of the constraint.

Returns:

Type Description
LinearExpression

The left-hand-side linear expression.

__init__(quadratic_program, name, linear, sense, rhs)

Parameters:

Name Type Description Default
quadratic_program Any

The parent quadratic program.

 required
name str

The name of the constraint.

 required
linear Union[ndarray, spmatrix, List[float], Dict[Union[str, int], float]]

The coefficients specifying the linear 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/linear_constraint.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def __init__(
    self,
    quadratic_program: Any,
    name: str,
    linear: Union[ndarray, spmatrix, List[float], Dict[Union[str, int], float]],
    sense: ConstraintSense,
    rhs: float,
) -> None:
    """
    Args:
        quadratic_program: The parent quadratic program.
        name: The name of the constraint.
        linear: The coefficients specifying the linear constraint.
        sense: The sense of the constraint.
        rhs: The right-hand-side of the constraint.
    """
    super().__init__(quadratic_program, name, sense, rhs)
    self._linear = LinearExpression(quadratic_program, linear)

evaluate(x)

Evaluate the left-hand-side of the constraint.

Parameters:

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

The values of the variables to be evaluated.

 required

Returns:

Type Description
float

The left-hand-side of the constraint given the variable values.
Source code in q3as/quadratic/problems/linear_constraint.py 
72
73
74
75
76
77
78
79
80
81
def evaluate(self, x: Union[ndarray, List, Dict[Union[int, str], float]]) -> float:
    """Evaluate the left-hand-side of the constraint.

    Args:
        x: The values of the variables to be evaluated.

    Returns:
        The left-hand-side of the constraint given the variable values.
    """
    return self.linear.evaluate(x)