simplecriterion.java

著名的开源仿真软件yale

/*
 *  YALE - Yet Another Learning Environment
 *  Copyright (C) 2002, 2003
 *      Simon Fischer, Ralf Klinkenberg, Ingo Mierswa, 
 *          Katharina Morik, Oliver Ritthoff
 *      Artificial Intelligence Unit
 *      Computer Science Department
 *      University of Dortmund
 *      44221 Dortmund,  Germany
 *  email: [e-mail]
 *  web:   http://yale.cs.uni-dortmund.de/
 *
 *  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 2 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, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 *  USA.
 */
package edu.udo.cs.yale.operator.performance;

import edu.udo.cs.yale.example.Example;
import edu.udo.cs.yale.example.ExampleSet;

/** Simple criteria are those which error can be counted for each example and can be
 *  averaged by the number of examples. 
 *  The fitness has a reciprocal value of the error.
 *  @author Ingo, Simon
 *  @version 11.10.2001
 */
public abstract class SimpleCriterion extends MeasuredPerformance {

    private double sum        = 0.0;
    private double squaresSum = 0.0;
    private int exampleCount  = 0;

    /** Invokes <code>countExample(double, double)</code> and uses 0 as predicted label if it not a number (NaN). */
    public void countExample(Example example) {
	double plabel = example.getPredictedLabel();
	if (Double.isNaN(plabel)) plabel = 0;
	double deviation = countExample(example.getLabel(), plabel);
	if (!Double.isNaN(deviation)) {
	    countExample(deviation);
	}
    }

    /** Subclasses must count the example and return the value to sum up. */
    protected abstract double countExample(double label, double predictedLabel);

    protected void countExample(double deviation) {
	if (!Double.isNaN(deviation)) {
	    sum        += deviation;
	    squaresSum += deviation*deviation;
	    exampleCount++;
	}
    }
    

    public double getValue() {
	return sum / exampleCount;
    } 

    public double getVariance() {
	double mean        = getValue();
	double meanSquares = squaresSum / exampleCount;
	return meanSquares - mean*mean;
    }

    public void startCounting(ExampleSet eset) {
	super.startCounting(eset);
	exampleCount = 0;
	sum = squaresSum = 0;
    }

    public double getFitness() {
	if (getValue() == 0.0) return Double.POSITIVE_INFINITY;
	return 1/getValue();
    }
    
    void clonePerformanceCriterion(PerformanceCriterion newPC) {
	super.clonePerformanceCriterion(newPC);
	SimpleCriterion sc = (SimpleCriterion)newPC;
	this.sum          = sc.sum;
	this.squaresSum   = sc.squaresSum;
	this.exampleCount = sc.exampleCount;
    }

    public void buildAverage(PerformanceCriterion performance) {
	super.buildAverage(performance);
	SimpleCriterion other = (SimpleCriterion)performance;
	this.sum          += other.sum;
	this.squaresSum   += other.squaresSum;
	this.exampleCount += other.exampleCount;
    }

}