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 +++++++++++++++++++++++++ 1 file changed, 324 insertions(+) create mode 100644 doc/jcgp/backend/parsers/ChromosomeParser.html (limited to 'doc/jcgp/backend/parsers/ChromosomeParser.html') 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
    • +
+ +
+ + +
+ + + -- cgit v1.2.3