Module org.jgrapht.unimi.dsi

Package org.jgrapht.webgraph

Class ImmutableDirectedBigGraphAdapter

java.lang.Object

org.jgrapht.graph.AbstractGraph<Long,E>

org.jgrapht.webgraph.AbstractImmutableBigGraphAdapter<it.unimi.dsi.fastutil.longs.LongLongPair>

org.jgrapht.webgraph.ImmutableDirectedBigGraphAdapter

All Implemented Interfaces:

it.unimi.dsi.lang.FlyweightPrototype<ImmutableDirectedBigGraphAdapter>, Graph<Long,it.unimi.dsi.fastutil.longs.LongLongPair>

public class ImmutableDirectedBigGraphAdapter
extends AbstractImmutableBigGraphAdapter<it.unimi.dsi.fastutil.longs.LongLongPair>
implements it.unimi.dsi.lang.FlyweightPrototype<ImmutableDirectedBigGraphAdapter>

An adapter class for directed graphs using WebGraph (big)'s ImmutableGraph.

This class is equivalent to ImmutableDirectedGraphAdapter, except that nodes are instances of Long, and edges are instances of LongLongPair.

If necessary, you can adapt a standard WebGraph graph using the suitable wrapper.

Author:

Sebastiano Vigna

See Also:

ImmutableDirectedGraphAdapter

Field Summary

Fields inherited from class org.jgrapht.webgraph.AbstractImmutableBigGraphAdapter

immutableGraph, m, n

Fields inherited from interface org.jgrapht.Graph

DEFAULT_EDGE_WEIGHT

Constructor Summary

Constructors

Constructor	Description
ImmutableDirectedBigGraphAdapter(it.unimi.dsi.big.webgraph.ImmutableGraph immutableGraph)	Creates an adapter for a directed big immutable graph implementing only methods based on outgoing edges.
ImmutableDirectedBigGraphAdapter(it.unimi.dsi.big.webgraph.ImmutableGraph immutableGraph, it.unimi.dsi.big.webgraph.ImmutableGraph immutableTranspose)	Creates an adapter for a directed big immutable graph.

Method Summary

Modifier and Type	Method	Description
boolean	containsEdge(it.unimi.dsi.fastutil.longs.LongLongPair e)	Returns true if this graph contains the specified edge.
ImmutableDirectedBigGraphAdapter	copy()
int	degreeOf(Long vertex)	Returns the degree of the specified vertex.
Set<it.unimi.dsi.fastutil.longs.LongLongPair>	edgeSet()	Returns a set of the edges contained in this graph.
Set<it.unimi.dsi.fastutil.longs.LongLongPair>	edgesOf(Long vertex)	Returns a set of all edges touching the specified vertex.
GraphType	getType()	Get the graph type.
Set<it.unimi.dsi.fastutil.longs.LongLongPair>	incomingEdgesOf(Long vertex)	Returns a set of all edges incoming into the specified vertex.
int	inDegreeOf(Long vertex)	Returns the "in degree" of the specified vertex.
GraphIterables<Long,it.unimi.dsi.fastutil.longs.LongLongPair>	iterables()	Access the graph using the GraphIterables interface.
protected it.unimi.dsi.fastutil.longs.LongLongPair	makeEdge(long x, long y)
int	outDegreeOf(Long vertex)	Returns the "out degree" of the specified vertex.
Set<it.unimi.dsi.fastutil.longs.LongLongPair>	outgoingEdgesOf(Long vertex)	Returns a set of all edges outgoing from the specified vertex.

Methods inherited from class org.jgrapht.webgraph.AbstractImmutableBigGraphAdapter

addEdge, addEdge, addVertex, addVertex, containsEdge, containsEdgeFast, containsVertex, getAllEdges, getEdge, getEdgeSource, getEdgeSupplier, getEdgeTarget, getEdgeWeight, getVertexSupplier, removeEdge, removeEdge, removeVertex, setEdgeWeight, vertexSet

Methods inherited from class org.jgrapht.graph.AbstractGraph

assertVertexExist, equals, hashCode, removeAllEdges, removeAllEdges, removeAllEdges, removeAllVertices, toString, toStringFromSets

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jgrapht.Graph

setEdgeWeight

Constructor Detail

ImmutableDirectedBigGraphAdapter

public ImmutableDirectedBigGraphAdapter(it.unimi.dsi.big.webgraph.ImmutableGraph immutableGraph,
                                        it.unimi.dsi.big.webgraph.ImmutableGraph immutableTranspose)

Creates an adapter for a directed big immutable graph.

It is responsibility of the caller that the two provided graphs are one the transpose of the other (for each arc x → y in a graph there must be an arc y → x in the other). If this property is not true, results will be unpredictable.

Parameters:

immutableGraph - a big immutable graph.

immutableTranspose - its transpose.

ImmutableDirectedBigGraphAdapter

public ImmutableDirectedBigGraphAdapter(it.unimi.dsi.big.webgraph.ImmutableGraph immutableGraph)

Creates an adapter for a directed big immutable graph implementing only methods based on outgoing edges.

Parameters:

immutableGraph - a big immutable graph.

Method Detail

makeEdge

protected it.unimi.dsi.fastutil.longs.LongLongPair makeEdge(long x,
                                                            long y)

Specified by:

makeEdge in class AbstractImmutableBigGraphAdapter<it.unimi.dsi.fastutil.longs.LongLongPair>

containsEdge

public boolean containsEdge(it.unimi.dsi.fastutil.longs.LongLongPair e)

Description copied from interface: Graph

