main doc page for EDO

edo/doc/edo_design.svg

@@ -15,7 +15,10 @@
      id="svg2"
      version="1.1"
      inkscape:version="0.48.3.1 r9886"
-     sodipodi:docname="edo_design.svg">
+     sodipodi:docname="edo_design.svg"
+     inkscape:export-filename="/home/nojhan/code/eodev/edo/doc/edo_design.png"
+     inkscape:export-xdpi="72"
+     inkscape:export-ydpi="72">
     <defs
          id="defs4">
         <linearGradient
@@ -1069,10 +1072,10 @@
          inkscape:document-units="px"
          inkscape:current-layer="layer1"
          showgrid="false"
-         inkscape:window-width="1914"
+         inkscape:window-width="1674"
-         inkscape:window-height="1126"
+         inkscape:window-height="1024"
-         inkscape:window-x="1280"
+         inkscape:window-x="0"
-         inkscape:window-y="44"
+         inkscape:window-y="20"
          inkscape:window-maximized="0"
          showguides="true"
          inkscape:guide-bbox="true" />
@@ -2262,11 +2265,11 @@
              sodipodi:cy="222.00841"
              sodipodi:rx="128.4122"
              sodipodi:ry="128.4122"
-             d="M 482.90222,222.00841 A 128.4122,128.4122 0 1 1 226.07782,222.00841 128.4122,128.4122 0 1 1 482.90222,222.00841 z"
+             d="M 482.90222,222.00841 C 482.90222,292.92851 425.41012,350.42061 354.49002,350.42061 283.56992,350.42061 226.07782,292.92851 226.07782,222.00841 226.07782,151.08831 283.56992,93.596207 354.49002,93.596207 425.41012,93.596207 482.90222,151.08831 482.90222,222.00841 z"
              transform="matrix(-0.8478417,-0.4458214,0.4458214,-0.8478417,609.94741,1104.1948)" />
         <path
              transform="matrix(0.1883149,-0.9392176,0.9392176,0.1883149,133.10211,1049.0633)"
-             d="M 482.90222,222.00841 A 128.4122,128.4122 0 1 1 226.07782,222.00841 128.4122,128.4122 0 1 1 482.90222,222.00841 z"
+             d="M 482.90222,222.00841 C 482.90222,292.92851 425.41012,350.42061 354.49002,350.42061 283.56992,350.42061 226.07782,292.92851 226.07782,222.00841 226.07782,151.08831 283.56992,93.596207 354.49002,93.596207 425.41012,93.596207 482.90222,151.08831 482.90222,222.00841 z"
              sodipodi:ry="128.4122"
              sodipodi:rx="128.4122"
              sodipodi:cy="222.00841"
@@ -2282,7 +2285,7 @@
              sodipodi:cy="222.00841"
              sodipodi:rx="128.4122"
              sodipodi:ry="128.4122"
-             d="M 482.90222,222.00841 A 128.4122,128.4122 0 1 1 226.07782,222.00841 128.4122,128.4122 0 1 1 482.90222,222.00841 z"
+             d="M 482.90222,222.00841 C 482.90222,292.92851 425.41012,350.42061 354.49002,350.42061 283.56992,350.42061 226.07782,292.92851 226.07782,222.00841 226.07782,151.08831 283.56992,93.596207 354.49002,93.596207 425.41012,93.596207 482.90222,151.08831 482.90222,222.00841 z"
              transform="matrix(0.17128,1.0278995,1.0278995,-0.17128,119.45267,431.57306)" />
         <path
              inkscape:connector-curvature="0"

edo/doc/edo_distrib.svg

@@ -15,7 +15,10 @@
      id="svg2"
      version="1.1"
      inkscape:version="0.48.3.1 r9886"
-     sodipodi:docname="edo_distrib.svg">
+     sodipodi:docname="edo_distrib.svg"
+     inkscape:export-filename="/home/nojhan/code/eodev/edo/doc/edo_distrib.png"
+     inkscape:export-xdpi="72"
+     inkscape:export-ydpi="72">
     <title
          id="title10002">EDO distribution coupling</title>
     <defs
@@ -1937,10 +1940,10 @@
          inkscape:document-units="px"
          inkscape:current-layer="layer1"
          showgrid="false"
-         inkscape:window-width="1914"
+         inkscape:window-width="1674"
-         inkscape:window-height="1126"
+         inkscape:window-height="1024"
-         inkscape:window-x="1280"
+         inkscape:window-x="0"
-         inkscape:window-y="44"
+         inkscape:window-y="20"
          inkscape:window-maximized="0"
          showguides="false"
          inkscape:guide-bbox="true"

edo/doc/index.h

@@ -0,0 +1,39 @@
+/** @mainpage Welcome to Evolving Distribution Objects
+
+@section shortcuts In one word
+
+%EDO is an extension of %EO oriented toward Estimation-of-Distribution-like
+Algorithms.
+
+You can search for advanced features by browsing the <a
+href="modules.html">modules</a> page.
+
+@section intro Introduction
+
+%EDO is an extension of %EO, that facilitate the design and implementation of
+stochastic search metaheuristics. It is based on the assumption that those
+algorithms are updating a probability distribution, that is used to generate
+a sample (a population, in %EO) of solutions (individuals, in %EO).
+
+Basically, EDO decompose the <em>variation</em> operators of %EO in a set of
+sub-operators that are binded by a <em>distribution</em>. Thus, most of the
+representation-independent operators of %EO can be used in %EDO algorithms.
+
+Apart from choosing which distribution he want to use as a model, the user is
+not supposed to directly manipulate it. Using the same approach than within %EO,
+the user has just to indicate what he want to use, without having to bother how
+he want to use it.
+
+On the designer side, it is still possible to implement specific operators
+without having to change other ones.
+
+<img src="edo_design.png" />
+
+The two main operators are the <em>Estimators</em>, that builds a given
+distribution according to a population and the <em>Samplers</em> that builds a
+population according to a distribution. There is also <em>Modifiers</em> that
+are here to change arbitrarily the parameters of a distribution, if necessary.
+
+<img src="edo_distrib.png" />
+
+*/

eo/doc/index.h

@@ -5,7 +5,7 @@
 The best place to learn about the features and approaches of %EO with the help of examples is to look at
 the <a href="../../tutorial/html/eoTutorial.html">tutorial</a>.
 
-Once you have understand the @ref design of %EO, you could search for advanced features by browsing the <a
+Once you have understand the @ref design of %EO, you can search for advanced features by browsing the <a
 href="modules.html">modules</a> page.