From 8189116ea4b5db4675e31dfd04a5687d55e29262 Mon Sep 17 00:00:00 2001 From: Eduardo Pedroni Date: Tue, 6 May 2014 14:29:37 +0100 Subject: Added javadocs, made minor changes to the comments --- .../backend/modules/es/EvolutionaryStrategy.html | 290 ++++++++++++++++++ doc/jcgp/backend/modules/es/MuPlusLambda.html | 330 ++++++++++++++++++++ .../backend/modules/es/TournamentSelection.html | 333 +++++++++++++++++++++ .../modules/es/class-use/EvolutionaryStrategy.html | 213 +++++++++++++ .../backend/modules/es/class-use/MuPlusLambda.html | 124 ++++++++ .../modules/es/class-use/TournamentSelection.html | 124 ++++++++ doc/jcgp/backend/modules/es/package-frame.html | 22 ++ doc/jcgp/backend/modules/es/package-summary.html | 162 ++++++++++ doc/jcgp/backend/modules/es/package-tree.html | 146 +++++++++ doc/jcgp/backend/modules/es/package-use.html | 180 +++++++++++ 10 files changed, 1924 insertions(+) create mode 100644 doc/jcgp/backend/modules/es/EvolutionaryStrategy.html create mode 100644 doc/jcgp/backend/modules/es/MuPlusLambda.html create mode 100644 doc/jcgp/backend/modules/es/TournamentSelection.html create mode 100644 doc/jcgp/backend/modules/es/class-use/EvolutionaryStrategy.html create mode 100644 doc/jcgp/backend/modules/es/class-use/MuPlusLambda.html create mode 100644 doc/jcgp/backend/modules/es/class-use/TournamentSelection.html create mode 100644 doc/jcgp/backend/modules/es/package-frame.html create mode 100644 doc/jcgp/backend/modules/es/package-summary.html create mode 100644 doc/jcgp/backend/modules/es/package-tree.html create mode 100644 doc/jcgp/backend/modules/es/package-use.html (limited to 'doc/jcgp/backend/modules/es') diff --git a/doc/jcgp/backend/modules/es/EvolutionaryStrategy.html b/doc/jcgp/backend/modules/es/EvolutionaryStrategy.html new file mode 100644 index 0000000..d18e01f --- /dev/null +++ b/doc/jcgp/backend/modules/es/EvolutionaryStrategy.html @@ -0,0 +1,290 @@ + + + + + +EvolutionaryStrategy + + + + + + + + +
+ + + + + + + +
+ + + +
+
jcgp.backend.modules.es
+

Class EvolutionaryStrategy

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    MuPlusLambda, TournamentSelection
    +
    +
    +
    +
    public abstract class EvolutionaryStrategy
    +extends Module
    +
    This class specifies the characteristics of an evolutionary strategy. The evolutionary + strategy's job is to generate the next population of solutions. In JCGP this is done by modifying + the provided population object rather than creating a new one. +

    + A typical implementation of EvolutionaryStratey iterates through the chromosomes + in the population and selects the individual(s) to be promoted. It then uses + mutator.mutate() to generically mutate the promoted individual(s). Parameter-dependent + strategies can be implemented by accessing the parameters via the resources + argument. +

    + Parameters may be specified to control the implemented strategy. Any parameters + registered with registerParameters() should be displayed by the user interface, + if it is being used. See Module for more information. +

    + It is advisable to use Resources.reportln() and Resources.report() + to print any relevant information. Note that reportln() and report() are affected + by the report interval base parameter. Use Resources.println() and + Resources.print() to print information regardless of the current generation. + See Resources for more information.
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    See Also:
    +
    Module
    +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      abstract voidevolve(Population population, + Mutator mutator) +
      Performs the selection algorithm and uses the mutator to create + the next generation of solutions.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        evolve

        +
        public abstract void evolve(Population population,
        +                            Mutator mutator)
        +
        Performs the selection algorithm and uses the mutator to create + the next generation of solutions.
        +
        +
        Parameters:
        +
        population - the population to evolve.
        +
        mutator - the mutator with which to mutate the promoted individuals.
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/doc/jcgp/backend/modules/es/MuPlusLambda.html b/doc/jcgp/backend/modules/es/MuPlusLambda.html new file mode 100644 index 0000000..3ca75c9 --- /dev/null +++ b/doc/jcgp/backend/modules/es/MuPlusLambda.html @@ -0,0 +1,330 @@ + + + + + +MuPlusLambda + + + + + + + + +
+ + + + + + + +
+ + + +
+
jcgp.backend.modules.es
+

