LinkedLayer

java.lang.Object
- keel.Algorithms.Neural_Networks.NNEP_Common.neuralnet.LinkedLayer

All Implemented Interfaces:

ILayer<LinkedNeuron>

Direct Known Subclasses:

ExpLayer, LinearLayer, SigmLayer
```
public abstract class LinkedLayer
extends java.lang.Object
implements ILayer<LinkedNeuron>
```
Base implementation of a hidden or output layer

Since:

JDK1.5

Version:

0.1

Author:

Written by Pedro Antonio Gutierrez Penya, Aaron Ruiz Mora (University of Cordoba) 17/07/2007

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`biased` Is biased?
`static int`	`HIDDEN_LAYER` Defines hidden layer type
`protected int`	`initialmaxnofneurons` Initial maximum number of neurons for the net
`protected int`	`maxnofneurons` Maximum number of neurons for the layer
`protected int`	`minnofneurons` Minimum number of neurons for the net
`protected java.util.ArrayList<LinkedNeuron>`	`neurons` Array of neurons of the layer
`static int`	`OUTPUT_LAYER` Defines output layer type
`protected int`	`type` Type of layer (HIDDEN_LAYER or OUTPUT_LAYER)
`protected static <any>`	`XML` Marshal/Unmarshal initial number of neurons, maximum number of neurons, each neuron, layer type, weigth range, and a boolean indicating if the layer is input-biased

Constructor Summary

Constructors
Constructor and Description

LinkedLayer()
Empty constructor

