org.expasy.mzjava.core.ms.cluster

Interface SimilarityGraphBuilder<V,G extends SimilarityGraph<V>>

All Known Implementing Classes:

DenseSimilarityGraph.AbstractBuilder, DenseSimilarityGraph.Builder, SparseSimilarityGraph.Builder

public interface SimilarityGraphBuilder<V,G extends SimilarityGraph<V>>

Common interface for similarity graph builders.

Version:

sqrt -1

Author:

Oliver Horlacher

Method Summary

Methods

Modifier and Type	Method and Description
SimilarityGraphBuilder<V,G>	add(SimEdge<V> simEdge) Add the simEdge to the graph.
SimilarityGraphBuilder<V,G>	add(V vertex) Add the vertex to the graph
SimEdge<V>	add(V vertex1, V vertex2, double score) Create and add an edge from vertex1 to vertex2 with similarity equal to score to the graph.
G	build()
int	edgeCount() Return the number of edges currently in the graph
boolean	isReusable() Returns true if build can be called more than once, false otherwise.

Method Detail

add

SimilarityGraphBuilder<V,G> add(V vertex)

Add the vertex to the graph

Parameters:

vertex - the vertex to add

Returns:

this builder

add

SimEdge<V> add(V vertex1,
             V vertex2,
             double score)

Create and add an edge from vertex1 to vertex2 with similarity equal to score to the graph.

If a vertex is not present in the graph the vertex is added to the graph.

Parameters:

vertex1 - the parent vertex

vertex2 - the child vertex

score - the similarity of the edge

Returns:

the created edge

edgeCount

int edgeCount()

Return the number of edges currently in the graph

Returns:

the number of edges currently in the graph

add

SimilarityGraphBuilder<V,G> add(SimEdge<V> simEdge)

Add the simEdge to the graph.

Parameters:

simEdge - the edge to add

Returns:

this builder

build

G build()

isReusable

boolean isReusable()

Returns true if build can be called more than once, false otherwise.

Returns:

true if build can be called more than once, false otherwise