com.salesforce.jgrapht.alg.cycle.UndirectedCycleBase Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of AptSpringProcessor Show documentation

This project contains the apt processor that implements all the checks enumerated in @Verify. It is a self contained, and shaded jar.

There is a newer version: 2.0.7

Show newest version

/*
 * (C) Copyright 2013-2017, by Nikolay Ognyanov and Contributors.
 *
 * JGraphT : a free Java graph-theory library
 *
 * This program and the accompanying materials are dual-licensed under
 * either
 *
 * (a) the terms of the GNU Lesser General Public License version 2.1
 * as published by the Free Software Foundation, or (at your option) any
 * later version.
 *
 * or (per the licensee's choosing)
 *
 * (b) the terms of the Eclipse Public License v1.0 as published by
 * the Eclipse Foundation.
 */
package com.salesforce.jgrapht.alg.cycle;

import java.util.*;

import com.salesforce.jgrapht.*;

/**
 * A common interface for classes implementing algorithms for finding a cycle base of an undirected
 * graph.
 *
 * @param  the vertex type.
 * @param  the edge type.
 *
 * @author Nikolay Ognyanov
 */
public interface UndirectedCycleBase
{
    /**
     * Returns the graph on which the cycle base search algorithm is executed by this object.
     *
     * @return The graph.
     */
    UndirectedGraph getGraph();

    /**
     * Sets the graph on which the cycle base search algorithm is executed by this object.
     *
     * @param graph the graph.
     *
     * @throws IllegalArgumentException if the argument is null.
     */
    void setGraph(UndirectedGraph graph);

    /**
     * Finds a cycle base of the graph.

     * Note that the full algorithm is executed on every call since the graph may have changed
     * between calls.
     *
     * @return A list of cycles constituting a cycle base for the graph. Possibly empty but never
     *         null.
     *
     * @throws IllegalArgumentException if the current graph is null.
     */
    List> findCycleBase();
}

// End UndirectedCycleBase.java