nct.graph
Interface DistanceGraph<NodeType extends java.lang.Comparable<? super NodeType>,WeightType extends java.lang.Comparable<? super WeightType>>

All Superinterfaces:

java.lang.Cloneable, java.lang.Comparable<Graph<NodeType,WeightType>>, Graph<NodeType,WeightType>

All Known Subinterfaces:

SequenceGraph<NodeType,WeightType>

All Known Implementing Classes:

BasicDistanceGraph, BlastGraph, FastaGraph, InteractionGraph

public interface DistanceGraph<NodeType extends java.lang.Comparable<? super NodeType>,WeightType extends java.lang.Comparable<? super WeightType>>
extends Graph<NodeType,WeightType>

This interface describes a method that returns the distance between two nodes. What constitutes the distance is left to the implementer.

Method Summary

byte	getDistance(NodeType nodeA, NodeType nodeB) Returns the minimum distance between the specified nodes.

Methods inherited from interface nct.graph.Graph

addEdge, addEdge, addNode, clone, compareTo, degreeOfNode, getEdge, getEdgeDescription, getEdgeList, getEdges, getEdgeWeight, getId, getNeighbors, getNodes, getScore, isEdge, isNode, numberOfEdges, numberOfNodes, removeEdge, removeNode, setEdgeDescription, setEdgeWeight, setScore, toString

Method Detail

getDistance

byte getDistance(NodeType nodeA,
                 NodeType nodeB)

Returns the minimum distance between the specified nodes.

Parameters:

nodeA - From node.

nodeB - To node.

Returns:

The distance between the nodes specified.