.. _f-student:

module ``special.student``
==========================





.. inheritance-diagram:: ensae_teaching_cs.special.student


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

module ``ensae_teaching_cs.special.student``

:githublink:`%|py|5`




Classes
+++++++

+--------------------------------------------------------------+-------------------------+
| class                                                        | truncated documentation |
+==============================================================+=========================+
| :class:`Student <ensae_teaching_cs.special.student.Student>` | Class Student, it has:  |
+--------------------------------------------------------------+-------------------------+








Static Methods
++++++++++++++

+-----------------------------------------------------------------------------------+----------------------------------------+
| staticmethod                                                                      | truncated documentation                |
+===================================================================================+========================================+
| :meth:`random_student <ensae_teaching_cs.special.student.Student.random_student>` | Returns a student with random answers. |
+-----------------------------------------------------------------------------------+----------------------------------------+




Methods
+++++++

+---------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| method                                                                                      | truncated documentation                                                                                               |
+=============================================================================================+=======================================================================================================================+
| :py:meth:`__init__ <ensae_teaching_cs.special.student.Student.__init__>`                    |                                                                                                                       |
+---------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <ensae_teaching_cs.special.student.Student.__repr__>`                    | usual                                                                                                                 |
+---------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`count_anwers <ensae_teaching_cs.special.student.Student.count_anwers>`               | Returns a dictionary `{ ('q1', 'q2'): { (True, False): 1 } }`. That means the student was True at question q1 and ... |
+---------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`count_anwers_matrix <ensae_teaching_cs.special.student.Student.count_anwers_matrix>` | Returns a names, mat.                                                                                                 |
+---------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`to_matrix <ensae_teaching_cs.special.student.Student.to_matrix>`                     | Returns a names, vect.                                                                                                |
+---------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+


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

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