.. _f-classroom:

module ``algorithm.classroom``
==============================







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

module ``code_beatrix.algorithm.classroom``

Positions in a classroom


:githublink:`%|py|5`






Functions
+++++++++

+--------------------------------------------------------------------------------------------------+----------------------------------------------------------+
| function                                                                                         | truncated documentation                                  |
+==================================================================================================+==========================================================+
| :func:`distance <code_beatrix.algorithm.classroom.distance>`                                     | Computes the distance between two positions.             |
+--------------------------------------------------------------------------------------------------+----------------------------------------------------------+
| :func:`find_best_positions_greedy <code_beatrix.algorithm.classroom.find_best_positions_greedy>` | Finds the best position for name, explore all positions. |
+--------------------------------------------------------------------------------------------------+----------------------------------------------------------+
| :func:`measure_positions <code_beatrix.algorithm.classroom.measure_positions>`                   | Returns the sum of edges weights.                        |
+--------------------------------------------------------------------------------------------------+----------------------------------------------------------+
| :func:`optimize_positions <code_beatrix.algorithm.classroom.optimize_positions>`                 | Optimizes the positions.                                 |
+--------------------------------------------------------------------------------------------------+----------------------------------------------------------+
| :func:`plot_positions <code_beatrix.algorithm.classroom.plot_positions>`                         | Draws positions and first names into a graph.            |
+--------------------------------------------------------------------------------------------------+----------------------------------------------------------+
| :func:`random_positions <code_beatrix.algorithm.classroom.random_positions>`                     | Draws random position for some person in a classroom.    |
+--------------------------------------------------------------------------------------------------+----------------------------------------------------------+








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

.. automodule:: code_beatrix.algorithm.classroom
    :members:
    :special-members: __init__
    :show-inheritance: