lafrite/Mapytex
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge branch 'sphinx' into dev

Browse Source
This commit is contained in:
Lafrite 2015-04-24 09:19:10 +02:00
commit 67efaaee62
8 changed files with 542 additions and 642 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -2,3 +2,4 @@ __pycache__/
*.pyc *.pyc
dist/ dist/
*.egg-info/ *.egg-info/
documentation/build/

55
docs/polynom.mdwn
View File

@ -1,55 +0,0 @@
# Les polynômes
## Créer des polynômes
### Générer un polynôme "fixe"
### Générer un polynôme aléatoirement
>>> P = Polynom.random(["{b}", "{a}"]) # Polynom du type ax + b
>>> print(P)
- 8 x - 3
>>> P = Polynom.random(degree = 2)
>>> print(P)
5 x^{ 2 } + 4 x - 7
## Manipuler des polynômes
### Les représentations des polynômes
>>> P = Polynom([1, 2, 3])
>>> print(P)
### Évaluer des polynômes
>>> type(P(3))
pymath.expression.Expression
>>> for i in P(3).simplify():
print(i)
3 \times 3^{ 2 } + 2 \times 3 + 1
3 \times 9 + 6 + 1
27 + 6 + 1
33 + 1
34
>>> P(3).simplified()
34
### Opération et polynômes
>>> type(P + 1)
list
>>> for i in (P+1):
print(i)
3 x^{ 2 } + 2 x + 1 + 1
3 x^{ 2 } + 2 x + 1 + 1
3 x^{ 2 } + 2 x + 2
>>> Q = Polynom([4, 5, 6])
>>> for i in (P+Q):
print(i)
3 x ^ 2 + 6 x ^ 2 + 2 x + 5 x + 1 + 4
( 3 + 6 ) x ^ 2 + ( 2 + 5 ) x + 1 + 4
9 x ^ 2 + 7 x + 5

253
docs/tutorial.mdwn
View File

