update docs

TODO.md

@@ -84,10 +84,16 @@
 ### Week 3: (6 Nov 23)
 
 - [x] Ast2logic: if-then-else statement
-- [ ] Midterm call
+- [x] Midterm call
+- [x] Bool optimization refactoring
 
 ### Week 4: (13 Nov 23)
 
+- [ ] Cirq exporter
+- [ ] Improve exporting utilities
+- [ ] Use cases
+- [ ] Documentation
+
 ## Month 3:
 
 ### Week 1: (20 Nov 23)

docs/source/algorithms.rst

@@ -0,0 +1,2 @@
+Algorithms
+====================================

docs/source/howitworks.rst

@@ -6,7 +6,8 @@ In order to translate python code to quantum circuit, qlasskit performs several
 1. it starts from the python *AST* (abstract syntax tree) rewriting it to a simplified version 
 by the _ast2ast_ module. 
 2. Then the simplified *AST* is translated to *boolean expressions* as intermediate
-form by the _ast2logic_ module. 
+form by the _ast2logic_ module. In this step, boolean expression are simplified and optimized
+for the final transformation.
 3. Finally, these boolean expressions are compiled into a *quantum circuit* by the _compiler_ module.
 
 While other existing libraries translate individual operations into quantum circuits and then 
@@ -104,10 +105,11 @@ Result
 ------
 
 The result of the compiler is a quantum circuit represented with qlasskit `QCircuit`. This circuit
-can now be exported to one of the supported framework.
+can now be exported to one of the supported framework as a gate or as a standalone circuit.
 
 
-The previous example function `f`, is translated to the following quantum circuit:
+The previous example function `f`, is translated to the following quantum circuit: the 
+result is available at qubit `_re`.
 
 
 .. code-block:: text
@@ -120,10 +122,10 @@ The previous example function `f`, is translated to the following quantum circui
                 │  ├───┤  │  └───┘├───┤  │    │  └───┘
       n.3: ─────┼──┤ X ├──┼────■──┤ X ├──┼────┼───────
                 │  └───┘  │  ┌─┴─┐└───┘  │    │       
-      a_4: ─────┼─────────┼──┤ X ├───────┼────┼───────
+      _re: ─────┼─────────┼──┤ X ├───────┼────┼───────
               ┌─┴─┐       │  └─┬─┘       │  ┌─┴─┐     
-      a_5: ───┤ X ├───────■────┼─────────■──┤ X ├─────
+      a_4: ───┤ X ├───────■────┼─────────■──┤ X ├─────
               └───┘     ┌─┴─┐  │       ┌─┴─┐└───┘     
-      _re: ─────────────┤ X ├──■───────┤ X ├──────────
+      a_5: ─────────────┤ X ├──■───────┤ X ├──────────
                         └───┘          └───┘          
 

docs/source/index.rst

@@ -6,21 +6,13 @@ Python and translate them into unitary operators (gates) for use in quantum circ
 
 
 
-.. :doc:`howitworks`
-..     How qlasskit internally works
-
-.. :doc:`qlassf`
-..     QlassF class
-
-.. :doc:`qcircuit`
-..     QCircuit class
-
 .. toctree::
    :maxdepth: 2
 
    howitworks
    supported
    qlassf
+   algorithms
    types
    qcircuit
 

docs/source/supported.rst

@@ -148,12 +148,12 @@ Function call
 
 Bultin functions:
 - `print()`: debug function, ignore by conversion
-- `len(Tuple)`: returns the length of a tuple
-- `max(a, b, ...)`, `max(Tuple)`: returns the max of a tuple
-- `min(a, b, ...)`, `min(Tuple)`: returns the min of a tuple
-.. - `sum(Tuple)`: returns the sum of the elemnts of a tuple
-.. - `all(a, b, ...)`, `all(Tuple)`:
-.. - `any(a, b, ...)`, `any(Tuple)`:
+- `len(Tuple)`, `len(Qlist)``: returns the length of a tuple
+- `max(a, b, ...)`, `max(Tuple)`, `max(Qlist)`: returns the max of a tuple
+- `min(a, b, ...)`, `min(Tuple)`, `min(Qlist)`: returns the min of a tuple
+- `sum(Tuple)`, `sum(Qlist)`: returns the sum of the elemnts of a tuple / list
+- `all(Tuple)`, `all(Qlist)`: returns True if all of the elemnts are True
+- `any(Tuple)`, `any(Qlist)`: returns True if any of the elemnts are True
 
 
 
@@ -191,4 +191,16 @@ Function def
 .. code-block:: python
 
    def f(t: Qlist[Qint4,2]) -> Qint4:
-      return t[0] + t[1]
+      return t[0] + t[1]
+
+
+If then else
+^^^^^^^^^^^^
+
+.. code-block:: python
+
+   c = 0
+   if cond:
+      c += 12
+   else:
+      c += 13