Returns true if this graph contains the specified edge. More formally, returns true if and only if this graph contains an edge e2 such that e.equals(e2). If the specified edge is null returns false.

Specified by:

containsEdge in interface Graph<Long,it.unimi.dsi.fastutil.longs.LongLongPair>

Parameters:

e - edge whose presence in this graph is to be tested.

Returns:

true if this graph contains the specified edge.

edgeSet

public Set<it.unimi.dsi.fastutil.longs.LongLongPair> edgeSet()

Description copied from interface: Graph

Returns a set of the edges contained in this graph. The set is backed by the graph, so changes to the graph are reflected in the set. If the graph is modified while an iteration over the set is in progress, the results of the iteration are undefined.

The graph implementation may maintain a particular set ordering (e.g. via LinkedHashSet) for deterministic iteration, but this is not required. It is the responsibility of callers who rely on this behavior to only use graph implementations which support it.

Specified by:

edgeSet in interface Graph<Long,it.unimi.dsi.fastutil.longs.LongLongPair>

Returns:

a set of the edges contained in this graph.

degreeOf

public int degreeOf(Long vertex)

Description copied from interface: Graph

Returns the degree of the specified vertex.

A degree of a vertex in an undirected graph is the number of edges touching that vertex. Edges with same source and target vertices (self-loops) are counted twice.

In directed graphs this method returns the sum of the "in degree" and the "out degree".

Specified by:

degreeOf in interface Graph<Long,it.unimi.dsi.fastutil.longs.LongLongPair>

Parameters:

vertex - vertex whose degree is to be calculated.

Returns:

the degree of the specified vertex.

edgesOf

public Set<it.unimi.dsi.fastutil.longs.LongLongPair> edgesOf(Long vertex)

Description copied from interface: Graph

Returns a set of all edges touching the specified vertex. If no edges are touching the specified vertex returns an empty set.

Specified by:

edgesOf in interface Graph<Long,it.unimi.dsi.fastutil.longs.LongLongPair>

Parameters:

vertex - the vertex for which a set of touching edges is to be returned.

Returns:

a set of all edges touching the specified vertex.

inDegreeOf

public int inDegreeOf(Long vertex)

Description copied from interface: Graph

Returns the "in degree" of the specified vertex.

The "in degree" of a vertex in a directed graph is the number of inward directed edges from that vertex. See http://mathworld.wolfram.com/Indegree.html.

In the case of undirected graphs this method returns the number of edges touching the vertex. Edges with same source and target vertices (self-loops) are counted twice.

Specified by:

inDegreeOf in interface Graph<Long,it.unimi.dsi.fastutil.longs.LongLongPair>

Parameters:

vertex - vertex whose degree is to be calculated.

Returns:

the degree of the specified vertex.

incomingEdgesOf

public Set<it.unimi.dsi.fastutil.longs.LongLongPair> incomingEdgesOf(Long vertex)

Description copied from interface: Graph

Returns a set of all edges incoming into the specified vertex.

In the case of undirected graphs this method returns all edges touching the vertex, thus, some of the returned edges may have their source and target vertices in the opposite order.

Specified by:

incomingEdgesOf in interface Graph<Long,it.unimi.dsi.fastutil.longs.LongLongPair>

Parameters:

vertex - the vertex for which the list of incoming edges to be returned.

Returns:

a set of all edges incoming into the specified vertex.

outDegreeOf

public int outDegreeOf(Long vertex)

Description copied from interface: Graph

Returns the "out degree" of the specified vertex.

The "out degree" of a vertex in a directed graph is the number of outward directed edges from that vertex. See http://mathworld.wolfram.com/Outdegree.html.

In the case of undirected graphs this method returns the number of edges touching the vertex. Edges with same source and target vertices (self-loops) are counted twice.

Specified by:

outDegreeOf in interface Graph<Long,it.unimi.dsi.fastutil.longs.LongLongPair>

Parameters:

vertex - vertex whose degree is to be calculated.

Returns:

the degree of the specified vertex.

outgoingEdgesOf

public Set<it.unimi.dsi.fastutil.longs.LongLongPair> outgoingEdgesOf(Long vertex)

Description copied from interface: Graph

Returns a set of all edges outgoing from the specified vertex.

In the case of undirected graphs this method returns all edges touching the vertex, thus, some of the returned edges may have their source and target vertices in the opposite order.

Specified by:

outgoingEdgesOf in interface Graph<Long,it.unimi.dsi.fastutil.longs.LongLongPair>

Parameters:

vertex - the vertex for which the list of outgoing edges to be returned.

Returns:

a set of all edges outgoing from the specified vertex.

getType

public GraphType getType()

Description copied from interface: Graph

Get the graph type. The graph type can be used to query for additional metadata such as whether the graph supports directed or undirected edges, self-loops, multiple (parallel) edges, weights, etc.

Specified by:

getType in interface Graph<Long,it.unimi.dsi.fastutil.longs.LongLongPair>

Returns:

the graph type

copy

public ImmutableDirectedBigGraphAdapter copy()

Specified by:

copy in interface it.unimi.dsi.lang.FlyweightPrototype<ImmutableDirectedBigGraphAdapter>

iterables

public GraphIterables<Long,it.unimi.dsi.fastutil.longs.LongLongPair> iterables()

Description copied from interface: Graph

Access the graph using the GraphIterables interface. This allows accessing graphs without the restrictions imposed by 32-bit arithmetic. Moreover, graph implementations are free to implement this interface without explicitly materializing intermediate results.

Specified by:

iterables in interface Graph<Long,it.unimi.dsi.fastutil.longs.LongLongPair>

Returns:

the graph iterables