boone.neurons

Class NeuronList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Neuron>

boone.neurons.NeuronList

All Implemented Interfaces:

Storable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Neuron>, java.util.Collection<Neuron>, java.util.List<Neuron>, java.util.RandomAccess

public class NeuronList
extends java.util.ArrayList<Neuron>
implements Storable, java.lang.Cloneable

A list for neurons and methods to change the order of neurons.

Version:

$Id$

Author:

Helmut A. Mayer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
NeuralNet	net The associated net (may be null).

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
NeuronList() Constructs an empty neuron list.
NeuronList(int count, Neuron neuron) Constructs a new neuron list by cloning the given neuron.
NeuronList(NeuralNet net) Constructs an empty neuron list referring to the given network.

Method Summary

Modifier and Type	Method and Description
void	fromXML(org.jdom2.Element element) Reads attributes from XML tree.
void	sortRandom() Returns this list of the given net with neurons in random order.
boolean	sortTopological() Sorts the neuron's of a feed-forward network in topological order and assigns layer numbers starting with 0 (input layer).
java.lang.String	toString() Returns a string representation of this neuron list.
org.jdom2.Element	toXML(org.jdom2.Element element) Writes attributes to XML tree.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Field Detail

net

public NeuralNet net

The associated net (may be null).

Constructor Detail

NeuronList

public NeuronList()

Constructs an empty neuron list.

NeuronList

public NeuronList(int count,
                  Neuron neuron)

Constructs a new neuron list by cloning the given neuron.

Parameters:

count - the size of the list

neuron - the neuron type

NeuronList

public NeuronList(NeuralNet net)

Constructs an empty neuron list referring to the given network.

Parameters:

net - a neural network

Method Detail

sortTopological

public boolean sortTopological()

Sorts the neuron's of a feed-forward network in topological order and assigns layer numbers starting with 0 (input layer). This is an implementation of Kahn's algorithm. The input neurons are at the list start, and the output neurons at the end.

Returns:

true, if sorting is correct, false, if network is recurrent, then sorting in layers is not possible

sortRandom

public void sortRandom()

Returns this list of the given net with neurons in random order.

toString

public java.lang.String toString()

Returns a string representation of this neuron list.

Overrides:

toString in class java.util.AbstractCollection<Neuron>

Returns:

a string describing each neuron in the list

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