@ -1,253 +0,0 @@
# Utilisation de pyMath
## À quoi sert pyMath?
pyMath est un module python qui permet la manipulation d'expressions mathématiques. Voici ce qu'il est capable de faire:
* *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 import Expression
>>> ajout_fractions = Expression("2 / 5 + 2 / 3")
>>> resultat = ajout_fractions.simplify()
>>> print(resultat)
\frac{ 16 }{ 15 }
>>> for i in resultat.explain():
... 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.
>>> from pymath 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 import Fraction
>>> une_fraction = Fraction(1,2)
>>> print(une_fraction)
1 / 2
>>> from pymath 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 import Expression
>>> ajout_fractions = Expression("2 / 5 + 2 / 3")
>>> for i in ajout_fractions.simpliy().explain():
... 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 import txt
>>> with Expression.tmp_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 principal pour faire calculer python comme un collégien est *pymath.expression*.
>>> from pymath 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 - cette méthode est essentiellement utilisée pour programmer les modules, elle ne sera pas détaillée ici).
>>> un_calcul = Expression("1 + 2 * 3")
>>> print(un_calcul)
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 import txt
>>> Expression.set_render(txt)
>>> 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. Ces étapes de calcul sont stockés dans l'objet résultat du calcul et sont accéssibles à travers la méthode *explain*.
Les exemples suivants seront données avec un rendu texte.
>>> from pymath import Expression
>>> from pymath import txt
>>> Expression.set_render(txt)
>>> exp = Expression("1 + 2 * 3")
>>> exp_simplifiee = exp.simplify()
>>> print(exp_simplifiee)
7
>>> for i in exp_simplifiee.explain():
... print(i)
...
1 + 2 * 3
1 + 6
7
Les opérations autorisées sont les opérations "classique": + - * / ^. L'utilisation des parenthèses est aussi gérée.
>>> exp = Expression("1 + 2 / 5")
>>> for i in exp.simplify().explain():
... print(i)
...
1 + 2 / 5
( 1 * 5 ) / ( 1 * 5 ) + ( 2 * 1 ) / ( 5 * 1 )
( 5 + 2 ) / 5
7 / 5
>>> exp = Expression("(2 + 4)(3 - 4 * 2)")
>>> for i in exp.simplify().explain():
... print(i)
...
( 2 + 4 ) ( 3 - ( 4 * 2 ) )
6 * ( 3 - 8 )
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 import Fraction
>>> fraction1 = Fraction(1,2)
>>> fraction2 = Fraction(2,3)
>>> print(fraction1)
1 / 2
>>> from pymath import Polynom
>>> p = Polynom([1,2,3])
>>> print(p)
3 x ^ 2 + 2 x + 1
>>> q = Polynom([0,0,1])
x ^ 2
On peut effectuer des opérations entre les Expressions.
>>> 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
>>> addition_fraction = fraction1 + fraction2
>>> print(addition_fraction)
7 / 6
>>> for i in addition_fraction.explain():
... print(i)
...
1 * 3 / 2 * 3 + 2 * 2 / 3 * 2
( 3 + 4 ) / 6
7 / 6
>>> r = p + q
>>> print(r)
4 x ^ 2 + 2 x + 1
>>> for i in r.explain():
... 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).
>>> exp = Expression("1 + 2 / 5")
>>> for i in exp.simplify().explain():
... print(i)
...
1 + \frac{ 2 }{ 5 }
\frac{ 1 \times 5 }{ 1 \times 5 } + \frac{ 2 \times 1 }{ 5 \times 1 }
\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 import txt
>>> Expression.set_render(txt)
>>> exp = Expression("1 + 2 / 5")
>>> for i in exp.simplify().explain():
... 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.
### Créer un expression
Pour créer une expression il faut au moins une chose: la forme de l'expression. Toutes les lettres entre accolades seront remplacées par des valeurs aléatoires (par défaut entre -10 et 10 et non nulles).
>>> form = "2* {a} + 3"
>>> expression_aleatoire = Expression.random(form)
>>> print(expression_aleatoire)
'2 \times 9 + 3'
>>> print(Expression.random(form,val_min = 30, val_max = 40))
'2 \times 31 + 3'
### Créer une expression avec conditions
Parfois il peut être nécessaire d'imposer des conditions sur les éléments à générer pour créer des exercices spécifiques.
>>> form = "{a} / {b} + {c} / {d}"
>>> conditions = ["abs({b}) != 1", "{d} > 1", "{b} != {d}", "gcd({a},{b}) == 1", "gcd({c},{d}) == 1"]
>>> addition_fraction_alea = Expression.random(form, conditions)
>>> print(addition_fraction_alea)
'\frac{ 4 }{ 5 } + \frac{ 9 }{ 7 }'
La méthode pour créer les valeurs avec des conditions est la méthode par rejet. Elle n'est pas très efficace et rien n'est encore prévu dans le cas où aucune valeur n'est possible.
### Opérations avec les valeurs générées
Pour éviter de faire tourner la méthode par rejet trop longtemps, il est possible de faire des calculs avec les valeurs générées.
>>> form = "{a} / {b} + {c} / {k*b}"
>>> conditions = ["abs({b}) != 1", "{k} > 1", "{b} != {d}", "gcd({a},{b}) == 1", "gcd({c},{k*b}) == 1"]
>>> random_frac_add_generator = RdExpression(form, conditions)
>>> print(random_frac_add_generator())
'\frac{ -9 }{ 7 } + \frac{ 1 }{ 28 }
### Rendu des expressions
On peut vouloir ne pas passer par la classe Expression pour obtenir notre expression (si l'on veut utiliser la racine carré par exemple, ou pour créer n'importe quoi qui ne fait pas intervenir d'expression). Ainsi pymath ne gère plus le rendu de l'expression ni son calcul.
La fonction qui permet de faire cela est *random_str*:
>>> from pymath import random_str
>>> form = "{a} / {b} + {c} / {k*b}"
>>> conditions = ["abs({b}) != 1", "{d} > 1", "{b} != {d}", "gcd({a},{b}) == 1", "gcd({c},{k*b}) == 1"]
>>> str_addition_fraction = random_str(form, conditions)
>>> type(str_addition_fraction)
str
>>> print(str_addition_fraction)
-2 / 5 + -8 / 35
>>> form = "A({a},{b}), B({2*a}, {3*b})"
>>> points_alea = random_str(form)
>>> points_alea
'A(7,5), B(14, 15)'
On remarque le défaut d'utiliser cette forme, le rendu est moins bien fait (dans l'exemple, il n'y a pas de parenthèses autour du -8).

334
docs/tutorial.rst
View File

@ -1,334 +0,0 @@
Utilisation de pyMath
=====================
À quoi sert pyMath?
-------------------
pyMath est un module python qui permet la manipulation d'expressions
mathématiques. Voici ce qu'il est capable de faire:
- *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.
.. code-block:: python
>>> from pymath import Expression
>>> ajout_fractions = Expression("2 / 5 + 2 / 3")
>>> resultat = ajout_fractions.simplify()
>>> print(resultat)
\frac{ 16 }{ 15 }
>>> for i in resultat.explain():
... print(i)
...
\frac{ 2 }{ 5 } + \frac{ 2 }{ 3 }
\frac{ 2 \times 3 }{ 5 \times 3 } + \frac{ 2 \times 5 }{ 3 \times 5 }
\frac{ 6 }{ 15 } + \frac{ 10 }{ 15 }
\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.
.. code-block:: python
>>> from pymath import Expression
>>> ajout_fraction = Expression.random("{a} + {b} / {c}")
>>> print(ajout_fraction)
2 + \frac{ 3 }{ 5 }
- *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.
.. code-block:: python
>>> from pymath import Fraction
>>> une_fraction = Fraction(1,2)
>>> print(une_fraction)
1 / 2
>>> from pymath 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.
.. code-block:: python
>>> from pymath import Expression
>>> ajout_fractions = Expression("2 / 5 + 2 / 3")
>>> for i in ajout_fractions.simpliy().explain():
... print(i)
...
\frac{ 2 }{ 5 } + \frac{ 2 }{ 3 }
\frac{ 2 \times 3 }{ 5 \times 3 } + \frac{ 2 \times 5 }{ 3 \times 5 }
\frac{ 6 }{ 15 } + \frac{ 10 }{ 15 }
\frac{ 6 + 10 }{ 15 }
\frac{ 16 }{ 15 }
>>> from pymath import txt
>>> with Expression.tmp_render(txt):
... for i in ajout_fractions.simpliy().explain():
... print(i)
...
2 / 5 + 2 / 3
( 2 * 3 ) / ( 5 * 3 ) + ( 2 * 5 ) / ( 3 * 5 )
6 / 15 + 10 / 15
( 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 principal pour faire calculer python comme un
collégien est *pymath.expression*.
.. code-block:: python
>>> from pymath 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 - cette méthode est essentiellement utilisée pour programmer les
modules, elle ne sera pas détaillée ici).
.. code-block:: python
>>> un_calcul = Expression("1 + 2 * 3")
>>> print(un_calcul)
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:
.. code-block:: python
>>> from pymath import txt
>>> Expression.set_render(txt)
>>> print(un_calcul)
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. Ces étapes de
calcul sont stockés dans l'objet résultat du calcul et sont accéssibles
à travers la méthode *explain*. Les exemples suivants seront données
avec un rendu texte.
.. code-block:: python
>>> from pymath import Expression
>>> from pymath import txt
>>> Expression.set_render(txt)
>>> exp = Expression("1 + 2 * 3")
>>> exp_simplifiee = exp.simplify()
>>> print(exp_simplifiee)
7
>>> for i in exp_simplifiee.explain():
... print(i)
...
1 + 2 * 3
1 + 6
7
Les opérations autorisées sont les opérations "classique": + - * / ^.
L'utilisation des parenthèses est aussi gérée.
.. code-block:: python
>>> exp = Expression("1 + 2 / 5")
>>> for i in exp.simplify().explain():
... print(i)
...
1 + 2 / 5
( 1 * 5 ) / ( 1 * 5 ) + ( 2 * 1 ) / ( 5 * 1 )
( 5 + 2 ) / 5
7 / 5
>>> exp = Expression("(2 + 4)(3 - 4 * 2)")
>>> for i in exp.simplify().explain():
... print(i)
...
( 2 + 4 ) ( 3 - ( 4 * 2 ) )
6 * ( 3 - 8 )
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.rst>`__
et `polynom <polynom.rst>`__ pour plus de details)
.. code-block:: python
>>> from pymath import Fraction
>>> fraction1 = Fraction(1,2)
>>> fraction2 = Fraction(2,3)
>>> print(fraction1)
1 / 2
>>> from pymath import Polynom
>>> p = Polynom([1,2,3])
>>> print(p)
3 x ^ 2 + 2 x + 1
>>> q = Polynom([0,0,1])
x ^ 2
On peut effectuer des opérations entre les Expressions.
.. code-block:: python
>>> fraction_expression = Expression("2 / 3")
>>> autre_fraction_expression = Expression("4 / 9")
>>> print(fraction_expression + autre_fraction_expression)
2 / 3 + 4 / 9
On remarque qu'un opération sur des expressions, ne fait pas de calculs.
Elle ne fait que "concaténer" les listes des tokens.
À l'inverse, les opérations sur les fractions ou les polynômes renvoient
la liste des étapes jusqu'à leur forme simplifiée
.. code-block:: python
>>> addition_fraction = fraction1 + fraction2
>>> print(addition_fraction)
7 / 6
>>> for i in addition_fraction.explain():
... print(i)
...
1 * 3 / 2 * 3 + 2 * 2 / 3 * 2
( 3 + 4 ) / 6
7 / 6
>>> r = p + q
>>> print(r)
4 x ^ 2 + 2 x + 1
>>> for i in r.explain():
... 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).
.. code-block:: python
>>> exp = Expression("1 + 2 / 5")
>>> for i in exp.simplify().explain():
... print(i)
...
1 + \frac{ 2 }{ 5 }
\frac{ 1 \times 5 }{ 1 \times 5 } + \frac{ 2 \times 1 }{ 5 \times 1 }
\frac{ 5 + 2 }{ 5 }
\frac{ 7 }{ 5 }
Pour changer le rendu, on importe 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
.. code-block:: python
>>> from pymath import txt
>>> Expression.set_render(txt)
>>> exp = Expression("1 + 2 / 5")
>>> for i in exp.simplify().explain():
... 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.
--------------------------------------
Créer un expression
~~~~~~~~~~~~~~~~~~~
Pour créer une expression il faut au moins une chose: la forme de
l'expression. Toutes les lettres entre accolades seront remplacées par
des valeurs aléatoires (par défaut entre -10 et 10 et non nulles).
.. code-block:: python
>>> form = "2* {a} + 3"
>>> expression_aleatoire = Expression.random(form)
>>> print(expression_aleatoire)
'2 \times 9 + 3'
>>> print(Expression.random(form,val_min = 30, val_max = 40))
'2 \times 31 + 3'
Créer une expression avec conditions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Parfois il peut être nécessaire d'imposer des conditions sur les
éléments à générer pour créer des exercices spécifiques.
.. code-block:: python
>>> form = "{a} / {b} + {c} / {d}"
>>> conditions = ["abs({b}) != 1", "{d} > 1", "{b} != {d}", "gcd({a},{b}) == 1", "gcd({c},{d}) == 1"]
>>> addition_fraction_alea = Expression.random(form, conditions)
>>> print(addition_fraction_alea)
'\frac{ 4 }{ 5 } + \frac{ 9 }{ 7 }'
La méthode pour créer les valeurs avec des conditions est la méthode par
rejet. Elle n'est pas très efficace et rien n'est encore prévu dans le
cas où aucune valeur n'est possible.
Opérations avec les valeurs générées
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Pour éviter de faire tourner la méthode par rejet trop longtemps, il est
possible de faire des calculs avec les valeurs générées.
.. code-block:: python
>>> form = "{a} / {b} + {c} / {k*b}"
>>> conditions = ["abs({b}) != 1", "{k} > 1", "{b} != {d}", "gcd({a},{b}) == 1", "gcd({c},{k*b}) == 1"]
>>> random_frac_add_generator = RdExpression(form, conditions)
>>> print(random_frac_add_generator())
\frac{ -9 }{ 7 } + \frac{ 1 }{ 28 }
Rendu des expressions
~~~~~~~~~~~~~~~~~~~~~
On peut vouloir ne pas passer par la classe Expression pour obtenir
notre expression (si l'on veut utiliser la racine carré par exemple, ou
pour créer n'importe quoi qui ne fait pas intervenir d'expression).
Ainsi pymath ne gère plus le rendu de l'expression ni son calcul.
La fonction qui permet de faire cela est *random_str*:
.. code-block:: python
>>> from pymath import random_str
>>> form = "{a} / {b} + {c} / {k*b}"
>>> conditions = ["abs({b}) != 1", "{d} > 1", "{b} != {d}", "gcd({a},{b}) == 1", "gcd({c},{k*b}) == 1"]
>>> str_addition_fraction = random_str(form, conditions)
>>> type(str_addition_fraction)
str
>>> print(str_addition_fraction)
-2 / 5 + -8 / 35
>>> form = "A({a},{b}), B({2*a}, {3*b})"
>>> points_alea = random_str(form)
>>> points_alea
'A(7,5), B(14, 15)'
On remarque le défaut d'utiliser cette forme, le rendu est moins bien
fait (dans l'exemple, il n'y a pas de parenthèses autour du -8).

177
documentation/Makefile Normal file
View File

@ -0,0 +1,177 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pyMath.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyMath.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/pyMath"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyMath"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

0
docs/construction.rst → documentation/source/construction.rst
View File

0
docs/fraction.mdwn → documentation/source/fraction.rst
View File

364
documentation/source/tutorial.rst Normal file
View File

@ -0,0 +1,364 @@
Utilisation de pyMath
=====================
À quoi sert pyMath?
-------------------
pyMath est un module python qui permet la manipulation d'expressions
mathématiques. Voici ce qu'il est capable de faire:
- *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.
.. code-block:: python
>>> from pymath import Expression
>>> ajout_fractions = Expression("2 / 5 + 2 / 3")
>>> resultat = ajout_fractions.simplify()
>>> print(resultat)
\frac{ 16 }{ 15 }
>>> for i in resultat.explain():
... print(i)
...
\frac{ 2 }{ 5 } + \frac{ 2 }{ 3 }
\frac{ 2 \times 3 }{ 5 \times 3 } + \frac{ 2 \times 5 }{ 3 \times 5 }
\frac{ 6 }{ 15 } + \frac{ 10 }{ 15 }
\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.
.. code-block:: python
>>> from pymath import Expression
>>> ajout_fraction = Expression.random("{a} + {b} / {c}")
>>> print(ajout_fraction)
2 + \frac{ 3 }{ 5 }
- *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.
.. code-block:: python
>>> from pymath import Fraction
>>> une_fraction = Fraction(1,2)
>>> print(une_fraction)
1 / 2
>>> from pymath 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.
.. code-block:: python
>>> from pymath import Expression
>>> ajout_fractions = Expression("2 / 5 + 2 / 3")
>>> for i in ajout_fractions.simpliy().explain():
... print(i)
...
\frac{ 2 }{ 5 } + \frac{ 2 }{ 3 }
\frac{ 2 \times 3 }{ 5 \times 3 } + \frac{ 2 \times 5 }{ 3 \times 5 }
\frac{ 6 }{ 15 } + \frac{ 10 }{ 15 }
\frac{ 6 + 10 }{ 15 }
\frac{ 16 }{ 15 }
>>> from pymath import txt
>>> with Expression.tmp_render(txt):
... for i in ajout_fractions.simpliy().explain():
... print(i)
...
2 / 5 + 2 / 3
( 2 * 3 ) / ( 5 * 3 ) + ( 2 * 5 ) / ( 3 * 5 )
6 / 15 + 10 / 15
( 6 + 10 ) / 15
16 / 15
Le rendu latex permet ensuite d'être directement compiler et par exemple d'avoir le rendu suivant
.. math::
:nowrap:
\frac{ 2 }{ 5 } + \frac{ 2 }{ 3 } \\
\frac{ 2 \times 3 }{ 5 \times 3 } + \frac{ 2 \times 5 }{ 3 \times 5 } \\
\frac{ 6 }{ 15 } + \frac{ 10 }{ 15 } \\
\frac{ 6 + 10 }{ 15 } \\
\frac{ 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 principal pour faire calculer python comme un
collégien est *pymath.expression*.
.. code-block:: python
>>> from pymath 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 - cette méthode est essentiellement utilisée pour programmer les
modules, elle ne sera pas détaillée ici).
.. code-block:: python
>>> un_calcul = Expression("1 + 2 * 3")
>>> print(un_calcul)
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:
.. code-block:: python
>>> from pymath import txt
>>> Expression.set_render(txt)
>>> print(un_calcul)
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. Ces étapes de
calcul sont stockés dans l'objet résultat du calcul et sont accéssibles
à travers la méthode *explain*. Les exemples suivants seront données
avec un rendu texte.
.. code-block:: python
>>> from pymath import Expression
>>> from pymath import txt
>>> Expression.set_render(txt)
>>> exp = Expression("1 + 2 * 3")
>>> exp_simplifiee = exp.simplify()
>>> print(exp_simplifiee)
7
>>> for i in exp_simplifiee.explain():
... print(i)
...
1 + 2 * 3
1 + 6
7
Les opérations autorisées sont les opérations "classique": + - * / ^.
L'utilisation des parenthèses est aussi gérée.
.. code-block:: python
>>> exp = Expression("1 + 2 / 5")
>>> for i in exp.simplify().explain():
... print(i)
...
1 + 2 / 5
( 1 * 5 ) / ( 1 * 5 ) + ( 2 * 1 ) / ( 5 * 1 )
( 5 + 2 ) / 5
7 / 5
>>> exp = Expression("(2 + 4)(3 - 4 * 2)")
>>> for i in exp.simplify().explain():
... print(i)
...
( 2 + 4 ) ( 3 - ( 4 * 2 ) )
6 * ( 3 - 8 )
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>`__
et `polynom <polynom>`__ pour plus de details)
.. code-block:: python
>>> from pymath import Fraction
>>> fraction1 = Fraction(1,2)
>>> fraction2 = Fraction(2,3)
>>> print(fraction1)
1 / 2
>>> from pymath import Polynom
>>> p = Polynom([1,2,3])
>>> print(p)
3 x ^ 2 + 2 x + 1
>>> q = Polynom([0,0,1])
x ^ 2
On peut effectuer des opérations entre les Expressions.
.. code-block:: python
>>> fraction_expression = Expression("2 / 3")
>>> autre_fraction_expression = Expression("4 / 9")
>>> print(fraction_expression + autre_fraction_expression)
2 / 3 + 4 / 9
On remarque qu'un opération sur des expressions, ne fait pas de calculs.
Elle ne fait que "concaténer" les listes des tokens.
À l'inverse, les opérations sur les fractions ou les polynômes renvoient
la liste des étapes jusqu'à leur forme simplifiée
.. code-block:: python
>>> addition_fraction = fraction1 + fraction2
>>> print(addition_fraction)
7 / 6
>>> for i in addition_fraction.explain():
... print(i)
...
1 * 3 / 2 * 3 + 2 * 2 / 3 * 2
( 3 + 4 ) / 6
7 / 6
>>> r = p + q
>>> print(r)
4 x ^ 2 + 2 x + 1
>>> for i in r.explain():
... 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).
.. code-block:: python
>>> exp = Expression("1 + 2 / 5")
>>> for i in exp.simplify().explain():
... print(i)
...
1 + \frac{ 2 }{ 5 }
\frac{ 1 \times 5 }{ 1 \times 5 } + \frac{ 2 \times 1 }{ 5 \times 1 }
\frac{ 5 + 2 }{ 5 }
\frac{ 7 }{ 5 }
Pour changer le rendu, on importe 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
.. code-block:: python
>>> from pymath import txt
>>> Expression.set_render(txt)
>>> exp = Expression("1 + 2 / 5")
>>> for i in exp.simplify().explain():
... 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.
--------------------------------------
Créer un expression
~~~~~~~~~~~~~~~~~~~
Pour créer une expression il faut au moins une chose: la forme de
l'expression. Toutes les lettres entre accolades seront remplacées par
des valeurs aléatoires (par défaut entre -10 et 10 et non nulles).
.. code-block:: python
>>> form = "2* {a} + 3"
>>> expression_aleatoire = Expression.random(form)
>>> print(expression_aleatoire)
'2 \times 9 + 3'
>>> print(Expression.random(form,val_min = 30, val_max = 40))
'2 \times 31 + 3'
Créer une expression avec conditions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Parfois il peut être nécessaire d'imposer des conditions sur les
éléments à générer pour créer des exercices spécifiques.
.. code-block:: python
>>> form = "{a} / {b} + {c} / {d}"
>>> conditions = ["abs({b}) != 1", "{d} > 1", "{b} != {d}", "gcd({a},{b}) == 1", "gcd({c},{d}) == 1"]
>>> addition_fraction_alea = Expression.random(form, conditions)
>>> print(addition_fraction_alea)
'\frac{ 4 }{ 5 } + \frac{ 9 }{ 7 }'
La méthode pour créer les valeurs avec des conditions est la méthode par
rejet. Elle n'est pas très efficace et rien n'est encore prévu dans le
cas où aucune valeur n'est possible.
Opérations avec les valeurs générées
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Pour éviter de faire tourner la méthode par rejet trop longtemps, il est
possible de faire des calculs avec les valeurs générées.
.. code-block:: python
>>> form = "{a} / {b} + {c} / {k*b}"
>>> conditions = ["abs({b}) != 1", "{k} > 1", "{b} != {d}", "gcd({a},{b}) == 1", "gcd({c},{k*b}) == 1"]
>>> random_frac_add_generator = RdExpression(form, conditions)
>>> print(random_frac_add_generator())
\frac{ -9 }{ 7 } + \frac{ 1 }{ 28 }
Rendu des expressions
~~~~~~~~~~~~~~~~~~~~~
On peut vouloir ne pas passer par la classe Expression pour obtenir
notre expression (si l'on veut utiliser la racine carré par exemple, ou
pour créer n'importe quoi qui ne fait pas intervenir d'expression).
Ainsi pymath ne gère plus le rendu de l'expression ni son calcul.
La fonction qui permet de faire cela est *random_str*:
.. code-block:: python
>>> from pymath import random_str
>>> form = "{a} / {b} + {c} / {k*b}"
>>> conditions = ["abs({b}) != 1", "{d} > 1", "{b} != {d}", "gcd({a},{b}) == 1", "gcd({c},{k*b}) == 1"]
>>> str_addition_fraction = random_str(form, conditions)
>>> type(str_addition_fraction)
str
>>> print(str_addition_fraction)
-2 / 5 + -8 / 35
>>> form = "A({a},{b}), B({2*a}, {3*b})"
>>> points_alea = random_str(form)
>>> points_alea
'A(7,5), B(14, 15)'
On remarque le défaut d'utiliser cette forme, le rendu est moins bien
fait (dans l'exemple, il n'y a pas de parenthèses autour du -8).