.. _l-classes:

Classes
=======

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| class                                                                                                | class parent | truncated documentation                                                                                                  |
+======================================================================================================+==============+==========================================================================================================================+
| :class:`Blossom <ensae_projects.challenge.blossom.Blossom>`                                          |              |                                                                                                                          |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`Edge <ensae_projects.challenge.blossom.Edge>`                                                |              |                                                                                                                          |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`EdgeNotIncident <ensae_projects.challenge.blossom.EdgeNotIncident>`                          |              | Indicates that a traversal was requested through an edge from a set that doesn't contain any of its endpoints.           |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`EdgeNotOutgoing <ensae_projects.challenge.blossom.EdgeNotOutgoing>`                          |              | Indicates that a traversal was requested through an edge from a set of vertices containing both its endpoints.           |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`EdgeTraversalError <ensae_projects.challenge.blossom.EdgeTraversalError>`                    |              |                                                                                                                          |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`FileFormatException <ensae_projects.datainc.data_exception.FileFormatException>`             |              | Raised when unable to parse a file                                                                                       |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`ImageNearestNeighbors <ensae_projects.hackathon.image_knn.ImageNearestNeighbors>`            |              | Builds a model on the top of :epkg:`NearestNeighbors` in order to find close images.                                     |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`MLStoragePerf2018 <ensae_projects.hackathon.perf2018.MLStoragePerf2018>`                     |              | Computes the performances the a hackathon.                                                                               |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`MLStoragePerf2018Image <ensae_projects.hackathon.perf2018.MLStoragePerf2018Image>`           |              | Overloads *compute_perf* for images. Example of use:                                                                     |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`MLStoragePerf2018TimeSeries <ensae_projects.hackathon.perf2018.MLStoragePerf2018TimeSeries>` |              | Overloads *compute_perf* for timeseries. Example of use:                                                                 |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`MaximumDualReached <ensae_projects.challenge.blossom.MaximumDualReached>`                    |              | Indicates that we have reached the maximum dual solution and cannot improve it further.                                  |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`ParemetreCoutTrajet <ensae_projects.challenge.velib_trajectories.ParemetreCoutTrajet>`       |              | Regroupe l'ensembles des paramètres pour le calcul de la distance associé à un appariement.                              |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`PasswordException <ensae_projects.datainc.data_exception.PasswordException>`                 |              | Raised when password is missing                                                                                          |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`ProjectDataException <ensae_projects.datainc.data_exception.ProjectDataException>`           |              | Exception raised when data is not available                                                                              |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`SolutionException <ensae_projects.challenge.city_tour.SolutionException>`                    |              | wrong solution                                                                                                           |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`StructureUpToDate <ensae_projects.challenge.blossom.StructureUpToDate>`                      |              | This gets raised as soon as the structure of all trees is up-to-date, i.e. there are no more instances of any of the ... |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`TreeStructureChanged <ensae_projects.challenge.blossom.TreeStructureChanged>`                |              | Used whenever the structure of an alternating tree is changed to abort current traversal and initiate a new one.         |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`Vertex <ensae_projects.challenge.blossom.Vertex>`                                            |              |                                                                                                                          |
+------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+