net.maizegenetics.util

Interface Graph<T>

All Known Implementing Classes:

DirectedGraph, UndirectedGraph

public Graph<T>

Created by Eli Rodgers-Melnick on 7/2/2014 This interface is implemented by graphs, both directed and undirected. The design is inspired by the Python networkx library (https://networkx.github.io/)

Method Detail

nodesIter

java.util.Iterator<T> nodesIter()

Gets an iterator over the nodes

Returns:

org.jetbrains.dokka.NodeRenderContent@1ca005f1: An iterator over the nodes

nodes

java.util.Collection<T> nodes()

Gets a list of nodes in the graph

Returns:

org.jetbrains.dokka.NodeRenderContent@2a97eb02: A list of nodes in the graph

numberOfNodes

int numberOfNodes()

Gets the number of nodes in the graph

Returns:

org.jetbrains.dokka.NodeRenderContent@3c76e75b: The number of nodes in the graph

hasNode

boolean hasNode(T n)

Returns true if the graph contains the node n

Parameters:

n - node

Returns:

org.jetbrains.dokka.NodeRenderContent@7cffd5b2: true if the graph contains the node n

hasEdge

boolean hasEdge(T u,
                T v)

Returns true if an edge exists in the graph

Parameters:

u - The first node in the edge

v - The second node in the edge

Returns:

org.jetbrains.dokka.NodeRenderContent@60ecc851:

neighbors

java.util.Collection<T> neighbors(T n)

Gets a collection of the neighbors of a node

Parameters:

n - The node for which you want the neighbors

Returns:

org.jetbrains.dokka.NodeRenderContent@75b6f0b5: The neighbors of the node

edges

java.util.Collection<java.util.Map.Entry> edges()

Gets a collection of the edges

Returns:

org.jetbrains.dokka.NodeRenderContent@7ef19d67: A collection of the edges in the graph

edgesIter

java.util.Iterator<java.util.Map.Entry> edgesIter()

Iterates over the edges

Returns:

org.jetbrains.dokka.NodeRenderContent@7ca1954e: An iterator over the edges

degree

int degree(T n)

Gets the degree of a node

Parameters:

n - A node for which you want the degree

Returns:

org.jetbrains.dokka.NodeRenderContent@7a0964cb: The degree of the node

size

int size()

Gets the number of edges in the graph

Returns:

org.jetbrains.dokka.NodeRenderContent@38781067: The number of edges in the graph

size

double size(boolean weighted)

Gets the sum of edges in the graph

Parameters:

weighted - true if weights should be used in the calculation

Returns:

org.jetbrains.dokka.NodeRenderContent@4a10b8aa: the sum of edges in the graph