/*
* RapidMiner
*
* Copyright (C) 2001-2008 by Rapid-I and the contributors
*
* Complete list of developers available at our web site:
*
* http://rapid-i.com
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see http://www.gnu.org/licenses/.
*/
package com.rapidminer.tools.math.som;
import java.io.Serializable;
/**
* This interface provides the methods for adapting nodes to an input.
*
* @author Sebastian Land
* @version $Id: AdaptationFunction.java,v 1.3 2008/06/18 14:28:36 stiefelolm Exp $
*/
public interface AdaptationFunction extends Serializable{
/**
* This method returns the new value of a node, after it had adopted to a stimulus.
* The stimulus and the old node value are given. The distance from the impact of the
* stimulus may influence the strength of the adoption to the stimulus, as may the
* current trainingsphase (time) and the total number of trainingsphases (timemax)
*/
public double[] adapt(double[] stimulus, double[] nodeValue, double distanceFromImpact, int time, int timemax);
/**
* This method returns the maximum adaption radius, given the input stimulus, the current
* trainingsphase (time) and the total number of trainingsphases (timemax). It may be used
* for finding all nodes effected by the stimulus.
*/
public double getAdaptationRadius(double[] stimulus, int time, int timemax);
}