001    /**
002     * Copyright (C) 2007-2011, Jens Lehmann
003     *
004     * This file is part of DL-Learner.
005     *
006     * DL-Learner is free software; you can redistribute it and/or modify
007     * it under the terms of the GNU General Public License as published by
008     * the Free Software Foundation; either version 3 of the License, or
009     * (at your option) any later version.
010     *
011     * DL-Learner is distributed in the hope that it will be useful,
012     * but WITHOUT ANY WARRANTY; without even the implied warranty of
013     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
014     * GNU General Public License for more details.
015     *
016     * You should have received a copy of the GNU General Public License
017     * along with this program.  If not, see <http://www.gnu.org/licenses/>.
018     */
019    
020    package org.dllearner.core;
021    
022    import java.io.Serializable;
023    
024    /**
025     * The score class is used to store how well a class description did
026     * on a learning problem. Depending on the learning problem at hand,
027     * different criteria can be used. (Similar learning problems probably
028     * score class descriptions/hypothesis in a similar way.)
029     * 
030     * TODO: Maybe we don't really need a score, but only EvaluatedDescription.
031     * 
032     * @author Jens Lehmann
033     *
034     */
035    public abstract class Score implements Serializable{
036    
037            /**
038             * 
039             */
040            private static final long serialVersionUID = -6479328496461875019L;
041    
042            /**
043             * This method returns a value, which indicates how accurate a
044             * class description solves a learning problem. 
045             * 
046             * @see AbstractLearningProblem#getAccuracy(Description)
047             * @return A value between 0 and 1 indicating the quality (of a class description).
048             */     
049            public abstract double getAccuracy();
050            
051    }