gov.sandia.cognition.learning.function.categorization.Categorizer 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:                Categorizer.java
 * Authors:             Justin Basilico
 * Company:             Sandia National Laboratories
 * Project:             Cognitive Foundry
 *
 * Copyright July 18, 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.function.categorization;

import gov.sandia.cognition.evaluator.Evaluator;
import gov.sandia.cognition.util.CloneableSerializable;
import java.util.Set;

/**
 * The Categorizer interface defines the functionality of an
 * object that can take an input and evaluate what category out of a fixed
 * set of categories it belongs to. The categories are represented as values
 * of type CategoryType.
 * 


 * The term "categorizer" is used here instead of synonymous "classifier" for 
 * two reasons:
 * 

 * 
    1) Java uses the term "class" itself to mean something different.
 * 
    2) At Sandia "classified" has yet another meaning.
 * 


 * Thus we use "categorizer" because using other words from the same stem is
 * does not have these problems: "category", "categorized", "categorization", 
 * etc.
 *
 * @param   The type of the input the categorizer can use.
 * @param   The type of category output by the categorizer.
 * @author Justin Basilico
 * @since  2.0
 */
public interface Categorizer
    extends Evaluator,
    CloneableSerializable
{
    /**
     * Gets the list of possible categories that the categorizer can produce.
     * 
     * @return The list of possible categories.
     */
    Set getCategories();
}