opennlp.tools.util.eval.Evaluator Maven / Gradle / Ivy
/*
* 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 opennlp.tools.util.ObjectStream;
/**
* The {@link Evaluator} is an abstract base class for evaluators.
*
* Evaluation results are the arithmetic mean of the
* scores calculated for each reference sample.
*/
public abstract class Evaluator {
/**
* Evaluates the given reference object.
*
* The implementation has to update the score after every invocation.
*
* @param sample the sample to be evaluated
*/
public abstract void evaluateSample(T sample);
/**
* Reads all sample objects from the stream
* and evaluates each sample object with
* {@link #evaluateSample(Object)} method.
*
* @param samples the stream of reference which
* should be evaluated.
*/
public void evaluate(ObjectStream samples) throws IOException {
T sample;
while ((sample = samples.read()) != null) {
evaluateSample(sample);
}
}
}