net.maizegenetics.util

Class UndirectedGraph<T>

java.lang.Object

net.maizegenetics.util.UndirectedGraph<T>

All Implemented Interfaces:

Graph<T>

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

Class used to represent an undirected 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
UndirectedGraph(HashSet<T> nodes, com.google.common.collect.ImmutableSetMultimap<T,T> adj, HashMap<Tuple<T,T>,Double> wts) Constructs an undirected graph

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
Collection<T>	neighbors(T n) Gets a collection of the neighbors of a node
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	size() Gets the number of edges in the graph
double	size(boolean weighted) Gets the sum of edges in the graph

Methods inherited from class java.lang.Object

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

Constructor Detail

UndirectedGraph

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

Constructs an undirected graph

Parameters:

nodes - Set of nodes

adj - Multimap of adjacency between nodes

wts - Hashmap of an edge (represented by a Map Entry) and weights

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)

Description copied from interface: Graph

Gets a collection of the neighbors of a node

Specified by:

neighbors in interface Graph<T>

Parameters:

n - The node for which you want the neighbors

Returns:

The neighbors of the node

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

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