Constructors
Constructor and Description
`LinkedLayer()` Empty constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addNeuron(LinkedNeuron neuron)` Add a neuron to the layer
`LinkedLayer`	`copy(ILayer<? extends INeuron> previousLayer)` Returns a copy of this linked layer
`boolean`	`equals(ILayer<LinkedNeuron> other)` Checks if this layer is equal to another
`int`	`getInitialmaxnofneurons()` Returns the initial maximum number of neurons of this layer
`int`	`getMaxnofneurons()` Returns the maximum number of neurons of this layer
`int`	`getMinnofneurons()` Returns the minimum number of neurons of this layer
`LinkedNeuron`	`getNeuron(int index)` Returns a neuron of the layer using its index
`int`	`getNoflinks()` Returns the number of effective links of the layer
`int`	`getNofneurons()` Returns the number of neurons of this layer
`int`	`getType()` Returns the type of this layer
`int`	`hashCode()` Returns an integer number that identifies the layer
`boolean`	`isBiased()` Returns true if the layer has a bias neuron
`void`	`keepRelevantLinks(double significativeWeight)` Keep relevant links, that is, those links whose weight is higher than certain number
`boolean`	`linksEmpty()` Checks if this layer is empty of links
`boolean`	`linksFull(ILayer<? extends INeuron> previous)` Checks if this layer is full of links
`boolean`	`neuronsEmpty()` Checks if this layer is empty of neurons
`boolean`	`neuronsFull()` Checks if this layer is full of neurons
`abstract LinkedNeuron`	`obtainNewNeuron()` New neuron for the layer
`LinkedNeuron`	`removeNeuron(int index)` Removes a neuron of the layer using its index
`boolean`	`removeNeuron(LinkedNeuron neuron)` Removes a neuron of the layer
`void`	`setBiased(boolean isBiased)` Sets a boolean indicating if the layer has a bias neuron
`void`	`setInitialmaxnofneurons(int initialmaxnofneurons)` Sets the initial maximum number of neurons of this layer (without BIAS)
`void`	`setMaxnofneurons(int maxnofneurons)` Sets the maximum number of neurons of this layer
`void`	`setMinnofneurons(int minofneurons)` Sets the minimum number of neurons of this layer
`void`	`setType(int type)` Sets the type of this layer

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

- Field Detail
  - XML
```
protected static final <any> XML
```
    Marshal/Unmarshal initial number of neurons, maximum number of neurons, each neuron, layer type, weigth range, and a boolean indicating if the layer is input-biased
  - HIDDEN_LAYER
```
public static final int HIDDEN_LAYER
```
    Defines hidden layer type
    
    See Also:
    
    Constant Field Values
  - OUTPUT_LAYER
```
public static final int OUTPUT_LAYER
```
    Defines output layer type
    
    See Also:
    
    Constant Field Values
  - minnofneurons
```
protected int minnofneurons
```
    Minimum number of neurons for the net
  - initialmaxnofneurons
```
protected int initialmaxnofneurons
```
    Initial maximum number of neurons for the net
  - maxnofneurons
```
protected int maxnofneurons
```
    Maximum number of neurons for the layer
  - neurons
```
protected java.util.ArrayList<LinkedNeuron> neurons
```
    Array of neurons of the layer
  - type
```
protected int type
```
    Type of layer (HIDDEN_LAYER or OUTPUT_LAYER)
  - biased
```
protected boolean biased
```
    Is biased?
- Constructor Detail
  - LinkedLayer
```
public LinkedLayer()
```
    Empty constructor
- Method Detail
  - getMinnofneurons
```
public int getMinnofneurons()
```
    Returns the minimum number of neurons of this layer
    
    Returns:
    
    int Minimum number of neurons
  - setMinnofneurons
```
public void setMinnofneurons(int minofneurons)
```
    Sets the minimum number of neurons of this layer
    
    Parameters:
    
    minofneurons - Minimum number of neurons
  - getInitialmaxnofneurons
```
public int getInitialmaxnofneurons()
```
    Returns the initial maximum number of neurons of this layer
    
    Returns:
    
    int Initial maximum number of neurons
  - setInitialmaxnofneurons
```
public void setInitialmaxnofneurons(int initialmaxnofneurons)
```
    Sets the initial maximum number of neurons of this layer (without BIAS)
    
    Parameters:
    
    initialmaxnofneurons - Initial number of neurons
  - getType
```
public int getType()
```
    Returns the type of this layer
    
    Returns:
    
    int Type of layer
  - setType
```
public void setType(int type)
```
    Sets the type of this layer
    
    Parameters:
    
    type - New type of layer
  - isBiased
```
public boolean isBiased()
```
    Returns true if the layer has a bias neuron
    
    Returns:
    
    true if the layer has a bias neuron
  - setBiased
```
public void setBiased(boolean isBiased)
```
    Sets a boolean indicating if the layer has a bias neuron
    
    Parameters:
    
    isBiased - Boolean has bias neuron
  - getMaxnofneurons
```
public int getMaxnofneurons()
```
    Returns the maximum number of neurons of this layer
    
    Specified by:
    
    getMaxnofneurons in interface ILayer<LinkedNeuron>
    
    Returns:
    
    int Maximum number of neurons
  - setMaxnofneurons
```
public void setMaxnofneurons(int maxnofneurons)
```
    Sets the maximum number of neurons of this layer
    
    Parameters:
    
    maxnofneurons - Number of neurons
  - addNeuron
```
public void addNeuron(LinkedNeuron neuron)
```
    Add a neuron to the layer
    
    Specified by:
    
    addNeuron in interface ILayer<LinkedNeuron>
    
    Parameters:
    
    neuron - New neuron to add to the layer
  - removeNeuron
```
public boolean removeNeuron(LinkedNeuron neuron)
```
    Removes a neuron of the layer
    
    Parameters:
    
    neuron - Neuron to remove
    
    Returns:
    
    true if the neuron has been removes
  - removeNeuron
```
public LinkedNeuron removeNeuron(int index)
```
    Removes a neuron of the layer using its index
    
    Parameters:
    
    index - Index of the neuron to remove
    
    Returns:
    
    LinkedNeuron Neuron removed
  - getNeuron
```
public LinkedNeuron getNeuron(int index)
```
    Returns a neuron of the layer using its index
    
    Specified by:
    
    getNeuron in interface ILayer<LinkedNeuron>
    
    Parameters:
    
    index - Index of the neuron to remove
    
    Returns:
    
    LinkedNeuron Neuron removed
  - getNofneurons
```
public int getNofneurons()
```
    Returns the number of neurons of this layer
    
    Specified by:
    
    getNofneurons in interface ILayer<LinkedNeuron>
    
    Returns:
    
    int Number of neurons
  - equals
```
public boolean equals(ILayer<LinkedNeuron> other)
```
    Checks if this layer is equal to another
    
    Specified by:
    
    equals in interface ILayer<LinkedNeuron>
    
    Parameters:
    
    other - Other layer to compare
    
    Returns:
    
    true if both layers are equal
  - hashCode
```
public int hashCode()
```
    Returns an integer number that identifies the layer
    
    Specified by:
    
    hashCode in interface ILayer<LinkedNeuron>
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    int Hashcode
  - neuronsFull
```
public boolean neuronsFull()
```
    Checks if this layer is full of neurons
    
    Returns:
    
    true if the layer is full of neurons
  - neuronsEmpty
```
public boolean neuronsEmpty()
```
    Checks if this layer is empty of neurons
    
    Returns:
    
    true if the layer is empty of neurons
  - linksFull
```
public boolean linksFull(ILayer<? extends INeuron> previous)
```
    Checks if this layer is full of links
    
    Parameters:
    
    previous - the previous layer to check with
    
    Returns:
    
    true if the layer is full of links
  - linksEmpty
```
public boolean linksEmpty()
```
    Checks if this layer is empty of links
    
    Returns:
    
    true if the layer is empty of links
  - getNoflinks
```
public int getNoflinks()
```
    Returns the number of effective links of the layer
    
    Returns:
    
    int Number of effective links
  - keepRelevantLinks
```
public void keepRelevantLinks(double significativeWeight)
```
    Keep relevant links, that is, those links whose weight is higher than certain number
    
    Parameters:
    
    significativeWeight - Significative weight
  - copy
```
public LinkedLayer copy(ILayer<? extends INeuron> previousLayer)
```
    Returns a copy of this linked layer
    
    Parameters:
    
    previousLayer - Previous layer to which copied neurons are going to be linked
    
    Returns:
    
    LinkedLayer Copy of this linked layer
  - obtainNewNeuron
```
public abstract LinkedNeuron obtainNewNeuron()
```
    New neuron for the layer
    
    Returns:
    
    LinkedNeuron New neuron for the layer

Class LinkedLayer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

XML

HIDDEN_LAYER

OUTPUT_LAYER

minnofneurons

initialmaxnofneurons

maxnofneurons

neurons

type

biased

Constructor Detail

LinkedLayer

Method Detail

getMinnofneurons

setMinnofneurons

getInitialmaxnofneurons

setInitialmaxnofneurons

getType

setType

isBiased

setBiased

getMaxnofneurons

setMaxnofneurons

addNeuron

removeNeuron

removeNeuron

getNeuron

getNofneurons

equals

hashCode

neuronsFull

neuronsEmpty

linksFull

linksEmpty

getNoflinks

keepRelevantLinks

copy

obtainNewNeuron