MicroFMeasure.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.
 */

/*
 *    MicroFMeasure.java
 *    Copyright (C) 2009-2011 Aristotle University of Thessaloniki, Greece
 */
package mulan.evaluation.measure;

import weka.core.Utils;

/**
 * Implementation of the micro-averaged precision measure.
 *
 * @author Grigorios Tsoumakas
 * @version 2010.12.31
 */
public class MicroFMeasure extends LabelBasedFMeasure {

    /**
     * Constructs a new object with given number of labels
     *
     * @param numOfLabels the number of labels
     */
    public MicroFMeasure(int numOfLabels) {
        super(numOfLabels);
    }

    /**
     * Full constructor
     *
     * @param numOfLabels the number of labels
     * @param beta the beta parameter
     */
    public MicroFMeasure(int numOfLabels, double beta) {
        super(numOfLabels, beta);
    }

    public double getValue() {
        double tp = Utils.sum(truePositives);
        double fp = Utils.sum(falsePositives);
        double fn = Utils.sum(falseNegatives);

        return FMeasure.compute(tp, fp, fn, beta);
    }

    public String getName() {
        return "Micro-averaged F-Measure";
    }
}