MinimumDistance Class Reference

basic data structure for distances between clusters More...

#include <OpenMS/ML/CLUSTERING/GridBasedClustering.h>

Collaboration diagram for MinimumDistance:

Public Member Functions
	MinimumDistance (const int &cluster_index, const int &nearest_neighbour_index, const double &distance)
	constructor More...
int	getClusterIndex () const
	returns cluster index More...
int	getNearestNeighbourIndex () const
	returns index of nearest cluster More...
bool	operator< (const MinimumDistance &other) const
	operators for comparisons (for multiset) More...
bool	operator> (const MinimumDistance &other) const
bool	operator== (const MinimumDistance &other) const

Private Member Functions
	MinimumDistance ()
	hide default constructor More...

Private Attributes
int	cluster_index_
	index in the cluster list More...
int	nearest_neighbour_index_
	index of the nearest neighbour of the above cluster More...
double	distance_
	distance between cluster and its nearest neighbour More...

Detailed Description

basic data structure for distances between clusters

Constructor & Destructor Documentation

MinimumDistance() [1/2]

MinimumDistance	(	const int &	cluster_index,
		const int &	nearest_neighbour_index,
		const double &	distance
	)

constructor

MinimumDistance() [2/2]

MinimumDistance ( )

private

hide default constructor

Member Function Documentation

getClusterIndex()

int getClusterIndex

(

)

const

returns cluster index

getNearestNeighbourIndex()

int getNearestNeighbourIndex

(

)

const

returns index of nearest cluster

operator<()

bool operator<

(

const MinimumDistance &

other

)

const

operators for comparisons (for multiset)

operator==()

bool operator==

(

const MinimumDistance &

other

)

const

operator>()

bool operator>

(

const MinimumDistance &

other

)

const

Member Data Documentation

cluster_index_

int cluster_index_

private

index in the cluster list

distance_

double distance_

private

distance between cluster and its nearest neighbour

nearest_neighbour_index_

int nearest_neighbour_index_

private

index of the nearest neighbour of the above cluster