KeyRingMetric Class Reference

#include <Comparator.h>

List of all members.


Detailed Description

OverlayKey Ring Metric.

Public Member Functions

OverlayKey distance (const OverlayKey &x, const OverlayKey &y) const
 calculates the distance from x to y on a bidirectional ring

Member Function Documentation

OverlayKey KeyRingMetric::distance ( const OverlayKey x,
const OverlayKey y 
) const [inline]

calculates the distance from x to y on a bidirectional ring

Parameters:
x origination key
y destination key
Returns:
|y-x| on a bidirectional ring
00098     {
00099         OverlayKey dist1(x - y);
00100         OverlayKey dist2(y - x);
00101 
00102         if (dist1 > dist2)
00103             return dist2;
00104         else
00105             return dist1;
00106     }


The documentation for this class was generated from the following file:

Generated on Fri Sep 19 13:05:07 2008 for ITM OverSim by  doxygen 1.5.5