ineuron.java

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

/*
 * INeuron.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;

import neuralnetworktoolkit.activationfunctions.*;

/**
 * Interface that defines some basic features of a neuron.
 * 
 * @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 INeuron {
	
	/**
	 * Calculates the neuron output based on the actual input.
	 * 
	 * @return Neuron output value.
	 */
	public double calculateOutputValue();
	
	/**
	 * Sets neuron activation function.
	 * 
	 * @param activationFunction Activation function to be seted.
	 */
	public void setActivationFunction(IActivationFunction activationFunction);
	
	/**
	 * Returns the actual neuron activation function.
	 * 
	 * @return Neuron activation function.
	 */
	public IActivationFunction getActivationFunction();
	
	/**
	 * Returns the actual neuron output value.
	 * 
	 * @return Actual output value.
	 */
	public double getOutputValue();
	
	/**
	 * Sets actual neuron delta value.
	 * 
	 * @param delta Actual delta value.
	 */
	public void setDelta(double delta);
	
	/**
	 * Returns the actual neuron delta value.
	 * 
	 * @return Neuron delta value.
	 */
	public double getDelta();
	
	/**
	 * Sets neuron input value.
	 * 
	 * @param input Neuron input value.
	 */
	public void setInput(double input);
	
	/**
	 * Returns actual neuron input value.
	 * 
	 * @return Neuron input value.
	 */
	public double getInput();

} //INeuron