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/mutator/FixedPointMutator.html | 284 ++++++++++++++++++ doc/jcgp/backend/modules/mutator/Mutator.html | 281 ++++++++++++++++++ .../modules/mutator/PercentPointMutator.html | 285 ++++++++++++++++++ doc/jcgp/backend/modules/mutator/PointMutator.html | 281 ++++++++++++++++++ .../modules/mutator/ProbabilisticMutator.html | 319 +++++++++++++++++++++ .../mutator/class-use/FixedPointMutator.html | 124 ++++++++ .../backend/modules/mutator/class-use/Mutator.html | 269 +++++++++++++++++ .../mutator/class-use/PercentPointMutator.html | 124 ++++++++ .../modules/mutator/class-use/PointMutator.html | 179 ++++++++++++ .../mutator/class-use/ProbabilisticMutator.html | 124 ++++++++ .../backend/modules/mutator/package-frame.html | 24 ++ .../backend/modules/mutator/package-summary.html | 182 ++++++++++++ doc/jcgp/backend/modules/mutator/package-tree.html | 151 ++++++++++ doc/jcgp/backend/modules/mutator/package-use.html | 210 ++++++++++++++ 14 files changed, 2837 insertions(+) create mode 100644 doc/jcgp/backend/modules/mutator/FixedPointMutator.html create mode 100644 doc/jcgp/backend/modules/mutator/Mutator.html create mode 100644 doc/jcgp/backend/modules/mutator/PercentPointMutator.html create mode 100644 doc/jcgp/backend/modules/mutator/PointMutator.html create mode 100644 doc/jcgp/backend/modules/mutator/ProbabilisticMutator.html create mode 100644 doc/jcgp/backend/modules/mutator/class-use/FixedPointMutator.html create mode 100644 doc/jcgp/backend/modules/mutator/class-use/Mutator.html create mode 100644 doc/jcgp/backend/modules/mutator/class-use/PercentPointMutator.html create mode 100644 doc/jcgp/backend/modules/mutator/class-use/PointMutator.html create mode 100644 doc/jcgp/backend/modules/mutator/class-use/ProbabilisticMutator.html create mode 100644 doc/jcgp/backend/modules/mutator/package-frame.html create mode 100644 doc/jcgp/backend/modules/mutator/package-summary.html create mode 100644 doc/jcgp/backend/modules/mutator/package-tree.html create mode 100644 doc/jcgp/backend/modules/mutator/package-use.html (limited to 'doc/jcgp/backend/modules/mutator') diff --git a/doc/jcgp/backend/modules/mutator/FixedPointMutator.html b/doc/jcgp/backend/modules/mutator/FixedPointMutator.html new file mode 100644 index 0000000..3614df1 --- /dev/null +++ b/doc/jcgp/backend/modules/mutator/FixedPointMutator.html @@ -0,0 +1,284 @@ + + + + + +FixedPointMutator + + + + + + + + +
+ + + + + + + +
+ + + +
+
jcgp.backend.modules.mutator
+

Class FixedPointMutator

+
+
+ +
+
    +
  • +
    +
    +
    public class FixedPointMutator
    +extends PointMutator
    +
    Fixed point mutator +

    + This operator uses the point mutator + algorithm to mutate a user-defined fixed + number of genes.
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    See Also:
    +
    PointMutator
    +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FixedPointMutator

        +
        public FixedPointMutator(Resources resources)
        +
        Creates a new instance of FixedPointMutator.
        +
        +
        Parameters:
        +
        resources - a reference to the experiment's resources.
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/doc/jcgp/backend/modules/mutator/Mutator.html b/doc/jcgp/backend/modules/mutator/Mutator.html new file mode 100644 index 0000000..13aafdb --- /dev/null +++ b/doc/jcgp/backend/modules/mutator/Mutator.html @@ -0,0 +1,281 @@ + + + + + +Mutator + + + + + + + + +
+ + + + + + + +
+ + + +
+
jcgp.backend.modules.mutator
+

Class Mutator

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    PointMutator, ProbabilisticMutator
    +
    +
    +
    +
    public abstract class Mutator
    +extends Module
    +
    This class specifies the basic characteristics of a mutation operator. Its job is + to modify the connections and functions of the chromosome according to the operator's + parameters. +

    + Parameters may be specified to control the implemented mutation. 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 voidmutate(Chromosome chromosome) +
      Applies mutations to the specified chromosome according + to the parameter values.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        mutate

        +
        public abstract void mutate(Chromosome chromosome)
        +
        Applies mutations to the specified chromosome according + to the parameter values.
        +
        +
        Parameters:
        +
        chromosome - the chromosome to mutate.
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/doc/jcgp/backend/modules/mutator/PercentPointMutator.html b/doc/jcgp/backend/modules/mutator/PercentPointMutator.html new file mode 100644 index 0000000..968640e --- /dev/null +++ b/doc/jcgp/backend/modules/mutator/PercentPointMutator.html @@ -0,0 +1,285 @@ + + + + + +PercentPointMutator + + + + + + + + +
+ + + + + + + +
+ + + +
+
jcgp.backend.modules.mutator
+

Class PercentPointMutator

