001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.experiment.evaluation.cluster.analyser;
031
032import org.openimaj.experiment.evaluation.AnalysisResult;
033
034import net.sf.jasperreports.engine.JRException;
035import net.sf.jasperreports.engine.JasperPrint;
036
037/**
038 * Measures normalised mutual information. Intuatively this is how much information
039 * one gets about the true clustering given the estimate clustering
040 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
041 */
042public class NMIAnalysis implements AnalysisResult,RandomBaselineWrappable{
043
044        /**
045         * The NMI
046         */
047        public double nmi;
048
049        @Override
050        public JasperPrint getSummaryReport(String title, String info) throws JRException {
051                throw new UnsupportedOperationException();
052        }
053
054        @Override
055        public JasperPrint getDetailReport(String title, String info) throws JRException {
056                throw new UnsupportedOperationException();
057        }
058
059        @Override
060        public String getSummaryReport() {
061                return toString();
062        }
063
064        @Override
065        public String getDetailReport() {
066                return toString();
067        }
068        
069        @Override
070        public String toString() {
071                return String.format("nmi=%2.4f",nmi);
072        }
073
074        @Override
075        public double score() {
076                return nmi;
077        }
078
079}