.. _f-geometrypoint:

module ``special.geometry_point``
=================================





.. inheritance-diagram:: ensae_teaching_cs.special.geometry_point


Short summary
+++++++++++++

module ``ensae_teaching_cs.special.geometry_point``

Defines a point in N-dimension


:githublink:`%|py|5`




Classes
+++++++

+-----------------------------------------------------------------------------------------+------------------------------------------------------+
| class                                                                                   | truncated documentation                              |
+=========================================================================================+======================================================+
| :class:`GeometryException <ensae_teaching_cs.special.geometry_point.GeometryException>` | raises when an issue arises with class GeometryPoint |
+-----------------------------------------------------------------------------------------+------------------------------------------------------+
| :class:`GeometryPoint <ensae_teaching_cs.special.geometry_point.GeometryPoint>`         | one point                                            |
+-----------------------------------------------------------------------------------------+------------------------------------------------------+










Methods
+++++++

+---------------------------------------------------------------------------------------+----------------------------------------------------+
| method                                                                                | truncated documentation                            |
+=======================================================================================+====================================================+
| :py:meth:`__add__ <ensae_teaching_cs.special.geometry_point.GeometryPoint.__add__>`   | addition                                           |
+---------------------------------------------------------------------------------------+----------------------------------------------------+
| :py:meth:`__cmp__ <ensae_teaching_cs.special.geometry_point.GeometryPoint.__cmp__>`   | comparison                                         |
+---------------------------------------------------------------------------------------+----------------------------------------------------+
| :py:meth:`__eq__ <ensae_teaching_cs.special.geometry_point.GeometryPoint.__eq__>`     | is equal                                           |
+---------------------------------------------------------------------------------------+----------------------------------------------------+
| :py:meth:`__iadd__ <ensae_teaching_cs.special.geometry_point.GeometryPoint.__iadd__>` | addition                                           |
+---------------------------------------------------------------------------------------+----------------------------------------------------+
| :py:meth:`__imul__ <ensae_teaching_cs.special.geometry_point.GeometryPoint.__imul__>` | multiplication by a scalar                         |
+---------------------------------------------------------------------------------------+----------------------------------------------------+
| :py:meth:`__init__ <ensae_teaching_cs.special.geometry_point.GeometryPoint.__init__>` |                                                    |
+---------------------------------------------------------------------------------------+----------------------------------------------------+
| :py:meth:`__len__ <ensae_teaching_cs.special.geometry_point.GeometryPoint.__len__>`   | returns the dimension                              |
+---------------------------------------------------------------------------------------+----------------------------------------------------+
| :py:meth:`__lt__ <ensae_teaching_cs.special.geometry_point.GeometryPoint.__lt__>`     | inferior                                           |
+---------------------------------------------------------------------------------------+----------------------------------------------------+
| :py:meth:`__mul__ <ensae_teaching_cs.special.geometry_point.GeometryPoint.__mul__>`   | multiplication by a scalar                         |
+---------------------------------------------------------------------------------------+----------------------------------------------------+
| :py:meth:`__neq__ <ensae_teaching_cs.special.geometry_point.GeometryPoint.__neq__>`   | is different                                       |
+---------------------------------------------------------------------------------------+----------------------------------------------------+
| :py:meth:`__repr__ <ensae_teaching_cs.special.geometry_point.GeometryPoint.__repr__>` | ``eval(__repr__)`` should return the same object   |
+---------------------------------------------------------------------------------------+----------------------------------------------------+
| :py:meth:`__str__ <ensae_teaching_cs.special.geometry_point.GeometryPoint.__str__>`   | converts into string                               |
+---------------------------------------------------------------------------------------+----------------------------------------------------+
| :py:meth:`__sub__ <ensae_teaching_cs.special.geometry_point.GeometryPoint.__sub__>`   | substraction                                       |
+---------------------------------------------------------------------------------------+----------------------------------------------------+
| :meth:`angle <ensae_teaching_cs.special.geometry_point.GeometryPoint.angle>`          | return the angle                                   |
+---------------------------------------------------------------------------------------+----------------------------------------------------+
| :meth:`cossin <ensae_teaching_cs.special.geometry_point.GeometryPoint.cossin>`        | return the cos, sin of a vector (dimension 2 only) |
+---------------------------------------------------------------------------------------+----------------------------------------------------+
| :meth:`norm2 <ensae_teaching_cs.special.geometry_point.GeometryPoint.norm2>`          | return the norm                                    |
+---------------------------------------------------------------------------------------+----------------------------------------------------+
| :meth:`product <ensae_teaching_cs.special.geometry_point.GeometryPoint.product>`      | vectoriel product, dimension 2 only                |
+---------------------------------------------------------------------------------------+----------------------------------------------------+
| :meth:`scalar <ensae_teaching_cs.special.geometry_point.GeometryPoint.scalar>`        | scalar product                                     |
+---------------------------------------------------------------------------------------+----------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: ensae_teaching_cs.special.geometry_point
    :members:
    :special-members: __init__
    :show-inheritance: