net.maizegenetics.util

Class DirectedGraph<T>

java.lang.Object

net.maizegenetics.util.DirectedGraph<T>

All Implemented Interfaces:

Graph<T>

public class DirectedGraph<T>
extends Object
implements Graph<T>

Class used to represent a directed graph The design is inspired by the Python networkx library (https://networkx.github.io/)

Author:

Eli Rodgers-Melnick

Nested Class Summary

Nested classes/interfaces inherited from interface net.maizegenetics.util.Graph

Graph.GraphType

Constructor Summary

Constructors

Constructor and Description
DirectedGraph(HashSet<T> nodes, com.google.common.collect.ImmutableSetMultimap<T,T> adj, com.google.common.collect.ImmutableSetMultimap<T,T> pred, HashMap<Tuple<T,T>,Double> wts)

Method Summary

Modifier and Type	Method and Description
int	degree(T n) Gets the degree of a node
Collection<Map.Entry<T,T>>	edges() Gets a collection of the edges
Iterator<Map.Entry<T,T>>	edgesIter() Iterates over the edges
boolean	hasEdge(T u, T v) Returns true if an edge exists in the graph
boolean	hasNode(T n) Returns true if the graph contains the node n
int	inDegree(T n) Gets the number of nodes with an edge coming into the query node
Collection<T>	neighbors(T n) Gets the successors of the node n
Collection<T>	nodes() Gets a list of nodes in the graph
Iterator<T>	nodesIter() Gets an iterator over the nodes
int	numberOfNodes() Gets the number of nodes in the graph
int	outDegree(T n) Gets the number of nodes hit by an edge coming out of the query node
Collection<T>	predecessors(T n) Gets the predecessors of the node n
int	size() Gets the number of edges in the graph
double	size(boolean weighted) Gets the sum of edges in the graph
Collection<T>	successors(T n) Gets the successors of the node n

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectedGraph

public DirectedGraph(HashSet<T> nodes,
                     com.google.common.collect.ImmutableSetMultimap<T,T> adj,
                     com.google.common.collect.ImmutableSetMultimap<T,T> pred,
                     HashMap<Tuple<T,T>,Double> wts)

Method Detail

nodesIter

public Iterator<T> nodesIter()

Description copied from interface: Graph

Gets an iterator over the nodes

Specified by:

nodesIter in interface Graph<T>

Returns:

An iterator over the nodes

nodes

public Collection<T> nodes()

Description copied from interface: Graph

Gets a list of nodes in the graph

Specified by:

nodes in interface Graph<T>

Returns:

A list of nodes in the graph

numberOfNodes

public int numberOfNodes()

Description copied from interface: Graph

Gets the number of nodes in the graph

Specified by:

numberOfNodes in interface Graph<T>

Returns:

The number of nodes in the graph

hasNode

public boolean hasNode(T n)

Description copied from interface: Graph

Returns true if the graph contains the node n

Specified by:

hasNode in interface Graph<T>

Parameters:

n - node

Returns:

true if the graph contains the node n

hasEdge

public boolean hasEdge(T u,
                       T v)

Description copied from interface: Graph

Returns true if an edge exists in the graph

Specified by:

hasEdge in interface Graph<T>

Parameters:

u - The first node in the edge

v - The second node in the edge

Returns:

neighbors

public Collection<T> neighbors(T n)

Gets the successors of the node n

Specified by:

neighbors in interface Graph<T>

Parameters:

n - A node

Returns:

The collection of successors of the node (i.e. b in a->b)

successors

public Collection<T> successors(T n)

Gets the successors of the node n

Parameters:

n - A node

Returns:

The collection of successors of the node (i.e. b in a->b)

predecessors

public Collection<T> predecessors(T n)

Gets the predecessors of the node n

Parameters:

n - A node

Returns:

The collection of predecessors of the node (i.e. a in a->b)

edges

public Collection<Map.Entry<T,T>> edges()

Description copied from interface: Graph

Gets a collection of the edges

Specified by:

edges in interface Graph<T>

Returns:

A collection of the edges in the graph

edgesIter

public Iterator<Map.Entry<T,T>> edgesIter()

Description copied from interface: Graph

Iterates over the edges

Specified by:

edgesIter in interface Graph<T>

Returns:

An iterator over the edges

degree

public int degree(T n)

Description copied from interface: Graph

Gets the degree of a node

Specified by:

degree in interface Graph<T>

Parameters:

n - A node for which you want the degree

Returns:

The degree of the node

inDegree

public int inDegree(T n)

Gets the number of nodes with an edge coming into the query node

Parameters:

n - The query node

Returns:

The number of nodes with an edge coming into the query node

outDegree

public int outDegree(T n)

Gets the number of nodes hit by an edge coming out of the query node

Parameters:

n - The query node

Returns:

The number of nodes hit by an edge coming out of the query node

size

public int size()

Description copied from interface: Graph

Gets the number of edges in the graph

Specified by:

size in interface Graph<T>

Returns:

The number of edges in the graph

size

public double size(boolean weighted)

Description copied from interface: Graph

Gets the sum of edges in the graph

Specified by:

size in interface Graph<T>

Parameters:

weighted - true if weights should be used in the calculation

Returns:

the sum of edges in the graph