.. _f-tsp:

module ``algorithm.tsp``
========================







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

module ``code_beatrix.algorithm.tsp``

Function solving the TSP problem


:githublink:`%|py|6`






Functions
+++++++++

+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| function                                                                               | truncated documentation                                                                                         |
+========================================================================================+=================================================================================================================+
| :func:`distance_circuit <code_beatrix.algorithm.tsp.distance_circuit>`                 | Computes the distance of this circuit. Calcule la longueur d'un circuit.                                        |
+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :func:`distance_point <code_beatrix.algorithm.tsp.distance_point>`                     | Returns the Euclidian distance between two points. Retourne la distance euclidienne entre deux points.          |
+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :func:`permutation <code_beatrix.algorithm.tsp.permutation>`                           | Switches two points and returns a new path. Echange deux points et retourne le nouveau circuit.                 |
+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :func:`plot_circuit <code_beatrix.algorithm.tsp.plot_circuit>`                         | Plots the circuit on a graph. Dessine la solution du voyageur de commerce.                                      |
+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :func:`reverse <code_beatrix.algorithm.tsp.reverse>`                                   | Reverses a sub part of circuit. Retourne une partie du circuit.                                                 |
+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :func:`voyageur_commerce_simple <code_beatrix.algorithm.tsp.voyageur_commerce_simple>` | Solves the TSP using basic permutations, points are 2D coordinates. Résoud le problème du voyageur de commerce. |
+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+








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

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