Class MuPlusLambda

+
+
+ +
+
    +
  • +
    +
    +
    public class MuPlusLambda
    +extends EvolutionaryStrategy
    +
    (μ + λ)-ES +

    + This strategy selects the μ fittest chromosomes from the population. + The promoted individuals are copied into the new population and mutated + λ times, but also carried forward unchanged. The total population size + is μ + λ. +

    + Two integer parameters are used to control this strategy: parents + and offspring. They are constrained in that they must always add up to + the population size, and must never be smaller than 1. +
    + One additional parameter, report, controls whether a detailed log of the + algorithm's operation is to be printed or not. Reports respect the report + interval base parameter.
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    See Also:
    +
    EvolutionaryStrategy
    +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MuPlusLambda(Resources resources) +
      Creates a new instance of MuPlusLambda.
      +
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidevolve(Population population, + Mutator mutator) +
      Performs the selection algorithm and uses the mutator to create + the next generation of solutions.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MuPlusLambda

        +
        public MuPlusLambda(Resources resources)
        +
        Creates a new instance of MuPlusLambda.
        +
        +
        Parameters:
        +
        resources - a reference to the experiment's resources.
        +
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        evolve

        +
        public void evolve(Population population,
        +                   Mutator mutator)
        +
        Description copied from class: EvolutionaryStrategy
        +
        Performs the selection algorithm and uses the mutator to create + the next generation of solutions.
        +
        +
        Specified by:
        +
        evolve in class EvolutionaryStrategy
        +
        Parameters:
        +
        population - the population to evolve.
        +
        mutator - the mutator with which to mutate the promoted individuals.
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/doc/jcgp/backend/modules/es/TournamentSelection.html b/doc/jcgp/backend/modules/es/TournamentSelection.html new file mode 100644 index 0000000..59e63cd --- /dev/null +++ b/doc/jcgp/backend/modules/es/TournamentSelection.html @@ -0,0 +1,333 @@ + + + + + +TournamentSelection + + + + + + + + +
+ + + + + + + +
+ + + +
+
jcgp.backend.modules.es
+

Class TournamentSelection

+
+
+ +
+
    +
  • +
    +
    +
    public class TournamentSelection
    +extends EvolutionaryStrategy
    +
    Tournament selection +

    + This strategy generates a new population by selecting a specified number + of chromosomes from the original population and selecting the fittest out + of the isolated subset (the tournament). The selected individual is mutated + using the specified mutator. This process is repeated until the new population + is complete. +

    + One integer parameter is used to control this strategy: tournament + size. This must always be greater than 0 and smaller than or equal to the + population size. Setting it to equal population size results in the same + chromosome being selected for every tournament, and setting it to 1 leads + to an effectively random search. +
    + One additional parameter, report, controls whether a detailed log of the + algorithm's operation is to be printed or not. Reports respect the report + interval base parameter.
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    See Also:
    +
    EvolutionaryStrategy
    +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      TournamentSelection(Resources resources) +
      Creates a new instance of TournamentSelection.
      +
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidevolve(Population population, + Mutator mutator) +
      Performs the selection algorithm and uses the mutator to create + the next generation of solutions.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TournamentSelection

        +
        public TournamentSelection(Resources resources)
        +
        Creates a new instance of TournamentSelection.
        +
        +
        Parameters:
        +
        resources - a reference to the experiment's resources.
        +
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        evolve

        +
        public void evolve(Population population,
        +                   Mutator mutator)
        +
        Description copied from class: EvolutionaryStrategy
        +
        Performs the selection algorithm and uses the mutator to create + the next generation of solutions.
        +
        +
        Specified by:
        +
        evolve in class EvolutionaryStrategy
        +
        Parameters:
        +
        population - the population to evolve.
        +
        mutator - the mutator with which to mutate the promoted individuals.
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/doc/jcgp/backend/modules/es/class-use/EvolutionaryStrategy.html b/doc/jcgp/backend/modules/es/class-use/EvolutionaryStrategy.html new file mode 100644 index 0000000..ed70f1e --- /dev/null +++ b/doc/jcgp/backend/modules/es/class-use/EvolutionaryStrategy.html @@ -0,0 +1,213 @@ + + + + + +Uses of Class jcgp.backend.modules.es.EvolutionaryStrategy + + + + + + + + +
+ + + + + + + +
+ + +
+

