/*
 * Copyright (C) 2014 Laboratoire ThéMA - UMR 6049 - CNRS / Université de Franche-Comté
 * http://thema.univ-fcomte.fr
 *
 * 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 3 of the License, or
 * 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, see <http://www.gnu.org/licenses/>.
 */


package org.thema.graphab.metric.global;

import org.thema.graphab.Project;
import org.thema.graphab.graph.GraphGenerator;

/**
 * Class Coincidence Probability metric.
 * Sum of squared ratio of capacity components
 * Sum of pi^2 where pi = capacity of component i / total capacity
 * @author Gilles Vuidel
 */
public class CCPMetric extends GlobalMetric {

    @Override
    public Double[] calcMetric(GraphGenerator g) {
        double total = g.getPatchCapacity();
        double sum = 0;
        for(int i = 0; i < g.getComponents().size(); i++) {
            double size = g.getComponentGraphGen(i).getPatchCapacity();
            sum += Math.pow(size / total, 2);
        }

        return new Double[]{sum};
    }

    @Override
    public String getShortName() {
        return "CCP";
    }

    @Override
    public boolean isAcceptMethod(Project.Method method, boolean capacityAsArea) {
        return method == Project.Method.GLOBAL;
    }

    @Override
    public Type getType() {
        return Type.AREA;
    }
}
