Topology (boone)

java.lang.Object
- boone.map.Topology

All Implemented Interfaces:

Storable, java.lang.Cloneable

Direct Known Subclasses:

HexagonTopology
```
public abstract class Topology
extends java.lang.Object
implements java.lang.Cloneable, Storable
```
The topology defines the neighborhood relation of the output neurons so as to form a map of neurons.

Author:

Helmut A. Mayer

Field Summary

Fields
Modifier and Type Field and Description

protected static int EMPTY

protected NeuralNet net
The associated network.

Fields
Modifier and Type	Field and Description
`protected static int`	`EMPTY`
`protected NeuralNet`	`net` The associated network.

Constructor Summary

Constructors
Constructor and Description

Topology()
Creates the Topology.

Constructors
Constructor and Description
`Topology()` Creates the Topology.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addNeighbor(int id)` Adds a neighbor to the neighbor list.
`abstract boolean`	`arrangeNeurons()` Arranges the output neurons of the net according to the topology.
`protected abstract void`	`clearMap()` Clears the distance map (set to EMPTY).
`Topology`	`clone()` A clone keeping the reference to the same network and the same neighbor list.
`java.util.List<Neuron>`	`getNeighbors(Neuron neuron, int radius)` Returns all neighbors within a given 'radius' of the given neuron.
`NeuralNet`	`getNet()` Returns the associated net.
`abstract int[]`	`getNeurons()` Returns the dimensions of the map.
`abstract double[]`	`getSizes()` Returns the size (length) of each dimension of the map.
`abstract int`	`getTotalNeurons()` Returns the total number of map neurons.
`protected abstract void`	`searchNeighbors(int index, int radius)` Sets the map at the given neuron index to value.
`protected abstract void`	`setMapValue(int index, int value)` Sets the map at the given neuron index to value.
`void`	`setNet(NeuralNet net)` Sets the associated net.
`org.jdom2.Element`	`toXML(org.jdom2.Element element)` Writes common topology attributes to a new child element.

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

Methods inherited from interface boone.io.Storable
fromXML

- Field Detail
  - EMPTY
```
protected static final int EMPTY
```
    See Also:
    
    Constant Field Values
  - net
```
protected NeuralNet net
```
    The associated network.
- Constructor Detail
  - Topology
```
public Topology()
```
    Creates the Topology.
- Method Detail
  - clone
```
public Topology clone()
```
    A clone keeping the reference to the same network and the same neighbor list.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a clone, null if problems which are very unlikely
  - getNet
```
public NeuralNet getNet()
```
    Returns the associated net.
    
    Returns:
    
    a neural network
  - setNet
```
public void setNet(NeuralNet net)
```
    Sets the associated net.
    
    Parameters:
    
    net - a net
  - getNeighbors
```
public java.util.List<Neuron> getNeighbors(Neuron neuron,
                                           int radius)
```
    Returns all neighbors within a given 'radius' of the given neuron. For efficiency subsequent calls with identical parameters immediately return the last result. For this to work the returned list of neurons must not be changed! The given start neuron will always be in the neighbor list (also for negative radius).
    
    Parameters:
    
    neuron - a neuron
    
    radius - the neighborhood radius
    
    Returns:
    
    a list of neighbor neurons
  - arrangeNeurons
```
public abstract boolean arrangeNeurons()
```
    Arranges the output neurons of the net according to the topology.
    
    Returns:
    
    true, if arranged, false, if problems
  - addNeighbor
```
protected void addNeighbor(int id)
```
    Adds a neighbor to the neighbor list.
    
    Parameters:
    
    id - the neuron index
  - getNeurons
```
public abstract int[] getNeurons()
```
    Returns the dimensions of the map.
    
    Returns:
    
    the number of map neurons per dimension
  - getSizes
```
public abstract double[] getSizes()
```
    Returns the size (length) of each dimension of the map.
    
    Returns:
    
    the length of each dimension
  - setMapValue
```
protected abstract void setMapValue(int index,
                                    int value)
```
    Sets the map at the given neuron index to value.
    
    Parameters:
    
    index - a neuron index
    
    value - the map value
  - getTotalNeurons
```
public abstract int getTotalNeurons()
```
    Returns the total number of map neurons.
    
    Returns:
    
    the total number of neurons in the map
  - clearMap
```
protected abstract void clearMap()
```
    Clears the distance map (set to EMPTY).
  - searchNeighbors
```
protected abstract void searchNeighbors(int index,
                                        int radius)
```
    Sets the map at the given neuron index to value.
    
    Parameters:
    
    index - a neuron index
    
    radius - the neighborhood radius
  - toXML
```
public org.jdom2.Element toXML(org.jdom2.Element element)
```
    Writes common topology attributes to a new child element.
    
    Specified by:
    
    toXML in interface Storable
    
    Parameters:
    
    element - the parent element
    
    Returns:
    
    the topology element

Class Topology

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface boone.io.Storable

Field Detail

EMPTY

net

Constructor Detail

Topology

Method Detail

clone

getNet

setNet

getNeighbors

arrangeNeurons

addNeighbor

getNeurons

getSizes

setMapValue

getTotalNeurons

clearMap

searchNeighbors

toXML