QuadraticProgramElement

Interface class for all objects that have a parent QuadraticProgram.

Source code in q3as/quadratic/problems/quadratic_program_element.py

class QuadraticProgramElement:
    """Interface class for all objects that have a parent QuadraticProgram."""

    def __init__(self, quadratic_program: "problems.QuadraticProgram") -> None:
        """Initialize object with parent QuadraticProgram.

        Args:
            quadratic_program: The parent QuadraticProgram.
        Raises:
            TypeError: QuadraticProgram instance expected.
        """
        # pylint: disable=cyclic-import
        from .quadratic_program import QuadraticProgram

        if not isinstance(quadratic_program, QuadraticProgram):
            raise TypeError("QuadraticProgram instance expected")

        self._quadratic_program = quadratic_program

    @property
    def quadratic_program(self) -> "problems.QuadraticProgram":
        """Returns the parent QuadraticProgram.

        Returns:
            The parent QuadraticProgram.
        """
        return self._quadratic_program

    @quadratic_program.setter
    def quadratic_program(self, quadratic_program: "problems.QuadraticProgram") -> None:
        """Sets the parent QuadraticProgram.

        Args:
            quadratic_program: The parent QuadraticProgram.
        Raises:
            TypeError: QuadraticProgram instance expected.
        """
        # pylint: disable=cyclic-import
        from .quadratic_program import QuadraticProgram

        if not isinstance(quadratic_program, QuadraticProgram):
            raise TypeError("QuadraticProgram instance expected")

        self._quadratic_program = quadratic_program

quadratic_program: problems.QuadraticProgram property writable

Returns the parent QuadraticProgram.

Returns:

Type	Description
QuadraticProgram	The parent QuadraticProgram.

__init__(quadratic_program)

Initialize object with parent QuadraticProgram.

Parameters:

Name	Type	Description	Default
quadratic_program	QuadraticProgram	The parent QuadraticProgram.	required

Raises: TypeError: QuadraticProgram instance expected.

Source code in q3as/quadratic/problems/quadratic_program_element.py

def __init__(self, quadratic_program: "problems.QuadraticProgram") -> None:
    """Initialize object with parent QuadraticProgram.

    Args:
        quadratic_program: The parent QuadraticProgram.
    Raises:
        TypeError: QuadraticProgram instance expected.
    """
    # pylint: disable=cyclic-import
    from .quadratic_program import QuadraticProgram

    if not isinstance(quadratic_program, QuadraticProgram):
        raise TypeError("QuadraticProgram instance expected")

    self._quadratic_program = quadratic_program