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

Class Input

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Connection
    +
    +
    +
    +
    public class Input
+extends java.lang.Object
+implements Connection
    +
    This is a chromosome input. Inputs are a special + type of connection which simply return a set value. + They do not have connections and instead provide a + starting point for the chromosome's active paths.
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Input(int index) +
      Initialises a new input with the current index.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intgetIndex() 
      java.lang.ObjectgetValue() +
      Compute and return the value of this connection.
      +
      voidsetValue(java.lang.Object newValue) +
      Sets this input's value.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        Input

        +
        public Input(int index)
        +
        Initialises a new input with the current index.
        +
        +
        Parameters:
        +
        index - the index of the new input.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setValue

        +
        public void setValue(java.lang.Object newValue)
        +
        Sets this input's value. The new value + will now be returned by this input's + getValue() method.
        +
        +
        Parameters:
        +
        newValue - the value to set.
        +
        +
        • +
      + + + +
        +
      • +

        getIndex

        +
        public int getIndex()
        +
        +
        Returns:
        +
        the input's index.
        +
        +
        • +
      + + + +
        +
      • +

        getValue

        +
        public java.lang.Object getValue()
        +
        Description copied from interface: Connection
        +
        Compute and return the value of this connection. In + the case of inputs no computation is necessary, this + simply returns the value the input is set to. In the + case of nodes, the value is computed based on the + node's function and the value of its own connections.
        +
        +
        Specified by:
        +
        getValue in interface Connection
        +
        Returns:
        +
        the connection's value.
        +
        +
        • +
      + + + +
        +
      • +

        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