opennlp.tools.util.eval.Evaluator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opennlp-tools Show documentation
The newest version!
/*
 * 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 opennlp.tools.util.eval;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import opennlp.tools.util.ObjectStream;

/**
 * An abstract base class for evaluators.
 * Evaluation results are the arithmetic mean of the
 * scores calculated for each reference sample.
 */
public abstract class Evaluator {

  private final List> listeners;

  @SafeVarargs
  public Evaluator(EvaluationMonitor... aListeners) {
    if (aListeners != null) {
      List> listenersList = new ArrayList<>(aListeners.length);
      for (EvaluationMonitor evaluationMonitor : aListeners) {
        if (evaluationMonitor != null) {
          listenersList.add(evaluationMonitor);
        }
      }
      listeners = Collections.unmodifiableList(listenersList);
    } else {
      listeners = Collections.emptyList();
    }
  }

  /**
   * Evaluates the given reference {@link T} sample object.
   * 
   * The implementation has to update the score after every invocation.
   *
   * @param reference A {@link T reference sample}.
   *
   * @return The predicted {@link T sample}.
   */
  protected abstract T processSample(T reference);

  /**
   * Evaluates the given reference object. The default implementation calls
   * {@link Evaluator#processSample(Object)}
   *
   * 

   * note: this method will be changed to private in the future.
   * Implementations should override {@link Evaluator#processSample(Object)} instead.
   * If this method is overridden, the implementation has to update the score
   * after every invocation.
   * 
   *
   * @param sample A {@link T sample} to be evaluated.
   */
  public void evaluateSample(T sample) {
    T predicted = processSample(sample);
    if (!listeners.isEmpty()) {
      if (sample.equals(predicted)) {
        for (EvaluationMonitor listener : listeners) {
          listener.correctlyClassified(sample, predicted);
        }
      } else {
        for (EvaluationMonitor listener : listeners) {
          listener.misclassified(sample, predicted);
        }
      }
    }
  }

  /**
   * Reads all {@link ObjectStream sample objects}
   * and evaluates each instance via the
   * {@link #evaluateSample(Object)} method.
   *
   * @param samples The {@link ObjectStream stream} of reference
   *                which shall be evaluated.
   *
   * @throws IOException Thrown if IO errors occurred.
   */
  public void evaluate(ObjectStream samples) throws IOException {
    T sample;
    while ((sample = samples.read()) != null) {
      evaluateSample(sample);
    }
  }
}