Repository /Debellor/debellor-1.0.jar:org.debellor.base.evaluator.score.Score

/*
 *  Debellor
 *
 *  Copyright (C) 2008-2009 by Marcin Wojnarski
 *
 *  This program 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 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see http://www.gnu.org/licenses/.
 */
package org.debellor.base.evaluator.score;

import org.debellor.base.evaluator.EvaluatorCell;
import org.debellor.core.DataObject;
import org.debellor.core.exception.data.DataException;

/**
 * Base class for classes which calculate value of a quality measure
 * (accuracy, confusion matrix, RMSE, ...) of decision systems.
 * 
 * @see EvaluatorCell
 * @author Marcin Wojnarski
 *
 */
public abstract class Score {

	/**
	 * Update the score with another pair of (target,prediction) decisions.
	 * 
	 * @param target Ground truth decision of a sample.
	 * @param prediction Decision predicted by a decision algorithm.
	 * @throws DataException 
	 */
	public abstract void add(DataObject target, DataObject prediction) throws DataException;
	
	/**
	 * Calculates the value(s) of the quality measure
	 * and returns in a form of a textual report.
	 */
	public abstract String report();

	public abstract double result();

	/**
	 * Resets the score to its initial state.
	 */
	public abstract void reset();

}