Module org.jgrapht.core

Package org.jgrapht.graph

Class WeightedIntrusiveEdgesSpecifics<V,E>

java.lang.Object

org.jgrapht.graph.BaseIntrusiveEdgesSpecifics<V,E,org.jgrapht.graph.IntrusiveWeightedEdge>

org.jgrapht.graph.WeightedIntrusiveEdgesSpecifics<V,E>

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

java.io.Serializable, IntrusiveEdgesSpecifics<V,E>

public class WeightedIntrusiveEdgesSpecifics<V,E>
extends BaseIntrusiveEdgesSpecifics<V,E,org.jgrapht.graph.IntrusiveWeightedEdge>
implements IntrusiveEdgesSpecifics<V,E>

A weighted variant of the intrusive edges specifics.

The implementation optimizes the use of DefaultWeightedEdge and subclasses. For other custom user edge types, a map is used to store vertex source, target and weight.

Author:

Barak Naveh, Dimitrios Michail

See Also:

Serialized Form

Field Summary

Fields inherited from class org.jgrapht.graph.BaseIntrusiveEdgesSpecifics

edgeMap, unmodifiableEdgeSet

Constructor Summary

Constructors

Constructor	Description
WeightedIntrusiveEdgesSpecifics(java.util.Map<E,org.jgrapht.graph.IntrusiveWeightedEdge> map)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	add(E e, V sourceVertex, V targetVertex)	Add a new edge
double	getEdgeWeight(E e)	Get the weight of an edge.
protected org.jgrapht.graph.IntrusiveWeightedEdge	getIntrusiveEdge(E e)	Get the intrusive edge of an edge.
void	setEdgeWeight(E e, double weight)	Set the weight of an edge

Methods inherited from class org.jgrapht.graph.BaseIntrusiveEdgesSpecifics

containsEdge, getEdgeSet, getEdgeSource, getEdgeTarget, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jgrapht.graph.IntrusiveEdgesSpecifics

containsEdge, getEdgeSet, getEdgeSource, getEdgeTarget, remove

Constructor Detail

WeightedIntrusiveEdgesSpecifics

public WeightedIntrusiveEdgesSpecifics(java.util.Map<E,org.jgrapht.graph.IntrusiveWeightedEdge> map)

Constructor

Parameters:

map - the map to use for storage

Method Detail

add

public boolean add(E e,
                   V sourceVertex,
                   V targetVertex)

Description copied from class: BaseIntrusiveEdgesSpecifics

Add a new edge

Specified by:

add in interface IntrusiveEdgesSpecifics<V,E>

Specified by:

add in class BaseIntrusiveEdgesSpecifics<V,E,org.jgrapht.graph.IntrusiveWeightedEdge>

Parameters:

e - the edge

sourceVertex - the source vertex of the edge

targetVertex - the target vertex of the edge

Returns:

true if the edge was added, false if the edge was already present

getEdgeWeight

public double getEdgeWeight(E e)

Description copied from class: BaseIntrusiveEdgesSpecifics

Get the weight of an edge.

Specified by:

getEdgeWeight in interface IntrusiveEdgesSpecifics<V,E>

Overrides:

getEdgeWeight in class BaseIntrusiveEdgesSpecifics<V,E,org.jgrapht.graph.IntrusiveWeightedEdge>

Parameters:

e - the edge

Returns:

the weight of an edge

setEdgeWeight

public void setEdgeWeight(E e,
                          double weight)

Description copied from class: BaseIntrusiveEdgesSpecifics

Set the weight of an edge

Specified by:

setEdgeWeight in interface IntrusiveEdgesSpecifics<V,E>

Overrides:

setEdgeWeight in class BaseIntrusiveEdgesSpecifics<V,E,org.jgrapht.graph.IntrusiveWeightedEdge>

Parameters:

e - the edge

weight - the new weight

getIntrusiveEdge

protected org.jgrapht.graph.IntrusiveWeightedEdge getIntrusiveEdge(E e)

Description copied from class: BaseIntrusiveEdgesSpecifics

Get the intrusive edge of an edge.

Specified by:

getIntrusiveEdge in class BaseIntrusiveEdgesSpecifics<V,E,org.jgrapht.graph.IntrusiveWeightedEdge>

Parameters:

e - the edge

Returns:

the intrusive edge