org.graphstream.algorithm.measure.CommunityRelativeMeasure Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gs-algo Show documentation

The GraphStream library. With GraphStream you deal with graphs. Static and Dynamic. You create them from scratch, from a file or any source. You display and render them. This package contains algorithms and generators.

There is a newer version: 2.0

Show newest version

/*
 * Copyright 2006 - 2013
 *     Stefan Balev     
 *     Julien Baudry    
 *     Antoine Dutot    
 *     Yoann Pigné      
 *     Guilhelm Savin   
 * 
 * This file is part of GraphStream .
 * 
 * GraphStream is a library whose purpose is to handle static or dynamic
 * graph, create them from scratch, file or any source and display them.
 * 
 * This program is free software distributed under the terms of two licenses, the
 * CeCILL-C license that fits European law, and the GNU Lesser General Public
 * License. You can  use, modify and/ or redistribute the software under the terms
 * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following
 * URL  or under the terms of the GNU LGPL as published by
 * the Free Software Foundation, either version 3 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 * 
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms.
 */
package org.graphstream.algorithm.measure;

import static org.graphstream.algorithm.Toolkit.communities;

import java.util.HashMap;
import java.util.HashSet;

import org.graphstream.graph.Node;

/**
 * Computes and updates a relative measure based on the comparison between the
 * current community assignment and a reference assignment on a given graph.
 * 
 * @author Guillaume-Jean Herbiet
 * 
 */
public abstract class CommunityRelativeMeasure extends CommunityMeasure {

	/**
	 * Name of the attribute marking the reference communities.
	 */
	protected String referenceMarker;

	/**
	 * All reference communities indexed by their marker value.
	 */
	protected HashMap> referenceCommunities;

	public CommunityRelativeMeasure(String marker) {
		super(marker);
		this.referenceMarker = "label";
	}

	/**
	 * New comparative measure using "marker" as attribute name for each node
	 * current community assignment and "referenceMarker" as attribute name for
	 * each node reference assignment.
	 * 
	 * @param marker
	 *            Current community assignment attribute name
	 * @param referenceMarker
	 *            Reference community assignment attribute name
	 */
	public CommunityRelativeMeasure(String marker, String referenceMarker) {
		super(marker);
		this.referenceMarker = referenceMarker;
	}

	// /**
	// * New comparative measure using the results of the specified algorithm as
	// * current community assignment and "referenceMarker" as attribute name
	// for
	// * each node reference assignment.
	// *
	// * @param algo
	// * Algorithm which results will be used for measurement.
	// * @param referenceMarker
	// * Reference community assignment attribute name
	// */
	// public CommunityMeasure(CommunityAlgorithm algo) {
	// this.marker = algo.getMarker();
	// this.referenceMarker = referenceMarker;
	// }

	@Override
	public abstract void compute();

	@Override
	protected void initialize() {
		super.initialize();
		referenceCommunities = communities(graph, referenceMarker);
	}

	@Override
	public void nodeAdded(String graphId, long timeId, String nodeId) {
		super.nodeAdded(graphId, timeId, nodeId);

		Node n = graph.getNode(nodeId);
		assignNode(nodeId, n.getAttribute(referenceMarker),
				referenceCommunities);
	}

	@Override
	public void nodeRemoved(String graphId, long timeId, String nodeId) {
		super.nodeRemoved(graphId, timeId, nodeId);

		Node n = graph.getNode(nodeId);
		unassignNode(nodeId, n.getAttribute(referenceMarker),
				referenceCommunities);
	}

	@Override
	public void nodeAttributeChanged(String graphId, long timeId,
			String nodeId, String attribute, Object oldValue, Object newValue) {
		super.nodeAttributeChanged(graphId, timeId, nodeId, attribute,
				oldValue, newValue);

		if (attribute.equals(referenceMarker) && oldValue != newValue) {
			unassignNode(nodeId, oldValue, referenceCommunities);
			assignNode(nodeId, newValue, referenceCommunities);
		}
	}
}