+
+
+ +
+
    +
  • +
    +
    +
    public class PercentPointMutator
    +extends PointMutator
    +
    Percent point mutator +

    + This operator calculates how many genes to mutate based on the mutation rate + parameter. The total number of genes is computed from the number of nodes, + the arity and the number of outputs. It then uses the point mutation + algorithm to perform the required number of mutations.
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    See Also:
    +
    PointMutator
    +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        PercentPointMutator

        +
        public PercentPointMutator(Resources resources)
        +
        Creates a new instance of PercentPointMutator.
        +
        +
        Parameters:
        +
        resources - a reference to the experiment's resources.
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/doc/jcgp/backend/modules/mutator/PointMutator.html b/doc/jcgp/backend/modules/mutator/PointMutator.html new file mode 100644 index 0000000..691eece --- /dev/null +++ b/doc/jcgp/backend/modules/mutator/PointMutator.html @@ -0,0 +1,281 @@ + + + + + +PointMutator + + + + + + + + +
+ + + + + + + +
+ + + +
+
jcgp.backend.modules.mutator
+

Class PointMutator

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    FixedPointMutator, PercentPointMutator
    +
    +
    +
    +
    public abstract class PointMutator
    +extends Mutator
    +
    Point mutator +

    + In point mutation, a number of random genes + is picked and mutated until all required + mutations have been performed. The actual number + of genes to be mutated can be defined in any + arbitrary way.
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidmutate(Chromosome chromosome) +
      Applies mutations to the specified chromosome according + to the parameter values.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        mutate

        +
        public void mutate(Chromosome chromosome)
        +
        Description copied from class: Mutator
        +
        Applies mutations to the specified chromosome according + to the parameter values.
        +
        +
        Specified by:
        +
        mutate in class Mutator
        +
        Parameters:
        +
        chromosome - the chromosome to mutate.
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/doc/jcgp/backend/modules/mutator/ProbabilisticMutator.html b/doc/jcgp/backend/modules/mutator/ProbabilisticMutator.html new file mode 100644 index 0000000..c4e22ae --- /dev/null +++ b/doc/jcgp/backend/modules/mutator/ProbabilisticMutator.html @@ -0,0 +1,319 @@ + + + + + +ProbabilisticMutator + + + + + + + + +
+ + + + + + + +
+ + + +
+
jcgp.backend.modules.mutator
+

Class ProbabilisticMutator

+
+
+ +
+
    +
  • +
    +
    +
    public class ProbabilisticMutator
    +extends Mutator
    +
    Probabilistic mutator +

    + This operator iterates through every mutable gene in the chromosome and + decides whether to mutate each of them individually. + The decision is made based on the difference between the mutation probability + and a randomly generated double between 0 and 100.
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    See Also:
    +
    Mutator
    +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidmutate(Chromosome chromosome) +
      Applies mutations to the specified chromosome according + to the parameter values.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ProbabilisticMutator

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

      Method Detail

      + + + +
        +
      • +

        mutate

        +
        public void mutate(Chromosome chromosome)
        +
        Description copied from class: Mutator
        +
        Applies mutations to the specified chromosome according + to the parameter values.
        +
        +
        Specified by:
        +
        mutate in class Mutator
        +
        Parameters:
        +
        chromosome - the chromosome to mutate.
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/doc/jcgp/backend/modules/mutator/class-use/FixedPointMutator.html b/doc/jcgp/backend/modules/mutator/class-use/FixedPointMutator.html new file mode 100644 index 0000000..695222a --- /dev/null +++ b/doc/jcgp/backend/modules/mutator/class-use/FixedPointMutator.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class jcgp.backend.modules.mutator.FixedPointMutator + + + + + + + + +
+ + + + + + + +
+ + +
+

Uses of Class
jcgp.backend.modules.mutator.FixedPointMutator

+
+
No usage of jcgp.backend.modules.mutator.FixedPointMutator
+ +
+ + + + + + + +
+ + + + diff --git a/doc/jcgp/backend/modules/mutator/class-use/Mutator.html b/doc/jcgp/backend/modules/mutator/class-use/Mutator.html new file mode 100644 index 0000000..3107012 --- /dev/null +++ b/doc/jcgp/backend/modules/mutator/class-use/Mutator.html @@ -0,0 +1,269 @@ + + + + + +Uses of Class jcgp.backend.modules.mutator.Mutator + + + + + + + + +
+ + + + + + + +
+ + +
+

Uses of Class
jcgp.backend.modules.mutator.Mutator

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

Uses of Class
jcgp.backend.modules.mutator.PercentPointMutator

+
+
No usage of jcgp.backend.modules.mutator.PercentPointMutator
+ +
+ + + + + + + +
+ + + + diff --git a/doc/jcgp/backend/modules/mutator/class-use/PointMutator.html b/doc/jcgp/backend/modules/mutator/class-use/PointMutator.html new file mode 100644 index 0000000..feeb525 --- /dev/null +++ b/doc/jcgp/backend/modules/mutator/class-use/PointMutator.html @@ -0,0 +1,179 @@ + + + + + +Uses of Class jcgp.backend.modules.mutator.PointMutator + + + + + + + + +
+ + + + + + + +
+ + +
+

Uses of Class
jcgp.backend.modules.mutator.PointMutator

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

Uses of Class
jcgp.backend.modules.mutator.ProbabilisticMutator

+
+
No usage of jcgp.backend.modules.mutator.ProbabilisticMutator
+ +
+ + + + + + + +
+ + + + diff --git a/doc/jcgp/backend/modules/mutator/package-frame.html b/doc/jcgp/backend/modules/mutator/package-frame.html new file mode 100644 index 0000000..da1968b --- /dev/null +++ b/doc/jcgp/backend/modules/mutator/package-frame.html @@ -0,0 +1,24 @@ + + + + + +jcgp.backend.modules.mutator + + + + + +

jcgp.backend.modules.mutator

+
+

Classes

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

Package jcgp.backend.modules.mutator

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

Hierarchy For Package jcgp.backend.modules.mutator

+Package Hierarchies: + +
+
+

Class Hierarchy

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

Uses of Package
jcgp.backend.modules.mutator

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