classycle.graph.GraphAttributes Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of classycle Show documentation
dependency analysis tool based on bytecode inspection
The newest version!
/*
 * Copyright (c) 2003-2008, Franz-Josef Elmer, All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 * 
 * - Redistributions of source code must retain the above copyright notice, 
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice, 
 *   this list of conditions and the following disclaimer in the documentation 
 *   and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 */
package classycle.graph;

/**
 * Attributes of a graph. The following properties
 * can be accessed with this interface:
 * Girth:
The length of the shortest cycle.
 *     Eccentricities:
 *     The eccentricity for each vertex of the graph. The eccentricity of
 *         a vertex is the largest distance to other vertices of the 
 *         graph. The distance between vertex A and B is defined as the
 *         shortest path from A to B. The distance is infinite if there is
 *         no path from A to B.
 *     
Diameter:
The largest eccentricity. 
 *     Radius:
The smallest eccentricity.
 *     Center:
 *     The set of vertices of the graph with the smallest eccentricities.
 *     
 *     Maximum fragment sizes:
 *     The maximum fragment sizes for each vertex of the graph. The
 *         maximum fragment size of a vertex is defined as the size of the 
 *         largest strong component of the graph after the vertex has been
 *         removed. 
 *     
 *     Best fragment size:
 *     The smallest maximum fragment size.
 *     Best fragmenters:
 *     The set of vertices of the graph with smallest maximum fragment size.
 *     
 * 
 * 
 * @author Franz-Josef Elmer
 */
public interface GraphAttributes extends Attributes {
  /** Returns the girth. */
  public int getGirth();
  
  /** Returns the radius. */
  public int getRadius();
  
  /** Returns the diameter. */
  public int getDiameter();
  
  /** Returns the vertices of the center. */
  public Vertex[] getCenterVertices();
  
  /** 
   * Returns the eccentricies of all vertices of a {@link StrongComponent}. 
   */
  public int[] getEccentricities();
  
  /**
   * Returns the maximum fragment sizes of all vertices of 
   * a {@link StrongComponent}.
   */ 
  public int[] getMaximumFragmentSizes();
  
  /** Returns the best fragment size. */
  public int getBestFragmentSize();
  
  /**
   * Returns those vertices of a {@link StrongComponent} where the maximum
   * fragment size is equal to the best fragment size.
   */ 
  public Vertex[] getBestFragmenters();
} //interface