com.chemaxon.overlap.result

Interface NnResults

All Superinterfaces:

Serializable

All Known Subinterfaces:

KnnResults

All Known Implementing Classes:

FixedKnnResultsImpl, IndexedKnnResultsImpl

public interface NnResults
extends Serializable

Nearest neighbor (most similars) search result. Queries are indexed from 0 to getQueryCount()-1. For every query a nearest neighbor index (getMostSimilarNeighbor(int)) with a dissimilarity value (getMostSimilarDissimilarity(int)) is stored. Interpretation of the query and target indices is implementation dependent. Note that some search implementation might accept dissimilarity threshold values which might result in no hits for certain queries. Such queries are not represented by an instance of this interface and the index mapping must be provided outside. For implementations representing self overlap additionally might ignore self reference as the nearest neighbor.

Method Summary

Modifier and Type	Method and Description
double	getMaxDissimilarity() Upper bound of dissimilarity values.
int	getMaxNeighborIndex() Upper bound of neighbor index values.
double	getMinDissimilarity() Lower bound of dissimilarity values.
int	getMinNeighborIndex() Lower bound of neighbor index values.
double	getMostSimilarDissimilarity(int queryIndex) Dissimilarity of the most similar neighbor.
int	getMostSimilarNeighbor(int queryIndex) Index of most similar neighbor.
int	getQueryCount() Number of queries stored.

Method Detail

getMaxDissimilarity

double getMaxDissimilarity()

Upper bound of dissimilarity values.

Returns:

Upper bound of dissimilarity values (possibly inclusive but might be broader)

getMaxNeighborIndex

int getMaxNeighborIndex()

Upper bound of neighbor index values.

Returns:

Upper bound neighbor index (possibly inclusive but might be broader)

getMinDissimilarity

double getMinDissimilarity()

Lower bound of dissimilarity values.

Returns:

Lower bound of dissimilarity values (possibly inclusive but might be broader)

getMinNeighborIndex

int getMinNeighborIndex()

Lower bound of neighbor index values.

Returns:

Lower bound of neighbor index (possibly inclusive but might be broader)

getMostSimilarDissimilarity

double getMostSimilarDissimilarity(int queryIndex)

Dissimilarity of the most similar neighbor. Note that when a search implementation consider dissimilarity thresholds the returned dissimilarity refers to the most similar target which conforms those thresholds.

Parameters:

queryIndex - Index of query

Returns:

Dissimilarity of the most similar neighbor conforming the thresholds

getMostSimilarNeighbor

int getMostSimilarNeighbor(int queryIndex)

Index of most similar neighbor. Note that when a search implementation consider dissimilarity thresholds the returned neighbor index refers to the most similar target which conforms those thresholds.

Parameters:

queryIndex - Index of query

Returns:

Index of most similar neighbor conforming the thresholds

getQueryCount

int getQueryCount()

Number of queries stored.

Returns:

Number of queries stored