/*
 *  RapidMiner
 *
 *  Copyright (C) 2001-2011 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.similarity.divergences;

import com.rapidminer.example.Attribute;
import com.rapidminer.example.Attributes;
import com.rapidminer.example.Example;
import com.rapidminer.example.ExampleSet;
import com.rapidminer.example.Tools;
import com.rapidminer.operator.OperatorException;
import com.rapidminer.tools.math.similarity.BregmanDivergence;

/**
 * The "Generalized I-divergence ".
 * 
 * @author Regina Fritsch
 */
public class GeneralizedIDivergence extends BregmanDivergence {

	private static final long serialVersionUID = 5638471495692639837L;

	@Override
	public double calculateDistance(double[] value1, double[] value2) {
		double result = 0;
		double result2 = 0;
		for (int i = 0; i < value1.length; i++) {
			result += value1[i] * Math.log((value1[i]) / value2[i]);
			result2 += (value1[i] - value2[i]);
		}
		result = result - result2;
		return result;
	}

	@Override
	public void init(ExampleSet exampleSet) throws OperatorException {
		super.init(exampleSet);
	    Tools.onlyNumericalAttributes(exampleSet, "value based similarities");
		Attributes attributes = exampleSet.getAttributes();
		for (Example example: exampleSet) {
			for (Attribute attribute: attributes) {
				if (example.getValue(attribute) <= 0) 
					throw new OperatorException("The bregman divergence you've choosen is not applicable for the dataset! Proceeding with the 'Squared Euclidean distance' bregman divergence.");;
			}
		}
	}

	@Override
	public String toString() {
		return "generalized I-divergence";
	}
}