org.expasy.mzjava.core.ms.cluster

Interface SimilarityGraph<V>

Type Parameters:

V - the type of vertexes in this graph

All Known Implementing Classes:

DenseSimilarityGraph, SparseSimilarityGraph

public interface SimilarityGraph<V>

Interface for a graph that represents the similarity between vertexes.

Version:

sqrt -1

Author:

Oliver Horlacher

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsVertex(V vertex) Returns true if this graph contains vertex, false otherwise.
int	degree(V vertex) Return the number of edges incident to vertex.
com.google.common.base.Optional<SimEdge<V>>	findEdge(V vertex1, V vertex2) Find the edge between vertex1 and vertex2.
void	forEachEdge(Procedure<SimEdge<V>> procedure) Applies the procedure to each edge in this graph
void	forEachEdge(V vertex, Procedure<SimEdge<V>> procedure) Applies the procedure to each edge that is connected to vertex
void	forEachNeighbour(V vertex, Procedure<V> procedure) Applies the procedure to each vertex that is a neighbour of vertex
void	forEachVertex(Procedure<V> procedure) Applies the procedure to each vertex in this graph
int	getEdgeCount() Returns the number of edges in this graph
Iterable<SimEdge<V>>	getEdges() Return an Iterable that iterates over the SimEdge's in this graph.
Iterable<SimEdge<V>>	getEdges(V vertex) Return an Iterable that iterates over all the edges connected to vertex.
Iterable<V>	getNeighbors(V vertex) Return an Iterable that iterates over the neighbours of vertex.
int	getVertexCount() Return the number of vertexes in this graph.
Iterable<V>	getVertices() Return an Iterable that iterates over the vertices in this graph.

Method Detail

getVertexCount

int getVertexCount()

Return the number of vertexes in this graph.

Returns:

the number of vertexes in this graph

getVertices

Iterable<V> getVertices()

Return an Iterable that iterates over the vertices in this graph.

Returns:

an Iterable that iterates over the vertices in this graph

forEachVertex

void forEachVertex(Procedure<V> procedure)

Applies the procedure to each vertex in this graph

Parameters:

procedure - a Procedure value

getEdges

Iterable<SimEdge<V>> getEdges()

Return an Iterable that iterates over the SimEdge's in this graph.

Returns:

an Iterable that iterates over the SimEdge's in this graph

forEachEdge

void forEachEdge(Procedure<SimEdge<V>> procedure)

Applies the procedure to each edge in this graph

Parameters:

procedure - a Procedure value

getNeighbors

Iterable<V> getNeighbors(V vertex)

Return an Iterable that iterates over the neighbours of vertex.

Parameters:

vertex - the vertex whose neighbours are to be iterated

Returns:

an Iterable that iterates over the neighbours of vertex

forEachNeighbour

void forEachNeighbour(V vertex,
                    Procedure<V> procedure)

Applies the procedure to each vertex that is a neighbour of vertex

Parameters:

vertex - the vertex whose neighbours are to have the procedure applied

procedure - a Procedure value

getEdges

Iterable<SimEdge<V>> getEdges(V vertex)

Return an Iterable that iterates over all the edges connected to vertex.

Parameters:

vertex - the vertex whose edges are to be iterated

Returns:

an Iterable that iterates over all the edges connected to vertex

forEachEdge

void forEachEdge(V vertex,
               Procedure<SimEdge<V>> procedure)

Applies the procedure to each edge that is connected to vertex

Parameters:

vertex - the vertex whose edges are to have the procedure applied

procedure - a Procedure value

findEdge

com.google.common.base.Optional<SimEdge<V>> findEdge(V vertex1,
                                                   V vertex2)

Find the edge between vertex1 and vertex2. If there is no edge between vertex1 and vertex2 an Optional that contains no SimEdge is returned.

Parameters:

vertex1 - the start vertex

vertex2 - the end vertex

Returns:

an Optional that constrains the SimEdge between vertex1 and vertex2. If no such edge exists an Optional that contains no reference is returned

degree

int degree(V vertex)

Return the number of edges incident to vertex.

Parameters:

vertex - the vertex to check

Returns:

the number of edges incident to vertex

containsVertex

boolean containsVertex(V vertex)

Returns true if this graph contains vertex, false otherwise.

Parameters:

vertex - the vertex to check

Returns:

true if this graph contains vertex, false otherwise

getEdgeCount

int getEdgeCount()

Returns the number of edges in this graph

Returns:

the number of edges in this graph