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 --- doc/jcgp/backend/parsers/ChromosomeParser.html | 324 +++++++++++++++++++++ doc/jcgp/backend/parsers/FunctionParser.html | 301 +++++++++++++++++++ doc/jcgp/backend/parsers/ParameterParser.html | 294 +++++++++++++++++++ doc/jcgp/backend/parsers/TestCaseParser.html | 296 +++++++++++++++++++ .../parsers/class-use/ChromosomeParser.html | 124 ++++++++ .../backend/parsers/class-use/FunctionParser.html | 124 ++++++++ .../backend/parsers/class-use/ParameterParser.html | 124 ++++++++ .../backend/parsers/class-use/TestCaseParser.html | 124 ++++++++ doc/jcgp/backend/parsers/package-frame.html | 23 ++ doc/jcgp/backend/parsers/package-summary.html | 166 +++++++++++ doc/jcgp/backend/parsers/package-tree.html | 140 +++++++++ doc/jcgp/backend/parsers/package-use.html | 124 ++++++++ 12 files changed, 2164 insertions(+) create mode 100644 doc/jcgp/backend/parsers/ChromosomeParser.html create mode 100644 doc/jcgp/backend/parsers/FunctionParser.html create mode 100644 doc/jcgp/backend/parsers/ParameterParser.html create mode 100644 doc/jcgp/backend/parsers/TestCaseParser.html create mode 100644 doc/jcgp/backend/parsers/class-use/ChromosomeParser.html create mode 100644 doc/jcgp/backend/parsers/class-use/FunctionParser.html create mode 100644 doc/jcgp/backend/parsers/class-use/ParameterParser.html create mode 100644 doc/jcgp/backend/parsers/class-use/TestCaseParser.html create mode 100644 doc/jcgp/backend/parsers/package-frame.html create mode 100644 doc/jcgp/backend/parsers/package-summary.html create mode 100644 doc/jcgp/backend/parsers/package-tree.html create mode 100644 doc/jcgp/backend/parsers/package-use.html (limited to 'doc/jcgp/backend/parsers') diff --git a/doc/jcgp/backend/parsers/ChromosomeParser.html b/doc/jcgp/backend/parsers/ChromosomeParser.html new file mode 100644 index 0000000..14862f6 --- /dev/null +++ b/doc/jcgp/backend/parsers/ChromosomeParser.html @@ -0,0 +1,324 @@ + + + + + +ChromosomeParser + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
jcgp.backend.parsers
+

Class ChromosomeParser

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class ChromosomeParser
+extends java.lang.Object
    +
    This class contains a method for parsing .chr files and another + for writing .chr files from given chromosomes.
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ChromosomeParser() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidparse(java.io.File file, + Chromosome chromosome, + Resources resources) +
      Use this method to parse .chr files into a given chromosome.
      +
      static voidsave(java.io.File file, + Chromosome chromosome, + Resources resources) +
      Writes a chromosome into the specified .chr file.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ChromosomeParser

        +
        public ChromosomeParser()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        parse

        +
        public static void parse(java.io.File file,
+                         Chromosome chromosome,
+                         Resources resources)
        +
        Use this method to parse .chr files into a given chromosome. +

        + This is not fully defensive as it doesn't check for number of inputs, + doesn't compare rows and columns individually and doesn't account for levels back. It + is not viable to implement these defensive measures with the chromosome format used + by CGP.
        +
        +
        Parameters:
        +
        file - the .chr file to parse from
        +
        chromosome - the chromosome to configure
        +
        resources - the experiment resources
        +
        +
        • +
      + + + +
        +
      • +

        save

        +
        public static void save(java.io.File file,
+                        Chromosome chromosome,
+                        Resources resources)
        +
        Writes a chromosome into the specified .chr file. +

        + The file is written in the standard .chr format and can + be read by the original CGP implementation.
        +
        +
        Parameters:
        +
        file - the file to write to
        +
        chromosome - the chromosome to save
        +
        resources - a reference to the experiment's resources.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parsers/FunctionParser.html b/doc/jcgp/backend/parsers/FunctionParser.html new file mode 100644 index 0000000..f7ef21c --- /dev/null +++ b/doc/jcgp/backend/parsers/FunctionParser.html @@ -0,0 +1,301 @@ + + + + + +FunctionParser + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
jcgp.backend.parsers
+

Class FunctionParser

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class FunctionParser
+extends java.lang.Object
    +
    Contains a static method for parsing functions from a + .par file.
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FunctionParser() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidparse(java.io.File file, + FunctionSet functionSet, + Resources resources) +
      Reads the specified file and attempts to enable + and disable the functions in the FunctionSet + accordingly.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FunctionParser

        +
        public FunctionParser()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        parse

        +
        public static void parse(java.io.File file,
+                         FunctionSet functionSet,
+                         Resources resources)
        +
        Reads the specified file and attempts to enable + and disable the functions in the FunctionSet + accordingly. +

        + Standard CGP .par files do not contain enough information + to determine if they match the currently selected function set. + For this reason, the parser assumes the function set is correct + and treats functions by their index rather than their name. Any + index outside the bounds of the function set is ignored and a + warning message is printed once parsing is complete.
        +
        +
        Parameters:
        +
        file - the .par file to parse.
        +
        functionSet - the function set whose functions should be modified.
        +
        resources - used for printing console messages.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parsers/ParameterParser.html b/doc/jcgp/backend/parsers/ParameterParser.html new file mode 100644 index 0000000..3dd7c2d --- /dev/null +++ b/doc/jcgp/backend/parsers/ParameterParser.html @@ -0,0 +1,294 @@ + + + + + +ParameterParser + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
