Source code for projgeom.ell_object

from .pg_object import PgObject




[docs]
class EllipticPoint(PgObject["EllipticLine"]):
    """
    .. svgbob::
       :align: center

          / \\
         /   \\
        /-----\\
        \\-----/
         \\   /
          \\ /
    """



[docs]
    def dual_type(self) -> type:
        """Returns the type of the dual object (EllipticLine for EllipticPoint).

        :return: The type of the dual geometric object.

        Examples:
            >>> from projgeom.ell_object import EllipticPoint
            >>> pt = EllipticPoint([1, 2, 3])
            >>> pt.dual_type()
            <class 'projgeom.ell_object.EllipticLine'>
        """
        return EllipticLine





[docs]
    def perp(self) -> "EllipticLine":
        """
        The `perp` function returns an `EllipticLine` object representing the polar line of this point.
        Note: This represents the polar operation in projective geometry, not perpendicular.
        :return: The `perp` method is returning an instance of the `EllipticLine` class.

        Examples:
            >>> from projgeom.ell_object import EllipticPoint, EllipticLine
            >>> p = EllipticPoint([1, 2, 3])
            >>> p.perp()
            EllipticLine(1 : 2 : 3)
        """
        return self.polar()





[docs]
    def polar(self) -> "EllipticLine":
        """
        The `polar` function returns an `EllipticLine` object representing the polar line of this point.
        :return: The `polar` method is returning an instance of the `EllipticLine` class.

        Examples:
            >>> from projgeom.ell_object import EllipticPoint, EllipticLine
            >>> p = EllipticPoint([1, 2, 3])
            >>> p.polar()
            EllipticLine(1 : 2 : 3)
        """
        return EllipticLine(self.coord)








[docs]
class EllipticLine(PgObject[EllipticPoint]):
    """
    The `EllipticLine` class represents a line in Elliptic geometry and has a method `perp()` that returns
    the pole.

    .. svgbob::
       :align: center

          / \\
         /   \\
        /-----\\
        \\-----/
         \\   /
          \\ /
    """



[docs]
    def dual_type(self) -> type:
        """Returns the type of the dual object (EllipticPoint for EllipticLine).

        :return: The type of the dual geometric object.

        Examples:
            >>> from projgeom.ell_object import EllipticLine
            >>> ln = EllipticLine([1, 2, 3])
            >>> ln.dual_type()
            <class 'projgeom.ell_object.EllipticPoint'>
        """
        return EllipticPoint





[docs]
    def perp(self) -> EllipticPoint:
        """
        The `perp` function returns an `EllipticPoint` object, which represents the pole of this line.
        Note: This represents the pole operation in projective geometry, not perpendicular.
        :return: An `EllipticPoint` object is being returned.

        Examples:
            >>> from projgeom.ell_object import EllipticPoint, EllipticLine
            >>> l = EllipticLine([1, 2, 3])
            >>> l.perp()
            EllipticPoint(1 : 2 : 3)
        """
        return self.pole()





[docs]
    def pole(self) -> EllipticPoint:
        """
        The `pole` function returns an `EllipticPoint` object, which represents the pole of this line.
        :return: An `EllipticPoint` object is being returned.

        Examples:
            >>> from projgeom.ell_object import EllipticPoint, EllipticLine
            >>> l = EllipticLine([1, 2, 3])
            >>> l.pole()
            EllipticPoint(1 : 2 : 3)
        """
        return EllipticPoint(self.coord)