CapacitatedSpanningTreeAlgorithm.CapacitatedSpanningTree (JGraphT : a free Java graph library)

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Superinterfaces:

Iterable<E>, SpanningTreeAlgorithm.SpanningTree<E>

All Known Implementing Classes:

CapacitatedSpanningTreeAlgorithm.CapacitatedSpanningTreeImpl

Enclosing interface:

CapacitatedSpanningTreeAlgorithm<V,E>
```
public static interface CapacitatedSpanningTreeAlgorithm.CapacitatedSpanningTree<V,E>
extends Iterable<E>, SpanningTreeAlgorithm.SpanningTree<E>
```
A spanning tree.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Map<V,Integer>`	`getLabels()`	Return the set of labels of the underlying partition of the capacitated spanning tree.
`Map<Integer,Pair<Set<V>,Double>>`	`getPartition()`	Return the label-to-partition map of the underlying partition of capacitated spanning tree.
`boolean`	`isCapacitatedSpanningTree(Graph<V,E> graph, V root, double capacity, Map<V,Double> demands)`	Tests whether `cmst` is a CMST on `graph` with root `root`, capacity `capacity` and demand function `demands`.

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface org.jgrapht.alg.interfaces.SpanningTreeAlgorithm.SpanningTree
getEdges, getWeight, iterator

- Method Detail
  - isCapacitatedSpanningTree
```
boolean isCapacitatedSpanningTree(Graph<V,E> graph,
                                  V root,
                                  double capacity,
                                  Map<V,Double> demands)
```
    Tests whether cmst is a CMST on graph with root root, capacity capacity and demand function demands.
    
    Parameters:
    
    graph - the graph
    
    root - the expected root of cmst
    
    capacity - the expected capacity of cmst
    
    demands - the demand function
    
    Returns:
    
    whether cmst is a CMST
  - getLabels
```
Map<V,Integer> getLabels()
```
    Return the set of labels of the underlying partition of the capacitated spanning tree. The labels are a key to the vertex sets of the partition.
    
    Returns:
    
    the label set of the capacitated spanning tree.
  - getPartition
```
Map<Integer,Pair<Set<V>,Double>> getPartition()
```
    Return the label-to-partition map of the underlying partition of capacitated spanning tree.
    
    Returns:
    
    map from labels to the subsets of the partition of the capacitated spanning tree.