MultiLabelLossFunction.java

/*
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this program; if not, write to the Free Software
 *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/*
 *    MultiLabelLossFunction.java
 *    Copyright (C) 2009-2010 Aristotle University of Thessaloniki, Thessaloniki, Greece
 */
package mulan.evaluation.loss;

import mulan.classifier.MultiLabelOutput;

/**
 * Interfance for loss functions
 *
 * @author Grigorios Tsoumakas
 * @version 2010.11.10
 */
public interface MultiLabelLossFunction {

    /**
     * Returns the name of the loss function
     *
     * @return the name of the loss function
     */
    public String getName();

    /**
     * Computes the loss function
     * 
     * @param prediction the prediction of the learner for an example
     * @param groundTruth the ground truth of the example
     * @return the value of the loss function
     */
    public double computeLoss(MultiLabelOutput prediction, boolean[] groundTruth);
}