MTreeSearchCandidate (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

java.lang.Object
- elki.index.tree.metrical.mtreevariants.query.MTreeSearchCandidate

All Implemented Interfaces:

java.lang.Comparable<MTreeSearchCandidate>
```
public class MTreeSearchCandidate
extends java.lang.Object
implements java.lang.Comparable<MTreeSearchCandidate>
```
Encapsulates the attributes for a object that can be stored in a heap. The object to be stored represents a node in a M-Tree and some additional information. Additionally to the regular expansion candidate, this object holds the id of the routing object of the underlying M-Tree node and its covering radius.

Since:

0.5.5

Author:

Elke Achtert

Field Summary

Fields
Modifier and Type	Field	Description
`double`	`mindist`	Distance value
`int`	`nodeID`	Page id
`double`	`routingDistance`	The distance from the query object to the routing object
`DBID`	`routingObjectID`	The id of the routing object.

Constructor Summary

Constructors
Constructor	Description
`MTreeSearchCandidate(double mindist, int nodeID, DBID routingObjectID, double routingDistance)`	Creates a new heap node with the specified parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(MTreeSearchCandidate o)`
`boolean`	`equals(java.lang.Object obj)`
`int`	`hashCode()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - mindist
```
public double mindist
```
    Distance value
  - nodeID
```
public int nodeID
```
    Page id
  - routingObjectID
```
public DBID routingObjectID
```
    The id of the routing object.
  - routingDistance
```
public double routingDistance
```
    The distance from the query object to the routing object
- Constructor Detail
  - MTreeSearchCandidate
```
public MTreeSearchCandidate(double mindist,
                            int nodeID,
                            DBID routingObjectID,
                            double routingDistance)
```
    Creates a new heap node with the specified parameters.
    
    Parameters:
    
    mindist - the minimum distance of the node
    
    nodeID - the id of the node
    
    routingObjectID - the id of the routing object of the node
    
    routingDistance - the distance from the query object to the query object
- Method Detail
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - compareTo
```
public int compareTo(MTreeSearchCandidate o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<MTreeSearchCandidate>