001/** 
002 * Copyright (c) 2009, Regents of the University of Colorado 
003 * All rights reserved.
004 * 
005 * Redistribution and use in source and binary forms, with or without
006 * modification, are permitted provided that the following conditions are met:
007 * 
008 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
009 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 
010 * Neither the name of the University of Colorado at Boulder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 
011 * 
012 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
013 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
014 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
015 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
016 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
017 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
018 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
019 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
020 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
021 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
022 * POSSIBILITY OF SUCH DAMAGE. 
023 */
024package org.cleartk.ml;
025
026import java.util.List;
027import java.util.Map;
028
029/**
030 * <br>
031 * Copyright (c) 2009, Regents of the University of Colorado <br>
032 * All rights reserved.
033 * <p>
034 */
035
036public interface SequenceClassifier<OUTCOME_TYPE> {
037
038  /**
039   * Classifies a sequence of feature lists.
040   * 
041   * @param features
042   *          a list of features for each member in the sequence
043   * @return a list of the classifications made.
044   */
045  public List<OUTCOME_TYPE> classify(List<List<Feature>> features)
046      throws CleartkProcessingException;
047
048  /**
049   * Classify a sequence of feature lists, and return the scores for each of the outcomes for each
050   * feature list.
051   * 
052   * @param features
053   *          a list of features for each member in the sequence
054   * @return a map from outcomes to classification scores for each member in the sequence
055   */
056  public List<Map<OUTCOME_TYPE, Double>> score(List<List<Feature>> features)
057      throws CleartkProcessingException;
058}