ilayer.java

利用Java实现的神经网络工具箱

/*
 * ILayer.java 	1.0 09 Jun 2004
 *
 * NeuralNetworkToolkit
 * Copyright (C) 2004 Universidade de Bras�lia
 *
 * This file is part of NeuralNetworkToolkit.
 *
 * NeuralNetworkToolkit is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * NeuralNetworkToolkit is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with NeuralNetworkToolkit; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA - 02111-1307 - USA.
 */

package neuralnetworktoolkit.neuralnetwork;


/**
 * Interface that defines some basic features of a layer.
 * 
 * @version 1.0 09 Jun 2004
 * 
 * @author <a href="mailto:[e-mail]">Hugo Iver V. Gon�alves</a>
 * @author <a href="mailto:[e-mail]">Rodrigo C. M. Coimbra</a>
 */
public interface ILayer {

	/**
	 * Adds a neuron to the layer.
	 * 
	 * @param neuron Neuron to be added.
	 */
	public void addNeuron(INeuron neuron);
	
	/**
	 * Removes the neuron at index.
	 * 
	 * @param index Index of the neuron to be removed.
	 */
	public void removeNeuron(int index);
	
	/**
	 * Returns the neuron at index.
	 * 
	 * @param index Neuron index.
	 * 
	 * @return Neuron at index.
	 */
	public INeuron getNeuron(int index);
	
	/**
	 * Sets indicated neurons synaptic weigth.
	 * 
	 * @param weight      Synaptic weight to be seted.
	 * @param inputNeuron Preceding layer neuron.
	 * @param neuron      Actual layer neuron.
	 */
	public void setWeight(double weight, int inputNeuron, int neuron);
	
	/**
	 * Returns indicated neurons synaptic weight.
	 * 
	 * @param inputNeuron Preceding layer neuron.
	 * @param neuron      Actual layer neuron.
	 * 
	 * @return Sinaptic weight.
	 */
	public double getWeight(int inputNeuron, int neuron);
	
	/**
	 * Updates indicated neurons synaptic weight.
	 * 
	 * @param increment   Value to be incremented to the actual weight.
	 * @param inputNeuron Preceding layer neuron.
	 * @param neuron      Actual layer neuron.
	 */
	public void updateWeight(double increment, int inputNeuron, int neuron);
	
	/**
	 * Updates indicated neuron <i>bias</i>.
	 * 
	 * @param increment Value to be incremented to actual <i>bias</i>.
	 * @param neuron    Actual layer neuron.
	 */
	public void updateBias(double increment, int neuron);
	
	public void setBias(double value, int neuron);
	
	/**
	 * Sets the layer to be dynamic or static.
	 * 
	 * @param condition Layer condition.
	 */
	public void setIsDynamic(int condition);
	
	/**
	 * Returns layer size (number of neurons).
	 * 
	 * @return Layer size.
	 */
	public int getLayerSize();
	
	/**
	 * Returns neuron <i>bias</i> at index.
	 * 
	 * @param index Neuron index.
	 * 
	 * @return Neuron <i>bias</i>.
	 */
	public double getBias(int index);
	
	/**
	 * Returns the number of neurons connected to the indicated
	 * neuron.
	 * 
	 * @param index Neuron index.
	 * 
	 * @return Number of neurons connected.
	 */
	public int getWeightSize(int index);

} //ILayer