/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.mahout.classifier;

import java.util.Comparator;

/**
 * Result of a document classification. The label and the associated score (usually probabilty)
 */
public class ClassifierResult {

  public static final Comparator<ClassifierResult> COMPARE_BY_SCORE_AND_LABEL =
      new Comparator<ClassifierResult>() {
        @Override
        public int compare(ClassifierResult cr1, ClassifierResult cr2) {
          return cr1.score < cr2.score ? 1 : cr1.score > cr2.score ? -1 : cr1.label.compareTo(cr2.label);
        }
      };

  private String label;
  private double score;
  private double logLikelihood = Double.MAX_VALUE;
  
  public ClassifierResult() { }
  
  public ClassifierResult(String label, double score) {
    this.label = label;
    this.score = score;
  }
  
  public ClassifierResult(String label) {
    this.label = label;
  }

  public ClassifierResult(String label, double score, double logLikelihood) {
    this.label = label;
    this.score = score;
    this.logLikelihood = logLikelihood;
  }

  public double getLogLikelihood() {
    return logLikelihood;
  }

  public void setLogLikelihood(double logLikelihood) {
    this.logLikelihood = logLikelihood;
  }

  public String getLabel() {
    return label;
  }
  
  public double getScore() {
    return score;
  }
  
  public void setLabel(String label) {
    this.label = label;
  }
  
  public void setScore(double score) {
    this.score = score;
  }
  
  @Override
  public String toString() {
    return "ClassifierResult{" + "category='" + label + '\'' + ", score=" + score + '}';
  }
}