Add tutorial READMEs and fix tutorial return codes

Add README.md files for moeo/tutorial/Lesson{1-4}, smp/tutorial/Lesson{1-4},
and mo/tutorial/Lesson9 — these tutorials had no documentation.

Fix return 1 → return 0 in 28 tutorial main() functions across mo/ and
smp/ that unconditionally returned failure status.
This commit is contained in:
Eremey Valetov 2026-02-28 19:24:05 -05:00
commit c1a44fd2a6
37 changed files with 371 additions and 30 deletions

View file

@ -0,0 +1,23 @@
# Master/Workers wrapping with eoEasyEA
Wraps a standard eoEasyEA with the ParadisEO-SMP parallel evaluation model,
applied to the Quadratic Assignment Problem (QAP).
The QAP assigns facilities to locations to minimize cost (flow x distance).
The representation is a permutation.
## Running
From the `build/smp/tutorial/Lesson1` directory:
```shell
./lesson1_eoEasyEA lesson1_eoEasyEA.param
```
## How it works
The key idea: ParadisEO-SMP parallelizes evaluation by wrapping an existing
sequential algorithm. The algorithm code itself stays the same. `QAP.h`
defines the problem representation and evaluation, `QAPGA.h` defines the GA
operators, and `parserStruct.h` + `utils.h` handle parameter parsing and
instance loading. See also `lesson1_data.dat` for the problem instance.

View file

@ -23,8 +23,8 @@ same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
ParadisEO WebSite : http://paradiseo.gforge.inria.fr
Contact: paradiseo-help@lists.gforge.inria.fr
ParadisEO WebSite : https://nojhan.github.io/paradiseo/
Contact: https://github.com/nojhan/paradiseo/issues
*/
/**
@ -125,5 +125,5 @@ int main(int argc, char **argv)
delete[] b;
return 1;
return 0;
}