jcgp.backend.parsers
+

Class ParameterParser

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class ParameterParser
+extends java.lang.Object
    +
    Contains a static method for parsing parameters from a + .par file.
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ParameterParser() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidparse(java.io.File file, + ModifiableResources resources) +
      Parses the parameters from a specified CGP parameter file and + modifies the experiment resources appropriately.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ParameterParser

        +
        public ParameterParser()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        parse

        +
        public static void parse(java.io.File file,
+                         ModifiableResources resources)
        +
        Parses the parameters from a specified CGP parameter file and + modifies the experiment resources appropriately. +

        + CGP .par files do not follow a very strict convention, so this + parser does its best to cope with format irregularities. Parsing + works even if the parameters are in the wrong order, and unknown + parameters are simply ignored.
        +
        +
        Parameters:
        +
        file - the .par file to parse.
        +
        resources - a reference to the resources object that must be modified.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parsers/TestCaseParser.html b/doc/jcgp/backend/parsers/TestCaseParser.html new file mode 100644 index 0000000..e3dc642 --- /dev/null +++ b/doc/jcgp/backend/parsers/TestCaseParser.html @@ -0,0 +1,296 @@ + + + + + +TestCaseParser + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
jcgp.backend.parsers
+

Class TestCaseParser

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class TestCaseParser
+extends java.lang.Object
    +
    Contains a static method for parsing values from a + CGP problem data file. The actual file extension + varies from problem to problem, and is therefore + defined in the experiment's Problem instance.
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      TestCaseParser() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidparse(java.io.File file, + TestCaseProblem<?> problem, + ModifiableResources resources) +
      Sets the number of inputs and outputs in the resources + to match the given file, and parses each test case + from the file into the specified problem.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        TestCaseParser

        +
        public TestCaseParser()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        parse

        +
        public static void parse(java.io.File file,
+                         TestCaseProblem<?> problem,
+                         ModifiableResources resources)
        +
        Sets the number of inputs and outputs in the resources + to match the given file, and parses each test case + from the file into the specified problem.
        +
        +
        Parameters:
        +
        file - the problem file to parse.
        +
        problem - the problem into which to parse the problem data.
        +
        resources - a modifiable reference to the experiment's resources
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parsers/class-use/ChromosomeParser.html b/doc/jcgp/backend/parsers/class-use/ChromosomeParser.html new file mode 100644 index 0000000..e75e1c7 --- /dev/null +++ b/doc/jcgp/backend/parsers/class-use/ChromosomeParser.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class jcgp.backend.parsers.ChromosomeParser + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
jcgp.backend.parsers.ChromosomeParser

+
+
No usage of jcgp.backend.parsers.ChromosomeParser
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parsers/class-use/FunctionParser.html b/doc/jcgp/backend/parsers/class-use/FunctionParser.html new file mode 100644 index 0000000..ae142f1 --- /dev/null +++ b/doc/jcgp/backend/parsers/class-use/FunctionParser.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class jcgp.backend.parsers.FunctionParser + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
jcgp.backend.parsers.FunctionParser

+
+
No usage of jcgp.backend.parsers.FunctionParser
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parsers/class-use/ParameterParser.html b/doc/jcgp/backend/parsers/class-use/ParameterParser.html new file mode 100644 index 0000000..25ee51d --- /dev/null +++ b/doc/jcgp/backend/parsers/class-use/ParameterParser.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class jcgp.backend.parsers.ParameterParser + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
jcgp.backend.parsers.ParameterParser

+
+
No usage of jcgp.backend.parsers.ParameterParser
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parsers/class-use/TestCaseParser.html b/doc/jcgp/backend/parsers/class-use/TestCaseParser.html new file mode 100644 index 0000000..6a6fd9e --- /dev/null +++ b/doc/jcgp/backend/parsers/class-use/TestCaseParser.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class jcgp.backend.parsers.TestCaseParser + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
jcgp.backend.parsers.TestCaseParser

+
+
No usage of jcgp.backend.parsers.TestCaseParser
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parsers/package-frame.html b/doc/jcgp/backend/parsers/package-frame.html new file mode 100644 index 0000000..6465787 --- /dev/null +++ b/doc/jcgp/backend/parsers/package-frame.html @@ -0,0 +1,23 @@ + + + + + +jcgp.backend.parsers + + + + + +

jcgp.backend.parsers

+
+

Classes

+ +
+ + diff --git a/doc/jcgp/backend/parsers/package-summary.html b/doc/jcgp/backend/parsers/package-summary.html new file mode 100644 index 0000000..bce0483 --- /dev/null +++ b/doc/jcgp/backend/parsers/package-summary.html @@ -0,0 +1,166 @@ + + + + + +jcgp.backend.parsers + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package jcgp.backend.parsers

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parsers/package-tree.html b/doc/jcgp/backend/parsers/package-tree.html new file mode 100644 index 0000000..0f41a20 --- /dev/null +++ b/doc/jcgp/backend/parsers/package-tree.html @@ -0,0 +1,140 @@ + + + + + +jcgp.backend.parsers Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package jcgp.backend.parsers

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parsers/package-use.html b/doc/jcgp/backend/parsers/package-use.html new file mode 100644 index 0000000..f58b655 --- /dev/null +++ b/doc/jcgp/backend/parsers/package-use.html @@ -0,0 +1,124 @@ + + + + + +Uses of Package jcgp.backend.parsers + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
jcgp.backend.parsers

+
+
No usage of jcgp.backend.parsers
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + -- cgit v1.2.3