.. _l-functions:

Functions
=========

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


Summary
+++++++

+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                             | class parent | truncated documentation                                                                                                      |
+======================================================================================================================+==============+==============================================================================================================================+
| :func:`_setup_hook <teachpyx._setup_hook>`                                                                           |              | if this function is added to the module, the help automation and unit tests call it first before anything goes on ...        |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`call_stack <teachpyx.faq.faq_exception.call_stack>`                                                           |              |                                                                                                                              |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`check <teachpyx.check>`                                                                                       |              | Checks the library is working. It raises an exception. If you want to disable the logs:                                      |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`class_getitem <teachpyx.faq.faq_python.class_getitem>`                                                        |              | This function shows how to enable an expression such as `A[1]` where `A` is a class type and not an instance. This ...       |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`commentaire_accentues <teachpyx.examples.classiques.commentaire_accentues>`                                   |              | L'aide de cette fonction contient assuréments des accents.                                                                   |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`compte <teachpyx.examples.construction_classique.compte>`                                                     |              | Compte le nombre d'occurrences de chaque élément d'une liste.                                                                |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`construit_matrice_carree <teachpyx.examples.construction_classique.construit_matrice_carree>`                 |              | Cette fonction construit une matrice carrée remplie de zéro sous la forme d'une liste de listes.                             |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`dictionnaire_modifie_dans_la_boucle <teachpyx.examples.classiques.dictionnaire_modifie_dans_la_boucle>`       |              | Dictionnaires, listes modifiés dans la boucle qui les parcourt.                                                              |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`difference_div <teachpyx.faq.faq_python.difference_div>`                                                      |              |                                                                                                                              |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`dix_entiers_carre <teachpyx.examples.classiques.dix_entiers_carre>`                                           |              | fait la somme des dix premiers entiers au carré                                                                              |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`entier_grande_taille <teachpyx.faq.faq_python.entier_grande_taille>`                                          |              |                                                                                                                              |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_permutations <teachpyx.examples.construction_classique.enumerate_permutations>`                     |              | Enumère les permutations d'un ensemble de façon non récursive.                                                               |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_permutations_recursive <teachpyx.examples.construction_classique.enumerate_permutations_recursive>` |              | Enumère les permutations d'un ensemble de façon récursive.                                                                   |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_regex_search <teachpyx.faq.faq_python.enumerate_regex_search>`                                      |              | Cette fonction itère sur les différentes occurences d'une expression régulière.                                              |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_day_name <teachpyx.faq.faq_python.get_day_name>`                                                          |              | returns the day name for a give date                                                                                         |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_month_name <teachpyx.faq.faq_python.get_month_name>`                                                      |              | returns the month name for a give date                                                                                       |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`information_about_package <teachpyx.faq.faq_python.information_about_package>`                                |              | calls ``pip show`` to retrieve information about packages                                                                    |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`integrale <teachpyx.examples.construction_classique.integrale>`                                               |              | Calcule l'intégrale d'une fonction avec la `méthode de Rienmann <https://fr.wikipedia.org/wiki/Somme_de_Riemann>`_.          |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`list_of_installed_packages <teachpyx.faq.faq_python.list_of_installed_packages>`                              |              | calls ``pip list`` to retrieve the list of packages                                                                          |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`mat2text <teachpyx.examples.construction_classique.mat2text>`                                                 |              | Convertit une matrice en une chaîne de caractères, réciproque de la fonction :func:`text2mat`.                               |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`mat2vect <teachpyx.examples.construction_classique.mat2vect>`                                                 |              | Convertit une matrice en un tableau à une seule dimension, réciproque de la fonction :func:`vect2mat`.                       |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`minindex <teachpyx.examples.construction_classique.minindex>`                                                 |              | Retourne l'index du minimum et le minimum.                                                                                   |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`numpy_matrix2list <teachpyx.examples.numpysex.numpy_matrix2list>`                                             |              | Convertit une matrice `numpy <http://www.numpy.org/>`_ en list.                                                              |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`numpy_types <teachpyx.examples.numpysex.numpy_types>`                                                         |              | Returns the list of numpy available types.                                                                                   |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`property_example <teachpyx.faq.faq_python.property_example>`                                                  |              |                                                                                                                              |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`python_path <teachpyx.faq.faq_python.python_path>`                                                            |              |                                                                                                                              |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`recherche <teachpyx.examples.construction_classique.recherche>`                                               |              | Retourne l'index d'un élément ou -1 si non trouvé.                                                                           |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`recherche_dichotomique <teachpyx.examples.construction_classique.recherche_dichotomique>`                     |              | Effectue une recherche dichotomique.                                                                                         |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`repetition_a_eviter <teachpyx.examples.classiques.repetition_a_eviter>`                                       |              | Une répétition à éviter.                                                                                                     |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`same_variable <teachpyx.faq.faq_python.same_variable>`                                                        |              | Cette fonction dit si les deux objets sont en fait le même objet (True) ou non (False) s'ils sont différents (même s'ils ... |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`somme <teachpyx.examples.construction_classique.somme>`                                                       |              | Calcule la somme des éléments d'un tableau.                                                                                  |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`sortable_class <teachpyx.faq.faq_python.sortable_class>`                                                      |              |                                                                                                                              |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`str2date <teachpyx.examples.classiques.str2date>`                                                             |              | convertit une chaîne de caractères en datetime                                                                               |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`stringio <teachpyx.faq.faq_python.stringio>`                                                                  |              | returns a StringIO object on a text                                                                                          |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`text2mat <teachpyx.examples.construction_classique.text2mat>`                                                 |              | Convertit une chaîne de caractères en une matrice ( = liste de listes), réciproque de la fonction :func:`mat2text`.          |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`to_float32 <teachpyx.faq.faq_numpy.to_float32>`                                                               |              | Convertit un nombre réel en nombre réel simple précision.                                                                    |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`triindex <teachpyx.examples.construction_classique.triindex>`                                                 |              | Trie une liste, retourne la liste triée et les positions initiales.                                                          |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :func:`vect2mat <teachpyx.examples.construction_classique.vect2mat>`                                                 |              | Convertit un tableau à une dimension en une matrice, réciproque de la fonction :func:`mat2vect`.                             |
+----------------------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+