gov.sandia.cognition.learning.performance.PerformanceEvaluator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cognitive-foundry Show documentation

A single jar with all the Cognitive Foundry components.

There is a newer version: 4.0.1

/*
 * File:                PerformanceEvaluator.java
 * Authors:             Justin Basilico
 * Company:             Sandia National Laboratories
 * Project:             Cognitive Framework Lite
 *
 * Copyright September 27, 2007, Sandia Corporation.  Under the terms of Contract
 * DE-AC04-94AL85000, there is a non-exclusive license for use of this work by
 * or on behalf of the U.S. Government. Export of this program may require a
 * license from the United States Government. See CopyrightHistory.txt for
 * complete details.
 *
 *
 */

package gov.sandia.cognition.learning.performance;

import gov.sandia.cognition.util.CloneableSerializable;

/**
 * The {@code PerformanceEvaluator} class defines the functionality of some
 * object with regards to some data.
 * 
 * It is recommended that a {@link PerformanceEvaluator} implement
 * {@link CloneableSerializable}, though it is not required.
 *
 * @param    The type of object the class can evaluate the 
 *          performance of.
 * @param    The data to use to evaluate the object's performance.
 * @param    The type of the result of the performance evaluation.
 * @author  Justin Basilico
 * @since   2.0
 */
public interface PerformanceEvaluator
{
    /**
     * Evaluates the performance of an object with regards to given data.
     *
     * @param  object The object to evaluate the performance of.
     * @param  data The data to evaluate the object using.
     * @return The performance evaluation result.
     */
    ResultType evaluatePerformance(
        ObjectType object,
        DataType data);
}