org.expasy.mzjava.core.ms.cluster

Class SparseSimilarityGraph<V>

java.lang.Object

org.expasy.mzjava.core.ms.cluster.SparseSimilarityGraph<V>

All Implemented Interfaces:

SimilarityGraph<V>

public class SparseSimilarityGraph<V>
extends Object
implements SimilarityGraph<V>

Version:

sqrt -1

Author:

Oliver Horlacher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SparseSimilarityGraph.Builder<V>

Method Summary

Methods

Modifier and Type	Method and Description
static <V> SparseSimilarityGraph.Builder<V>	builder(int edgeCapacity)
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.
Collection<V>	getNeighbors(V vertex) Return an Iterable that iterates over the neighbours of vertex.
int	getVertexCount() Return the number of vertexes in this graph.
Collection<V>	getVertices() Return an Iterable that iterates over the vertices in this graph.

Methods inherited from class java.lang.Object

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

Method Detail

getVertexCount

public int getVertexCount()

Description copied from interface: SimilarityGraph

Return the number of vertexes in this graph.

Specified by:

getVertexCount in interface SimilarityGraph<V>

Returns:

the number of vertexes in this graph

getVertices

public Collection<V> getVertices()

Description copied from interface: SimilarityGraph

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

Specified by:

getVertices in interface SimilarityGraph<V>

Returns:

an Iterable that iterates over the vertices in this graph

forEachVertex

public void forEachVertex(Procedure<V> procedure)

Description copied from interface: SimilarityGraph

Applies the procedure to each vertex in this graph

Specified by:

forEachVertex in interface SimilarityGraph<V>

Parameters:

procedure - a Procedure value

getEdges

public Iterable<SimEdge<V>> getEdges()

Description copied from interface: SimilarityGraph

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

Specified by:

getEdges in interface SimilarityGraph<V>

Returns:

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

forEachEdge

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

Description copied from interface: SimilarityGraph

Applies the procedure to each edge in this graph

Specified by:

forEachEdge in interface SimilarityGraph<V>

Parameters:

procedure - a Procedure value

getNeighbors

public Collection<V> getNeighbors(V vertex)

Description copied from interface: SimilarityGraph

Return an Iterable that iterates over the neighbours of vertex.

Specified by:

getNeighbors in interface SimilarityGraph<V>

Parameters:

vertex - the vertex whose neighbours are to be iterated

Returns:

an Iterable that iterates over the neighbours of vertex

forEachNeighbour

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

Description copied from interface: SimilarityGraph

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

Specified by:

forEachNeighbour in interface SimilarityGraph<V>

Parameters:

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

procedure - a Procedure value

getEdges

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

Description copied from interface: SimilarityGraph

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

Specified by:

getEdges in interface SimilarityGraph<V>

Parameters:

vertex - the vertex whose edges are to be iterated

Returns:

an Iterable that iterates over all the edges connected to vertex

forEachEdge

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

Description copied from interface: SimilarityGraph

Applies the procedure to each edge that is connected to vertex

Specified by:

forEachEdge in interface SimilarityGraph<V>

Parameters:

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

procedure - a Procedure value

findEdge

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

Description copied from interface: SimilarityGraph

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

Specified by:

findEdge in interface SimilarityGraph<V>

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

public int degree(V vertex)

Description copied from interface: SimilarityGraph

Return the number of edges incident to vertex.

Specified by:

degree in interface SimilarityGraph<V>

Parameters:

vertex - the vertex to check

Returns:

the number of edges incident to vertex

containsVertex

public boolean containsVertex(V vertex)

Description copied from interface: SimilarityGraph

Returns true if this graph contains vertex, false otherwise.

Specified by:

containsVertex in interface SimilarityGraph<V>

Parameters:

vertex - the vertex to check

Returns:

true if this graph contains vertex, false otherwise

getEdgeCount

public int getEdgeCount()

Description copied from interface: SimilarityGraph

Returns the number of edges in this graph

Specified by:

getEdgeCount in interface SimilarityGraph<V>

Returns:

the number of edges in this graph

builder

public static <V> SparseSimilarityGraph.Builder<V> builder(int edgeCapacity)