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/population/Output.html | 447 ++++++++++++++++++++++++++++++++ 1 file changed, 447 insertions(+) create mode 100644 doc/jcgp/backend/population/Output.html (limited to 'doc/jcgp/backend/population/Output.html') diff --git a/doc/jcgp/backend/population/Output.html b/doc/jcgp/backend/population/Output.html new file mode 100644 index 0000000..38033e2 --- /dev/null +++ b/doc/jcgp/backend/population/Output.html @@ -0,0 +1,447 @@ + + + + + +Output + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
jcgp.backend.population
+

Class Output

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    MutableElement
    +
    +
    +
    +
    public class Output
+extends java.lang.Object
+implements MutableElement
    +
    This is a chromosome output. Outputs are a special + type of mutable element with a single connection. It + returns the value of its single connection, but it + may not be connected to - it terminates a chromosome + active connection path.
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Output(Chromosome chromosome, + int index) +
      Makes a new instance of Output with the + specified arguments.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.Objectcalculate() 
      booleancopyOf(MutableElement m) +
      Asserts if the specified element is a copy of the elements + this is called on.
      + This method returns true if and only if: + + the elements being compared are not the same instance; + the connections of the compared elements are not the same instance; + the elements have the same function (in the case of Node); + the grid position of the elements themselves are the same; + the grid position of all equivalent connections are the same; + +

      + The relationship computed by this method is: + + symmetric: a.copyOf(b) == b.copyOf(a); + not reflexive: a.copyOf(a) returns false; + not transitive: if a.copyOf(b) is true and b.copyOf(c) is true, a.copyOf(c) is + not necessarily true since it is possible that a == c. +
      +
      voidgetActiveNodes(java.util.ArrayList<Node> activeNodes) 
      intgetIndex() 
      ConnectiongetSource() 
      voidsetConnection(int index, + Connection newConnection) +
      When mutating an output, the index parameter + is simply ignored and the output source is + set.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        Output

        +
        public Output(Chromosome chromosome,
+              int index)
        +
        Makes a new instance of Output with the + specified arguments.
        +
        +
        Parameters:
        +
        chromosome - the chromosome this output belongs to.
        +
        index - the output index.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        calculate

        +
        public java.lang.Object calculate()
        +
        +
        Returns:
        +
        the value of the output's source.
        +
        +
        • +
      + + + +
        +
      • +

        getIndex

        +
        public int getIndex()
        +
        • +
      + + + +
        +
      • +

        getSource

        +
        public Connection getSource()
        +
        • +
      + + + +
        +
      • +

        getActiveNodes

        +
        public void getActiveNodes(java.util.ArrayList<Node> activeNodes)
        +
        • +
      + + + + + + + +
        +
      • +

        copyOf

        +
        public boolean copyOf(MutableElement m)
        +
        Description copied from interface: MutableElement
        +
        Asserts if the specified element is a copy of the elements + this is called on.
        + This method returns true if and only if: +
          +
        • the elements being compared are not the same instance;
          • +
        • the connections of the compared elements are not the same instance;
          • +
        • the elements have the same function (in the case of Node);
          • +
        • the grid position of the elements themselves are the same;
          • +
        • the grid position of all equivalent connections are the same;
          • +
        +

        + The relationship computed by this method is: +
          +
        • symmetric: a.copyOf(b) == b.copyOf(a);
          • +
        • not reflexive: a.copyOf(a) returns false;
          • +
        • not transitive: if a.copyOf(b) is true and b.copyOf(c) is true, a.copyOf(c) is + not necessarily true since it is possible that a == c.
          • +
        +
        +
        Specified by:
        +
        copyOf in interface MutableElement
        +
        Parameters:
        +
        m - the mutable element to compare to.
        +
        Returns:
        +
        true if element is a copy of this element.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + -- cgit v1.2.3