.. _f-geometrysegment:

module ``special.geometry_segment``
===================================





.. inheritance-diagram:: ensae_teaching_cs.special.geometry_segment


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

module ``ensae_teaching_cs.special.geometry_segment``

Defines a segment


:githublink:`%|py|5`




Classes
+++++++

+---------------------------------------------------------------------------------------+-------------------------+
| class                                                                                 | truncated documentation |
+=======================================================================================+=========================+
| :class:`GeometrySegment <ensae_teaching_cs.special.geometry_segment.GeometrySegment>` | two points              |
+---------------------------------------------------------------------------------------+-------------------------+










Methods
+++++++

+--------------------------------------------------------------------------------------------------+----------------------------------------------+
| method                                                                                           | truncated documentation                      |
+==================================================================================================+==============================================+
| :py:meth:`__eq__ <ensae_teaching_cs.special.geometry_segment.GeometrySegment.__eq__>`            | equal                                        |
+--------------------------------------------------------------------------------------------------+----------------------------------------------+
| :py:meth:`__imul__ <ensae_teaching_cs.special.geometry_segment.GeometrySegment.__imul__>`        | multiplication                               |
+--------------------------------------------------------------------------------------------------+----------------------------------------------+
| :py:meth:`__init__ <ensae_teaching_cs.special.geometry_segment.GeometrySegment.__init__>`        | constructor                                  |
+--------------------------------------------------------------------------------------------------+----------------------------------------------+
| :py:meth:`__len__ <ensae_teaching_cs.special.geometry_segment.GeometrySegment.__len__>`          | dimension                                    |
+--------------------------------------------------------------------------------------------------+----------------------------------------------+
| :py:meth:`__neq__ <ensae_teaching_cs.special.geometry_segment.GeometrySegment.__neq__>`          | different                                    |
+--------------------------------------------------------------------------------------------------+----------------------------------------------+
| :py:meth:`__str__ <ensae_teaching_cs.special.geometry_segment.GeometrySegment.__str__>`          | usual                                        |
+--------------------------------------------------------------------------------------------------+----------------------------------------------+
| :meth:`equation <ensae_teaching_cs.special.geometry_segment.GeometrySegment.equation>`           | dimension 2 only                             |
+--------------------------------------------------------------------------------------------------+----------------------------------------------+
| :meth:`equation_eval <ensae_teaching_cs.special.geometry_segment.GeometrySegment.equation_eval>` |                                              |
+--------------------------------------------------------------------------------------------------+----------------------------------------------+
| :meth:`norm2 <ensae_teaching_cs.special.geometry_segment.GeometrySegment.norm2>`                 |                                              |
+--------------------------------------------------------------------------------------------------+----------------------------------------------+
| :meth:`reverse <ensae_teaching_cs.special.geometry_segment.GeometrySegment.reverse>`             | switch extremities                           |
+--------------------------------------------------------------------------------------------------+----------------------------------------------+
| :meth:`topdown <ensae_teaching_cs.special.geometry_segment.GeometrySegment.topdown>`             | the vector only points in the same semi-plan |
+--------------------------------------------------------------------------------------------------+----------------------------------------------+
| :meth:`vector <ensae_teaching_cs.special.geometry_segment.GeometrySegment.vector>`               |                                              |
+--------------------------------------------------------------------------------------------------+----------------------------------------------+


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

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