001/**
002 * Copyright (C) 2007 - 2016, 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 */
019package org.dllearner.learningproblems;
020
021import java.util.Set;
022
023import org.dllearner.core.Score;
024import org.semanticweb.owlapi.model.OWLEntity;
025
026/**
027 * The score class is used to store how well a class description did
028 * on a learning problem.
029 * 
030 * @author Jens Lehmann
031 *
032 */
033public abstract class ScorePosNeg<T extends OWLEntity> extends Score {
034        
035        private static final long serialVersionUID = -4646131678864109469L;
036
037        public abstract double getScoreValue();
038        
039        // example coverage
040        public abstract Set<T> getCoveredPositives();
041        public abstract Set<T> getCoveredNegatives();
042        public abstract Set<T> getNotCoveredPositives();
043        public abstract Set<T> getNotCoveredNegatives();        
044        
045        /**
046         * The score of a concept depends on how good it classifies the
047         * examples of a learning problem and the length of the concept
048         * itself. If a given concept is known to have equal classification
049         * properties than the concept this score object is based on, then
050         * this method can be used to calculate its score value by using the
051         * length of this concept as parameter.
052         * 
053         * @param newLength Length of the concept.
054         * @return Score.
055         */
056        public abstract ScorePosNeg<T> getModifiedLengthScore(int newLength);
057        
058}