Brain (boone)

java.lang.Object
- boone.Brain

All Implemented Interfaces:

Storable, java.lang.Cloneable
```
public class Brain
extends java.lang.Object
implements Storable, java.lang.Cloneable
```
A brain containing a number of NeuralNets (brain areas) and DataSets (memories).

Since:

2004-11-09 19:54

Version:

$Id$

Author:

August Mayer

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.ArrayList<NeuralNet>`	`nets` List of neural networks.
`protected java.util.ArrayList<PatternSet>`	`patternSets` List of data sets.
`protected java.util.Properties`	`props` User Properties.

Constructor Summary

Constructors
Constructor and Description

Brain()

Constructors
Constructor and Description
`Brain()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addNet(int index, NeuralNet net)` Add a network to the brain.
`void`	`addNet(NeuralNet net)` Add a network to the brain.
`void`	`addSet(int index, PatternSet set)` Add a data set to the brain.
`void`	`addSet(PatternSet set)` Add a data set to the brain.
`void`	`clearNets()` Clear the list of neural networks, i.e.
`void`	`clearSets()` Clear the list of data set, i.e.
`Brain`	`clone()` Clone this Brain.
`void`	`fromXML(org.jdom2.Element element)` Reads attributes from XML tree.
`NeuralNet`	`getNet(int index)` Return a network.
`int`	`getNetCount()` Return the number of neural networks.
`PatternSet`	`getSet(int index)` Return a data set.
`int`	`getSetCount()` Return the number of data sets.
`void`	`removeNet(int index)` Remove a network from the brain.
`void`	`removeNet(NeuralNet net)` Remove a network from the brain.
`void`	`removeSet(int index)` Remove a data set from the brain.
`void`	`removeSet(PatternSet set)` Remove a data set from the brain.
`void`	`save(java.io.File file)` Save a Brain.
`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, toString, wait, wait, wait

- Field Detail
  - nets
```
protected java.util.ArrayList<NeuralNet> nets
```
    List of neural networks.
  - patternSets
```
protected java.util.ArrayList<PatternSet> patternSets
```
    List of data sets.
  - props
```
protected java.util.Properties props
```
    User Properties. Can be used by the application as necessary; not used by Boone. These properties are also saved to and loaded from files.
- Constructor Detail
  - Brain
```
public Brain()
```
- Method Detail
  - clone
```
public Brain clone()
```
    Clone this Brain.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Throws:
    
    CloneException - if cloning fails internally.
  - getNetCount
```
public int getNetCount()
```
    Return the number of neural networks.
  - getNet
```
public NeuralNet getNet(int index)
```
    Return a network.
    
    Parameters:
    
    index - Index of the network to return.
  - addNet
```
public void addNet(NeuralNet net)
```
    Add a network to the brain.
    
    Parameters:
    
    net - Network to add.
  - addNet
```
public void addNet(int index,
                   NeuralNet net)
```
    Add a network to the brain. Insert at the given index.
    
    Parameters:
    
    net - Network to add.
    
    index - Index where to insert the network.
  - removeNet
```
public void removeNet(int index)
```
    Remove a network from the brain.
    
    Parameters:
    
    index - Index of the network to remove.
  - removeNet
```
public void removeNet(NeuralNet net)
```
    Remove a network from the brain.
    
    Parameters:
    
    net - Network to remove.
  - clearNets
```
public void clearNets()
```
    Clear the list of neural networks, i.e. remove all networks.
  - getSetCount
```
public int getSetCount()
```
    Return the number of data sets.
  - getSet
```
public PatternSet getSet(int index)
```
    Return a data set.
    
    Parameters:
    
    index - Index of the data set to return.
  - addSet
```
public void addSet(PatternSet set)
```
    Add a data set to the brain.
    
    Parameters:
    
    set - data set to add.
  - addSet
```
public void addSet(int index,
                   PatternSet set)
```
    Add a data set to the brain. Insert at the given index.
    
    Parameters:
    
    index - Index where to insert the data set.
    
    set - data set to add.
  - removeSet
```
public void removeSet(int index)
```
    Remove a data set from the brain.
    
    Parameters:
    
    index - Index of the data set to remove.
  - removeSet
```
public void removeSet(PatternSet set)
```
    Remove a data set from the brain.
    
    Parameters:
    
    set - data set to remove.
  - clearSets
```
public void clearSets()
```
    Clear the list of data set, i.e. remove all data sets.
  - save
```
public void save(java.io.File file)
          throws java.io.IOException
```
    Save a Brain.
    
    Parameters:
    
    file - File to save it to.
    
    Throws:
    
    java.io.IOException
  - fromXML
```
public void fromXML(org.jdom2.Element element)
```
    Description copied from interface: Storable
    
    Reads attributes from XML tree.
    
    Specified by:
    
    fromXML in interface Storable
    
    Parameters:
    
    element - a JDOM element
  - toXML
```
public org.jdom2.Element toXML(org.jdom2.Element element)
```
    Description copied from interface: Storable
    
    Writes attributes to XML tree.
    
    Specified by:
    
    toXML in interface Storable
    
    Parameters:
    
    element - a JDOM element
    
    Returns:
    
    an element

Class Brain

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

nets

patternSets

props

Constructor Detail

Brain

Method Detail

clone

getNetCount

getNet

addNet

addNet

removeNet

removeNet

clearNets

getSetCount

getSet

addSet

addSet

removeSet

removeSet

clearSets

save

fromXML

toXML