Module org.jgrapht.core

Package org.jgrapht.alg.interfaces

Class CycleBasisAlgorithm.CycleBasisImpl<V,E>

java.lang.Object

org.jgrapht.alg.interfaces.CycleBasisAlgorithm.CycleBasisImpl<V,E>

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

java.io.Serializable, CycleBasisAlgorithm.CycleBasis<V,E>

Enclosing interface:

CycleBasisAlgorithm<V,E>

public static class CycleBasisAlgorithm.CycleBasisImpl<V,E>
extends java.lang.Object
implements CycleBasisAlgorithm.CycleBasis<V,E>, java.io.Serializable

Default implementation of the undirected cycle basis interface.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CycleBasisImpl(Graph<V,E> graph)	Construct a new instance.
CycleBasisImpl(Graph<V,E> graph, java.util.Set<java.util.List<E>> cycles, int length, double weight)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.util.List<E>>	getCycles()	Return the set of cycles of the cycle basis.
java.util.Set<GraphPath<V,E>>	getCyclesAsGraphPaths()	Return the set of cycles of the cycle basis.
int	getLength()	Get the length of the cycle basis.
double	getWeight()	Get the weight of the cycle basis.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CycleBasisImpl

public CycleBasisImpl(Graph<V,E> graph)

Construct a new instance.

Parameters:

graph - the graph

CycleBasisImpl

public CycleBasisImpl(Graph<V,E> graph,
                      java.util.Set<java.util.List<E>> cycles,
                      int length,
                      double weight)

Construct a new instance.

Parameters:

graph - the graph

cycles - the cycles of the basis

length - the length of the cycle basis

weight - the weight of the cycle basis

Method Detail

getCycles

public java.util.Set<java.util.List<E>> getCycles()

Return the set of cycles of the cycle basis.

Specified by:

getCycles in interface CycleBasisAlgorithm.CycleBasis<V,E>

Returns:

the set of cycles of the cycle basis

getLength

public int getLength()

Get the length of the cycle basis. The length of the cycle basis is the sum of the lengths of its cycles. The length of a cycle is the total number of edges of the cycle.

Specified by:

getLength in interface CycleBasisAlgorithm.CycleBasis<V,E>

Returns:

the length of the cycles basis

getWeight

public double getWeight()

Get the weight of the cycle basis. The weight of the cycle basis is the sum of the weights of its cycles. The weight of a cycle is the sum of the weights of its edges.

Specified by:

getWeight in interface CycleBasisAlgorithm.CycleBasis<V,E>

Returns:

the length of the cycles basis

getCyclesAsGraphPaths

public java.util.Set<GraphPath<V,E>> getCyclesAsGraphPaths()

Return the set of cycles of the cycle basis.

Specified by:

getCyclesAsGraphPaths in interface CycleBasisAlgorithm.CycleBasis<V,E>

Returns:

the set of cycles of the cycle basis