diff options
Diffstat (limited to 'src/de/lmu/ifi/dbs/elki/algorithm/classification/Classifier.java')
-rw-r--r-- | src/de/lmu/ifi/dbs/elki/algorithm/classification/Classifier.java | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/src/de/lmu/ifi/dbs/elki/algorithm/classification/Classifier.java b/src/de/lmu/ifi/dbs/elki/algorithm/classification/Classifier.java new file mode 100644 index 00000000..06cdcd32 --- /dev/null +++ b/src/de/lmu/ifi/dbs/elki/algorithm/classification/Classifier.java @@ -0,0 +1,62 @@ +package de.lmu.ifi.dbs.elki.algorithm.classification; + +/* + This file is part of ELKI: + Environment for Developing KDD-Applications Supported by Index-Structures + + Copyright (C) 2014 + Ludwig-Maximilians-Universität München + Lehr- und Forschungseinheit für Datenbanksysteme + ELKI Development Team + + 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/>. + */ + +import de.lmu.ifi.dbs.elki.algorithm.Algorithm; +import de.lmu.ifi.dbs.elki.data.ClassLabel; +import de.lmu.ifi.dbs.elki.database.Database; +import de.lmu.ifi.dbs.elki.database.relation.Relation; + +/** + * A Classifier is to hold a model that is built based on a database, and to + * classify a new instance of the same type. + * + * @author Arthur Zimek + * + * @param <O> the type of DatabaseObjects handled by this Algorithm + */ +public interface Classifier<O> extends Algorithm { + /** + * Performs the training. Sets available labels. + * + * @param database the database to build the model on + * @param classLabels the classes to be learned + */ + public void buildClassifier(Database database, Relation<? extends ClassLabel> classLabels); + + /** + * Classify a single instance. + * + * @param instance an instance to classify + * @return predicted class label of the given instance + */ + public ClassLabel classify(O instance); + + /** + * Produce a String representation of the classification model. + * + * @return a String representation of the classification model + */ + public String model(); +}
\ No newline at end of file |