|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.uci.ics.jung.algorithms.scoring.AbstractIterativeScorer<V,E,Double>
edu.uci.ics.jung.algorithms.scoring.VoltageScorer<V,E>
public class VoltageScorer<V,E>
Assigns scores to vertices according to their 'voltage' in an approximate solution to the Kirchoff equations. This is accomplished by tying "source" vertices to specified positive voltages, "sink" vertices to 0 V, and iteratively updating the voltage of each other vertex to the (weighted) average of the voltages of its neighbors.
The resultant voltages will all be in the range [0, max]
where max
is the largest voltage of any source vertex (in the
absence of negative source voltages; see below).
A few notes about this algorithm's interpretation of the graph data:
Field Summary | |
---|---|
protected Collection<V> |
sinks
|
protected Map<V,? extends Number> |
source_voltages
|
Fields inherited from class edu.uci.ics.jung.algorithms.scoring.AbstractIterativeScorer |
---|
edge_weights, graph, hyperedges_are_self_loops, max_delta, max_iterations, output_reversed, tolerance, total_iterations |
Constructor Summary | |
---|---|
VoltageScorer(Hypergraph<V,E> g,
Collection<V> sources,
Collection<V> sinks)
Creates an instance with the specified graph, source vertices (each of whose 'voltages' are tied to 1), and sinks. |
|
VoltageScorer(Hypergraph<V,E> g,
Map<V,? extends Number> source_voltages,
Collection<V> sinks)
Creates an instance with the specified graph, source voltages, and sinks. |
|
VoltageScorer(Hypergraph<V,E> g,
org.apache.commons.collections15.Transformer<E,? extends Number> edge_weights,
Collection<V> sources,
Collection<V> sinks)
Creates an instance with the specified graph, edge weights, source vertices (each of whose 'voltages' are tied to 1), and sinks. |
|
VoltageScorer(Hypergraph<V,E> g,
org.apache.commons.collections15.Transformer<E,? extends Number> edge_weights,
Map<V,? extends Number> source_voltages,
Collection<V> sinks)
Creates an instance with the specified graph, edge weights, source voltages, and sinks. |
|
VoltageScorer(Hypergraph<V,E> g,
org.apache.commons.collections15.Transformer<E,? extends Number> edge_weights,
V source,
V sink)
Creates an instance with the specified graph, edge weights, source, and sink. |
|
VoltageScorer(Hypergraph<V,E> g,
V source,
V sink)
Creates an instance with the specified graph, edge weights, source, and sink. |
Method Summary | |
---|---|
void |
initialize()
Initializes the state of this instance. |
double |
update(V v)
Updates the value for v . |
Methods inherited from class edu.uci.ics.jung.algorithms.scoring.AbstractIterativeScorer |
---|
acceptDisconnectedGraph, afterStep, collectDisappearingPotential, done, evaluate, getAdjustedIncidentCount, getCurrentValue, getEdgeWeight, getEdgeWeights, getIterations, getMaxIterations, getOutputValue, getTolerance, getVertexScore, isDisconnectedGraphOK, setCurrentValue, setEdgeWeights, setHyperedgesAreSelfLoops, setMaxIterations, setOutputValue, setTolerance, step, swapOutputForCurrent, updateMaxDelta |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface edu.uci.ics.jung.algorithms.scoring.VertexScorer |
---|
getVertexScore |
Field Detail |
---|
protected Map<V,? extends Number> source_voltages
protected Collection<V> sinks
Constructor Detail |
---|
public VoltageScorer(Hypergraph<V,E> g, org.apache.commons.collections15.Transformer<E,? extends Number> edge_weights, Map<V,? extends Number> source_voltages, Collection<V> sinks)
g
- the input graphedge_weights
- the edge weights, representing conductivitysource_voltages
- the (fixed) voltage for each sourcesinks
- the vertices whose voltages are tied to 0public VoltageScorer(Hypergraph<V,E> g, org.apache.commons.collections15.Transformer<E,? extends Number> edge_weights, Collection<V> sources, Collection<V> sinks)
g
- the input graphedge_weights
- the edge weights, representing conductivitysources
- the vertices whose voltages are tied to 1sinks
- the vertices whose voltages are tied to 0public VoltageScorer(Hypergraph<V,E> g, Collection<V> sources, Collection<V> sinks)
g
- the input graphsources
- the vertices whose voltages are tied to 1sinks
- the vertices whose voltages are tied to 0public VoltageScorer(Hypergraph<V,E> g, Map<V,? extends Number> source_voltages, Collection<V> sinks)
g
- the input graphsource_voltages
- the (fixed) voltage for each sourcesinks
- the vertices whose voltages are tied to 0public VoltageScorer(Hypergraph<V,E> g, org.apache.commons.collections15.Transformer<E,? extends Number> edge_weights, V source, V sink)
g
- the input graphedge_weights
- the edge weights, representing conductivitysource
- the vertex whose voltage is tied to 1sink
- the vertex whose voltage is tied to 0public VoltageScorer(Hypergraph<V,E> g, V source, V sink)
g
- the input graphsource
- the vertex whose voltage is tied to 1sink
- the vertex whose voltage is tied to 0Method Detail |
---|
public void initialize()
initialize
in class AbstractIterativeScorer<V,E,Double>
public double update(V v)
AbstractIterativeScorer
v
.
This is the key
update
in class AbstractIterativeScorer<V,E,Double>
v
- the vertex whose value is to be updated
AbstractIterativeScorer.update(Object)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |