.. _l-classes:

Classes
=======

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


Summary
+++++++

+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| class                                                                                                                   | class parent | truncated documentation                                                                                                                               |
+=========================================================================================================================+==============+=======================================================================================================================================================+
| :class:`Case <ensae_teaching_cs.special.hermionne_classes.Case>`                                                        |              | L'énigme d'Hermionne repose sur 7 cases disposées en ligne. Cette classe définit une case.                                                            |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CopyFileForFtp <ensae_teaching_cs.homeblog.copyfile.CopyFileForFtp>`                                            |              | This classes maintains a list of files and does some verifications in order to check if a file was modified or not ...                                |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Corde <ensae_teaching_cs.special.corde.Corde>`                                                                  |              | Définition d'une corde, une liste de masses reliées par des élastiques et attachées au deux extrémités.                                               |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Couleur <ensae_teaching_cs.special.image.image_synthese_base.Couleur>`                                          |              | une couleur est un vecteur dont les coordonnées sont comprises entre 0 et 1, x <--> rouge, y <--> vert, z <--> bleu                                   |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CustomCythonError <ensae_teaching_cs.faq.faq_cython.CustomCythonError>`                                         |              | raised by function :func:`compile_cython_single_script` when a script cannot be compiled with Cython                                                  |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CustomMagics <ensae_teaching_cs.td_2a.custom_magics.CustomMagics>`                                              |              |                                                                                                                                                       |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`DiceStraight <ensae_teaching_cs.td_2a.dice.DiceStraight>`                                                       |              | Inspired by `Problem A. Dice Straight <https://codingcompetitions.withgoogle.com/codejam/ round/0000000000201909/00000000002017fc>`_. ...             |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`EdmondsKarpGraph <ensae_teaching_cs.td_2a.edmonds_karp.EdmondsKarpGraph>`                                       |              | This class represents a directed graph using adjacency matrix representation.                                                                         |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`ElectionResults <ensae_teaching_cs.special.elections.ElectionResults>`                                          |              | Processes data coming from `data.gouv.fr <http://www.data.gouv.fr/content/search?SortBy=Pertinence&SortOrder=0&SearchText=%C3%A9lections+2012>`_. ... |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Enigma <ensae_teaching_cs.special.einstein_prolog.Enigma>`                                                      |              | this class solves the enigma                                                                                                                          |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Enigme <ensae_teaching_cs.special.hermionne_classes.Enigme>`                                                    |              | description de l'énigme                                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`EpidemicPopulation <ensae_teaching_cs.special.propagation_epidemic.EpidemicPopulation>`                         |              | defines a population                                                                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Facette <ensae_teaching_cs.special.image.image_synthese_facette.Facette>`                                       |              | définit un triangle dans l'espace                                                                                                                     |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`FileToCopy <ensae_teaching_cs.homeblog.copyfile.FileToCopy>`                                                    |              |                                                                                                                                                       |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`FlaskInThread <ensae_teaching_cs.td_1a.flask_helper.FlaskInThread>`                                             |              | Defines a thread for the server.                                                                                                                      |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Game2048 <ensae_teaching_cs.td_1a.cp2048.Game2048>`                                                             |              | Implements the logic of the game :epkg:`2048`.                                                                                                        |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Game2048State <ensae_teaching_cs.td_1a.cp2048.Game2048State>`                                                   |              | To store additional information while guessing the best move.                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`GameOverException <ensae_teaching_cs.td_1a.cp2048.GameOverException>`                                           |              | Raised when the game is over.                                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`GeometryPolygone <ensae_teaching_cs.special.geometry_polygone.GeometryPolygone>`                                |              | A sequence of point, the last one is connected to the first one.                                                                                      |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`GeometrySegment <ensae_teaching_cs.special.geometry_segment.GeometrySegment>`                                   |              | two points                                                                                                                                            |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`HomomorphicInt <ensae_teaching_cs.td_2a.homomorphic.HomomorphicInt>`                                            |              | Implements an "homomorphic integer". See `Homomorphic encryption <https://en.wikipedia.org/wiki/Homomorphic_encryption>`_. ...                        |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`LassoRandomForestRegressor <ensae_teaching_cs.ml.lasso_random_forest_regressor.LassoRandomForestRegressor>`     |              | Fits a random forest and then selects trees by using a Lasso regression. The traning produces the following attributes: ...                           |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`LatexCode <ensae_teaching_cs.homeblog.latex_file.LatexCode>`                                                    |              | many latex contains examples of codes this describes one of them                                                                                      |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`LatexFile <ensae_teaching_cs.homeblog.latex_file.LatexFile>`                                                    |              | Description of a latex file.                                                                                                                          |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`LatexIncludedFile <ensae_teaching_cs.homeblog.latex_file.LatexIncludedFile>`                                    |              | Describes a file included a latex file.                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Objet <ensae_teaching_cs.special.image.image_synthese_base.Objet>`                                              |              | définit l'interface pour un objet à dessiner dans une image de synthese                                                                               |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`ObjetMasseReliees <ensae_teaching_cs.special.corde.ObjetMasseReliees>`                                          |              | Définit un objet commun à une corde ou un pendule physiquement représenté comme un ensemble de masses reliées des ...                                 |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`ParallelThread <ensae_teaching_cs.td_2a.parallel_thread.ParallelThread>`                                        |              | Cette classe implémente un thread qui exécute en boucle une fonction sur tous les éléments d'une liste.                                               |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Pendule <ensae_teaching_cs.special.corde.Pendule>`                                                              |              | Définition d'un pendule, une liste de masses reliées par des élastiques et attachées à une extrémités. Contribution ...                               |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Person <ensae_teaching_cs.special.propagation_epidemic.Person>`                                                 |              | defines a person for the simulation colors                                                                                                            |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Pixel <ensae_teaching_cs.special.image.image_synthese_base.Pixel>`                                              |              | définit ce qu'est un pixel                                                                                                                            |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Point <ensae_teaching_cs.special.corde.Point>`                                                                  |              | définition d'un point : deux coordonnées et une masse                                                                                                 |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Point <ensae_teaching_cs.special.propagation_epidemic.Point>`                                                   |              | Defines a point.                                                                                                                                      |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`ProjectsRepository <ensae_teaching_cs.automation_students.projects_repository.ProjectsRepository>`              |              | Handle a repository of students projects. See example :ref:`sphx_glr_automation_fetch_student_projects_from_gmail.py`. ...                            |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Puzzle2 <ensae_teaching_cs.special.puzzle_2.Puzzle2>`                                                           |              | Définition d'une classe puzzle, elle contient simplement une liste de 9 pièces dont les positions sont:                                               |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Puzzle2Bord <ensae_teaching_cs.special.puzzle_2.Puzzle2Bord>`                                                   |              | Définition d'un bord ou côté d'une pièce, il possède deux couleurs.                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Puzzle2Piece <ensae_teaching_cs.special.puzzle_2.Puzzle2Piece>`                                                 |              | Définition d'une pièce du puzzle, celle-ci inclut :                                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`PuzzleGirafe <ensae_teaching_cs.special.puzzle_girafe.PuzzleGirafe>`                                            |              | définition d'une classe puzzle, elle contient simplement une liste de 9 pièces dont les positions sont                                                |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`PuzzleGirafeBord <ensae_teaching_cs.special.puzzle_girafe.PuzzleGirafeBord>`                                    |              | Définition d'un bord ou côté d'une pièce, il possède :                                                                                                |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`PuzzleGirafePiece <ensae_teaching_cs.special.puzzle_girafe.PuzzleGirafePiece>`                                  |              | Définition d'une pièce du puzzle, celle-ci inclut :                                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Rayon <ensae_teaching_cs.special.image.image_synthese_base.Rayon>`                                              |              | définit ce qu'est un rayon                                                                                                                            |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Rect <ensae_teaching_cs.special.propagation_epidemic.Rect>`                                                     |              | Defines a rectangle.                                                                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Rectangle <ensae_teaching_cs.special.image.image_synthese_facette.Rectangle>`                                   |              | définit un rectangle dans l'espace                                                                                                                    |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`RectangleImage <ensae_teaching_cs.special.image.image_synthese_facette_image.RectangleImage>`                   |              | définit un rectangle contenant un portrait                                                                                                            |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`RegexRepositoryException <ensae_teaching_cs.automation_students.repository_exception.RegexRepositoryException>` |              | raised when it is impossible to get information from the repository                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Regle <ensae_teaching_cs.special.hermionne_classes.Regle>`                                                      |              | L'énigme repose sur des règles. Chaque règle hérite de cette classe et implémente la méthode *correcte* qui vérifie ...                               |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Regle1 <ensae_teaching_cs.special.hermionne_classes.Regle1>`                                                    |              | implémente la première règle                                                                                                                          |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Regle2 <ensae_teaching_cs.special.hermionne_classes.Regle2>`                                                    |              | implémente la seconde règle                                                                                                                           |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Regle3 <ensae_teaching_cs.special.hermionne_classes.Regle3>`                                                    |              | implémente la troisième règle                                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Regle4 <ensae_teaching_cs.special.hermionne_classes.Regle4>`                                                    |              | implémente la quatrième règle                                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Regle5 <ensae_teaching_cs.special.hermionne_classes.Regle5>`                                                    |              | implémente la cinquième règle                                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Repere <ensae_teaching_cs.special.image.image_synthese_base.Repere>`                                            |              | définition d'un repère orthonormé                                                                                                                     |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Rule <ensae_teaching_cs.special.einstein_prolog.Rule>`                                                          |              | This class defines a constraint of the problem or a clause (see `http://en.wikipedia.org/wiki/Clause_(logic)`) ...                                    |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`RuleAvant <ensae_teaching_cs.special.einstein_prolog.RuleAvant>`                                                |              | p1 before p2                                                                                                                                          |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`RuleEnsemble <ensae_teaching_cs.special.einstein_prolog.RuleEnsemble>`                                          |              | permutation of the elements of a category                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`RuleEquivalence <ensae_teaching_cs.special.einstein_prolog.RuleEquivalence>`                                    |              | p1 equivalent to p2                                                                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`RulePosition <ensae_teaching_cs.special.einstein_prolog.RulePosition>`                                          |              | p1 at position                                                                                                                                        |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`RuleVoisin <ensae_teaching_cs.special.einstein_prolog.RuleVoisin>`                                              |              | p1 and p2 are neighbors                                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Scene <ensae_teaching_cs.special.image.image_synthese_scene.Scene>`                                             |              | définit une scène, les axes x,y sont ceux de l'écran, z-1 est la distance à l'écran du point (x,y,z)                                                  |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`ScenePhong <ensae_teaching_cs.special.image.image_synthese_phong.ScenePhong>`                                   |              | définit une scène et utilise le modèle d'illumination de Phong pour construire l'image de synthèse                                                    |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Source <ensae_teaching_cs.special.image.image_synthese_base.Source>`                                            |              | définition d'une source ponctuelle                                                                                                                    |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Sphere <ensae_teaching_cs.special.image.image_synthese_sphere.Sphere>`                                          |              | définit une sphère                                                                                                                                    |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`SphereReflet <ensae_teaching_cs.special.image.image_synthese_facette_image.SphereReflet>`                       |              | implémente une sphère avec un reflet                                                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Student <ensae_teaching_cs.special.student.Student>`                                                            |              | Class Student, it has:                                                                                                                                |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`TableFormula <ensae_teaching_cs.homeblog.table_formula.TableFormula>`                                           |              | This class aims at representating a table, it provides some "SQL like" functionalities such groupby or innerjoin, select, ...                         |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`TooManyProjectsException <ensae_teaching_cs.automation_students.repository_exception.TooManyProjectsException>` |              | raised when a group has too many projects                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Vecteur <ensae_teaching_cs.special.image.image_synthese_base.Vecteur>`                                          |              | définit ce qu'est un point                                                                                                                            |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Ville <ensae_teaching_cs.special.voisinage_evolution.Ville>`                                                    |              | Définit une ville qui va évoluer par la suite.                                                                                                        |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`VilleImage <ensae_teaching_cs.special.voisinage_evolution.VilleImage>`                                          |              | Définit une ville à partir d'une image (donc non aléatoire).                                                                                          |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`_TableFormulaStat <ensae_teaching_cs.homeblog.table_formula_stat._TableFormulaStat>`                            |              | Contains various statistical functions.                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+