write documentation (random_Expression hasn't been touch yet)

docs/tutorial.mdwn

@@ -6,39 +6,82 @@ pyMath est un module python qui permet la manipulation d'expressions mathématiq
 
 * *Calculer comme un collégien*: Pour faire de la correction automatisé d'exercice, un logiciel de calcul formel ne suffit pas. Si les étapes de calculs ne sont pas présentes, l'élève ne pourra pas analyser ses erreurs ou s'inspirer de la correction.
 
+    >>> from pymath.expression import Expression
+    >>> ajout_fractions = Expression("2 / 5 + 2 / 3")
+    >>> for i in ajout_fractions.simpliy():
+    ...     print(i)
+    ...
+    \frac{ 2 }{ 5 } + \frac{ 2 }{ 3 }
+    \frac{ 2 \times 3 }{ 5 \times 3 } + \frac{ 2 \times 5 }{ 3 \times 5 }
+    \frac{ 6 + 10 }{ 15 }
+    \frac{ 16 }{ 15 }
+
 * *Créer des exercices aléatoirement*: Pour faire des devoirs personnels, des fiches de révisions ou des exercices en classe, un générateur d'expressions est inclus.
 
-* *Gérer différents type de données*: Pour le moment, pyMath est capable de gérer les entiers naturels et les rationnels (sous forme de fractions). L'utilisation des nombres à virgules, des racines et des polynômes devraient être ajoutés dans les prochaines versions.
+    >>> from pymath.expression import Expression
+    >>> ajout_fraction = Expression.random("{a} + {b} / {c}")
+    >>> print(ajout_fraction)
+    5 + \frac{ -7 }{ 4 }
+
+* *Gérer différents type de données*: Pour le moment, pyMath est capable de gérer les entiers naturels, les rationnels (sous forme de fractions) et les polynômes. L'utilisation des nombres à virgules et des racines devraient être ajoutés dans les prochaines versions.
+
+    >>> from pymath.fraction import Fraction
+    >>> une_fraction = Fraction(1,2)
+    >>> print(une_fraction)
+    1 / 2
+    >>> from pymath.polynom import Polynom 
+    >>> un_polynom = Polynom([1,2,3])
+    >>> print(un_polynom)
+    3 x^{  2 } + 2 x + 1
 
 * *Afficher avec deux types de rendus*: Un en mode texte pour l'affichage dans une console. Un deuxième spécialement pour écrire des documents latex.
 
+    >>> from pymath.expression import Expression
+    >>> ajout_fractions = Expression("2 / 5 + 2 / 3")
+    >>> for i in ajout_fractions.simpliy():
+    ...     print(i)
+    \frac{ 2 }{ 5 } + \frac{ 2 }{ 3 }
+    \frac{ 2 \times 3 }{ 5 \times 3 } + \frac{ 2 \times 5 }{ 3 \times 5 }
+    \frac{ 6 + 10 }{ 15 }
+    \frac{ 16 }{ 15 }
+    >>> from pymath.render import txt
+    >>> Expression.set_render(txt)
+    >>> for i in ajout_fractions.simpliy():
+    ...     print(i)
+    ...
+    2 / 5 + 2 / 3
+    2 * 3 / 5 * 3 + 2 * 5 / 3 * 5
+    ( 6 + 10 ) / 15
+    16 / 15
+
+
 Ce module a pour but d'être un outil pour faciliter la construction d'exercices et leurs correction. Il a pour but d'être le plus simple possible d'utilisation afin que tout le monde avec un minimum de connaissance en programmation puisse créer librement des exercices. 
 
 ## Calculer comme un collégien.
 
-Actuellement le module pour faire calculer python comme un collégien est *pymath.expression*.
+Actuellement le module principal pour faire calculer python comme un collégien est *pymath.expression*.
 
     >>> from pymath.expression import Expression
 
 
 ### Déclarer une expression 
-Un expression peut être initialisée de deux façons différentes: à partir d'une chaine de caractères ou à partir de la liste des termes (en postfix).
+Un expression peut être initialisée de deux façons différentes: à partir d'une chaine de caractères ou à partir de la liste des termes (en postfix - cette méthode est essentiellement utilisée pour programmer les modules, elle ne sera pas détaillée ici).
 
-    >>> exp = Expression("1 + 2 * 3")
+    >>> un_calcul = Expression("1 + 2 * 3")
-    >>> from pymath.operator import pw, mul
+    >>> print(un_calcul)
-    >>> exp = Expression([2, 3, pw, 5, mul])
-
-On peut ensuite afficher l'expression avec un *print*.
-
-    >>> print(exp)
     1 + 2 \times 3
+    >>> ajout_fractions = Expression("2 / 5 + 2 / 3")
+    >>> print(ajout_fractions)
+    \frac{ 2 }{ 5 } + \frac{ 2 }{ 3 }
 
 Et si l'on souhaite un rendu plus adapté à la console:
 
     >>> from pymath.render import txt
     >>> Expression.set_render(txt)
-    >>> exp.render()
+    >>> un_calcul.render()
     1 + 2 * 3
+    >>> print(ajout_fractions)
+    2 / 5 + 2 / 3
 
 ### Simplification des expressions
 Une fois les expressions créées, elles peuvent se réduire en expliquant les étapes et en respectant les règles de priorités. Les exemples suivants seront données avec un rendu texte.
@@ -76,8 +119,43 @@ Les opérations autorisées sont les opérations "classique": + - * / ^. L'utili
     6 * ( -5 )
     -30
 
+### Type de variables et opérations
+On peut vouloir créer directement des objets (fractions ou polynômes) sans passer par le module expression (voir [fraction](fraction.mdwn) et [polynom](polynom.mdwn) pour plus de details)
+
+    >>> from pymath.fraction import Fraction
+    >>> fraction1 = Fraction(1,2)
+    >>> fraction2 = Fraction(2,3)
+    >>> print(fraction1)
+
+    >>> from pymath.polynom import Polynom
+    >>> p = Polynom([1,2,3])
+    >>> print(p)
+    3 x ^ 2 + 2 x + 1
+    >>> q = Polynom([0,0,1])
+    x ^ 2
+
+Contrairement aux opérations sur les Expressions, qui renvoient une nouvelle expression
+
+    >>> fraction_expression = Expression("2 / 3")
+    >>> autre_fraction_expression = Expression("4 / 9")
+    >>> print(fraction_expression + autre_fraction_expression)
+    2 / 3 + 4 / 9
+
+les opérations sur les fractions ou les polynômes renvoient la liste des étapes jusqu'à leur forme simplifiée
+
+    >>> p + q
+    [< Polynom [[1, 0], [2, 0], [3, 1]]>, < Polynom [1, 2, < Expression [3, 1, '+']>]>, < Polynom [1, 2, 4]>
+    >>> for i in (p+q):
+    ...     print(i)
+    ...
+    3 x ^ 2 + x ^ 2 + 2 x + 1
+    ( 3 + 1 ) x ^ 2 + 2 x + 1
+    4 x ^ 2 + 2 x + 1
+
 ### Différents rendus
-Comme dit dans l'introduction, il y a deux types de rendus: un rendu texte (utilisé depuis le début) et un rendu latex. Voici un exemple de l'utilisation du rendu latex (par défaut)
+Comme dit dans l'introduction, il y a deux types de rendus: un rendu texte (utilisé depuis le début) et un rendu latex. 
+
+Voici un exemple de l'utilisation du rendu latex (par défaut). 
 
     >>> exp = Expression("1 + 2 / 5")
     >>> for i in exp.simplify():
@@ -88,6 +166,21 @@ Comme dit dans l'introduction, il y a deux types de rendus: un rendu texte (util
     \frac{ 5  +  2 }{ 5 }
     \frac{ 7 }{ 5 }
 
+Pour changer le rendu, on import le rendu depuis *pymath.render* et on appelle la méthode de classe d'Expression *set_render*.
+
+Voici un exemple d'utilisation du rendu txt
+
+    >>> from pymath.render import txt
+    >>> Expression.set_render(txt)
+    >>> exp = Expression("1 + 2 / 5")
+    >>> for i in exp.simplify():
+    ...     print(i)
+    ... 
+    2 / 5 + 2 / 3
+    2 * 3 / 5 * 3 + 2 * 5 / 3 * 5
+    ( 6 + 10 ) / 15
+    16 / 15
+
 
 ## Générer des expressions aléatoirement.