BrainPart (boone)

java.lang.Object
- boone.BrainPart

All Implemented Interfaces:

Storable, java.lang.Cloneable

Direct Known Subclasses:

Link, Neuron
```
public abstract class BrainPart
extends java.lang.Object
implements java.lang.Cloneable, Storable
```
Base class for neuron and link.

Version:

$Id$

Author:

August Mayer, Helmut A. Mayer

Field Summary

Fields
Modifier and Type	Field and Description
`protected Function`	`activationFn` The activation function.
`protected java.lang.String`	`name` Name for this BrainPart.
`static long`	`NO_ID` Indicates a new brain part without ID.
`protected double`	`weight` The weight/bias of this part.

Constructor Summary

Constructors
Constructor and Description

BrainPart()

Constructors
Constructor and Description
`BrainPart()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGradient(double value)` Adds a value to the gradient.
`void`	`addToWeight(double deltaWeight)` Adds the given value to the weight/bias.
`void`	`calculate()` Calculate the current state of this brain part.
`BrainPart`	`clone()` Returns a shallow copy.
`void`	`fromXML(org.jdom2.Element element)` Reads attributes from XML tree.
`double`	`getAccu()` Returns accu value.
`Function`	`getActivationFn()` Return the current activation function.
`double`	`getGradient()` Returns gradient information.
`long`	`getID()` Returns the ID.
`double`	`getLastGradient()` Returns the last gradient information.
`java.lang.String`	`getName()` Return the name of this BrainPart.
`static long`	`getUniqueID()` Returns a unique ID for a brain part.
`double`	`getWeight()` Returns the weight of this link.
`boolean`	`isTrainable()` Returns the status.
`void`	`randomize()` Randomizes the weight/bias value within [-0.1, 0.1).
`void`	`randomize(double minValue, double maxValue)` Randomizes the weight/bias value within the given bounds.
`void`	`reset()` Resets internal attributes.
`void`	`setAccu(double value)` Sets accu value.
`void`	`setActivationFn(Function activationFn)` Set the brain part's activation function.
`void`	`setGradient(double gradient)` Sets gradient information.
`void`	`setID(long id)` Sets the ID.
`void`	`setLastGradient(double lastGradient)` Remembers the last gradient information.
`void`	`setName(java.lang.String name)` Set the name of this BrainPart.
`void`	`setTrainable(boolean trainable)` Sets status.
`void`	`setWeight(double weight)` Sets the weight/bias of this part.
`java.lang.String`	`toString()` Returns the name of the BrainPart.
`org.jdom2.Element`	`toXML(org.jdom2.Element element)` Writes attributes to XML tree.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NO_ID
```
public static final long NO_ID
```
    Indicates a new brain part without ID.
    
    See Also:
    
    Constant Field Values
  - name
```
protected java.lang.String name
```
    Name for this BrainPart. By default, empty String.
  - weight
```
protected double weight
```
    The weight/bias of this part.
  - activationFn
```
protected Function activationFn
```
    The activation function.
- Constructor Detail
  - BrainPart
```
public BrainPart()
```
- Method Detail
  - calculate
```
public void calculate()
```
    Calculate the current state of this brain part.
  - reset
```
public void reset()
```
    Resets internal attributes.
  - getUniqueID
```
public static long getUniqueID()
```
    Returns a unique ID for a brain part.
    
    Returns:
    
    a unique ID
  - isTrainable
```
public boolean isTrainable()
```
    Returns the status.
    
    Returns:
    
    true, if trainable
  - getWeight
```
public double getWeight()
```
    Returns the weight of this link.
    
    Returns:
    
    the weight value
  - setWeight
```
public void setWeight(double weight)
```
    Sets the weight/bias of this part. Note that the weight/bias can also be changed using addToWeight(double).
    
    Parameters:
    
    weight - the weight value
  - addToWeight
```
public void addToWeight(double deltaWeight)
```
    Adds the given value to the weight/bias.
    
    Parameters:
    
    deltaWeight - the value to be added
  - setTrainable
```
public void setTrainable(boolean trainable)
```
    Sets status.
    
    Parameters:
    
    trainable - true, if trainable
  - getActivationFn
```
public Function getActivationFn()
```
    Return the current activation function.
  - setActivationFn
```
public void setActivationFn(Function activationFn)
```
    Set the brain part's activation function. Default is a Sigmoid function instance. Use Function.create(String) to create a Function instance from a name string.
  - getGradient
```
public double getGradient()
```
    Returns gradient information.
    
    Returns:
    
    some gradient value
  - setGradient
```
public void setGradient(double gradient)
```
    Sets gradient information.
    
    Parameters:
    
    gradient - some gradient value
  - addGradient
```
public void addGradient(double value)
```
    Adds a value to the gradient.
    
    Parameters:
    
    value - a value
  - getLastGradient
```
public double getLastGradient()
```
    Returns the last gradient information.
    
    Returns:
    
    the last gradient value
  - setLastGradient
```
public void setLastGradient(double lastGradient)
```
    Remembers the last gradient information.
    
    Parameters:
    
    lastGradient - the last gradient value
  - getAccu
```
public double getAccu()
```
    Returns accu value.
    
    Returns:
    
    some accu value
  - setAccu
```
public void setAccu(double value)
```
    Sets accu value.
    
    Parameters:
    
    value - some value
  - randomize
```
public void randomize()
```
    Randomizes the weight/bias value within [-0.1, 0.1).
  - randomize
```
public void randomize(double minValue,
                      double maxValue)
```
    Randomizes the weight/bias value within the given bounds.
    
    Parameters:
    
    minValue - lower bound
    
    maxValue - upper bound
  - toXML
```
public org.jdom2.Element toXML(org.jdom2.Element element)
```
    Writes attributes to XML tree.
    
    Specified by:
    
    toXML in interface Storable
    
    Parameters:
    
    element - an XML element
    
    Returns:
    
    the passed element
  - fromXML
```
public void fromXML(org.jdom2.Element element)
```
    Reads attributes from XML tree.
    
    Specified by:
    
    fromXML in interface Storable
    
    Parameters:
    
    element - an XML element
  - clone
```
public BrainPart clone()
```
    Returns a shallow copy.
    
    Overrides:
    
    clone in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Returns the name of the BrainPart.
    
    Overrides:
    
    toString in class java.lang.Object
  - getName
```
public java.lang.String getName()
```
    Return the name of this BrainPart.
  - setName
```
public void setName(java.lang.String name)
```
    Set the name of this BrainPart.
  - getID
```
public long getID()
```
    Returns the ID. If ID is -1, this part has never been given an ID.
    
    Returns:
    
    the ID of this brain part
  - setID
```
public void setID(long id)
```
    Sets the ID.
    
    Parameters:
    
    id - a unique ID

Class BrainPart

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_ID

name

weight

activationFn

Constructor Detail

BrainPart

Method Detail

calculate

reset

getUniqueID

isTrainable

getWeight

setWeight

addToWeight

setTrainable

getActivationFn

setActivationFn

getGradient

setGradient

addGradient

getLastGradient

setLastGradient

getAccu

setAccu

randomize

randomize

toXML

fromXML

clone

toString

getName

setName

getID

setID