Uses of Class
jcgp.backend.modules.es.EvolutionaryStrategy

+
+
+ +
+ +
+ + + + + + + +
+ + + + diff --git a/doc/jcgp/backend/modules/es/class-use/MuPlusLambda.html b/doc/jcgp/backend/modules/es/class-use/MuPlusLambda.html new file mode 100644 index 0000000..7b38f2a --- /dev/null +++ b/doc/jcgp/backend/modules/es/class-use/MuPlusLambda.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class jcgp.backend.modules.es.MuPlusLambda + + + + + + + + +
+ + + + + + + +
+ + +
+

Uses of Class
jcgp.backend.modules.es.MuPlusLambda

+
+
No usage of jcgp.backend.modules.es.MuPlusLambda
+ +
+ + + + + + + +
+ + + + diff --git a/doc/jcgp/backend/modules/es/class-use/TournamentSelection.html b/doc/jcgp/backend/modules/es/class-use/TournamentSelection.html new file mode 100644 index 0000000..3de5cbb --- /dev/null +++ b/doc/jcgp/backend/modules/es/class-use/TournamentSelection.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class jcgp.backend.modules.es.TournamentSelection + + + + + + + + +
+ + + + + + + +
+ + +
+

Uses of Class
jcgp.backend.modules.es.TournamentSelection

+
+
No usage of jcgp.backend.modules.es.TournamentSelection
+ +
+ + + + + + + +
+ + + + diff --git a/doc/jcgp/backend/modules/es/package-frame.html b/doc/jcgp/backend/modules/es/package-frame.html new file mode 100644 index 0000000..2341ef5 --- /dev/null +++ b/doc/jcgp/backend/modules/es/package-frame.html @@ -0,0 +1,22 @@ + + + + + +jcgp.backend.modules.es + + + + + +

jcgp.backend.modules.es

+
+

Classes

+ +
+ + diff --git a/doc/jcgp/backend/modules/es/package-summary.html b/doc/jcgp/backend/modules/es/package-summary.html new file mode 100644 index 0000000..bb760c8 --- /dev/null +++ b/doc/jcgp/backend/modules/es/package-summary.html @@ -0,0 +1,162 @@ + + + + + +jcgp.backend.modules.es + + + + + + + + +
+ + + + + + + +
+ + +
+

Package jcgp.backend.modules.es

+
+
+ +
+ +
+ + + + + + + +
+ + + + diff --git a/doc/jcgp/backend/modules/es/package-tree.html b/doc/jcgp/backend/modules/es/package-tree.html new file mode 100644 index 0000000..5ebca47 --- /dev/null +++ b/doc/jcgp/backend/modules/es/package-tree.html @@ -0,0 +1,146 @@ + + + + + +jcgp.backend.modules.es Class Hierarchy + + + + + + + + +
+ + + + + + + +
+ + +
+

Hierarchy For Package jcgp.backend.modules.es

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + + + +
+ + + + diff --git a/doc/jcgp/backend/modules/es/package-use.html b/doc/jcgp/backend/modules/es/package-use.html new file mode 100644 index 0000000..a9a2c2d --- /dev/null +++ b/doc/jcgp/backend/modules/es/package-use.html @@ -0,0 +1,180 @@ + + + + + +Uses of Package jcgp.backend.modules.es + + + + + + + + +
+ + + + + + + +
+ + +
+

Uses of Package
jcgp.backend.modules.es

+
+
+ +
+ +
+ + + + + + + +
+ + + + -- cgit v1.2.3