/**
 * Copyright 2010 Neuroph Project http://neuroph.sourceforge.net
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.neuroph.nnet.comp.neuron;

import org.neuroph.core.Neuron;
import org.neuroph.core.input.InputFunction;
import org.neuroph.core.transfer.TransferFunction;

/**
 * Provides behaviour for neurons with threshold.
 * @author Zoran Sevarac 
 */
public class ThresholdNeuron extends Neuron {
	
	/**
	 * The class fingerprint that is set to indicate serialization
	 * compatibility with a previous version of the class.
	 */		
	private static final long serialVersionUID = 1L;
	
	/**
	 * Threshold value for this neuron
	 */
	protected double thresh = 0;

	/**
	 * Creates a neuron with threshold behaviour, and with the specified input
	 * and transfer functions.
	 * 
	 * @param inputFunction
	 *            input function for this neuron
	 * @param transferFunction
	 *            transfer function for this neuron
	 */
	public ThresholdNeuron(InputFunction inputFunction, TransferFunction transferFunction) {
		this.inputFunction = inputFunction;
		this.transferFunction = transferFunction;
                this.thresh = Math.random();
	}

	/**
	 * Calculates neuron's output
	 */
	@Override
	public void calculate() {
		this.totalInput = this.inputFunction.getOutput(this.inputConnections);
                this.output = this.transferFunction.getOutput(this.totalInput-this.thresh);
	}

	/**
	 * Returns threshold value for this neuron
	 * @return threshold value for this neuron
	 */
	public double getThresh() {
		return thresh;
	}

	/**
	 * Sets threshold value for this neuron
	 * @param thresh threshold value for this neuron
	 */
	public void setThresh(double thresh) {
		this.thresh = thresh;
	}

}