.. _f-velibtrajectories:

module ``challenge.velib_trajectories``
=======================================





.. inheritance-diagram:: ensae_projects.challenge.velib_trajectories


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

module ``ensae_projects.challenge.velib_trajectories``

Une solution au problème proposée :
:ref:`Reconstruction de trajectoire velib <l-codingparty1>`


:githublink:`%|py|7`




Classes
+++++++

+------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| class                                                                                          | truncated documentation                                                                     |
+================================================================================================+=============================================================================================+
| :class:`ParemetreCoutTrajet <ensae_projects.challenge.velib_trajectories.ParemetreCoutTrajet>` | Regroupe l'ensembles des paramètres pour le calcul de la distance associé à un appariement. |
+------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+




Functions
+++++++++

+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| function                                                                                | truncated documentation                                                                                                 |
+=========================================================================================+=========================================================================================================================+
| :func:`appariement <ensae_projects.challenge.velib_trajectories.appariement>`           | On veut apparier les événemens -1 aux événemens +1. On s'attend aux colonnes suivantes: *"file"*, *"collect_date"*, ... |
+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`distance <ensae_projects.challenge.velib_trajectories.distance>`                 | Calcule une distance pour un appariement conçu ici comme la variance de la vitesse de chaque déplacement + la somme ... |
+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`distance_path <ensae_projects.challenge.velib_trajectories.distance_path>`       | Calcule la vitesse moyenne lorsque le chemin est connu.                                                                 |
+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_events <ensae_projects.challenge.velib_trajectories.enumerate_events>` | Construit la liste des événements (vélo réposé ou retiré).                                                              |
+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`get_data <ensae_projects.challenge.velib_trajectories.get_data>`                 | Récupère les données.                                                                                                   |
+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`vitesse <ensae_projects.challenge.velib_trajectories.vitesse>`                   | Calcule la vitesse d'un déplacement.                                                                                    |
+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+




Properties
++++++++++

+-----------------------------------------------------------------------------------------+--------------------------------------------+
| property                                                                                | truncated documentation                    |
+=========================================================================================+============================================+
| :meth:`values <ensae_projects.challenge.velib_trajectories.ParemetreCoutTrajet.values>` | Retourne les valeurs dans un dictionnaire. |
+-----------------------------------------------------------------------------------------+--------------------------------------------+






Methods
+++++++

+------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| method                                                                                         | truncated documentation                                              |
+================================================================================================+======================================================================+
| :py:meth:`__init__ <ensae_projects.challenge.velib_trajectories.ParemetreCoutTrajet.__init__>` |                                                                      |
+------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| :py:meth:`__str__ <ensae_projects.challenge.velib_trajectories.ParemetreCoutTrajet.__str__>`   | usuel                                                                |
+------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| :meth:`cost <ensae_projects.challenge.velib_trajectories.ParemetreCoutTrajet.cost>`            | Retourne un coût, plus il est bas, plus de déplacement est probable. |
+------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+


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

.. automodule:: ensae_projects.challenge.velib_trajectories
    :members:
    :special-members: __init__
    :show-inheritance: