de.lmu.ifi.dbs.elki.index.tree.spatial.rstarvariants.util
Class Enlargement<E extends SpatialEntry>

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.index.tree.spatial.rstarvariants.util.Enlargement<E>
Type Parameters:
E - Entry type
All Implemented Interfaces:
Comparable<Enlargement<E>>

public class Enlargement<E extends SpatialEntry>
extends Object
implements Comparable<Enlargement<E>>

Encapsulates the parameters for enlargement of nodes after insertion of new objects.


Field Summary
private  double overlapInc
          The increment of the overlap.
private  TreeIndexPathComponent<E> pathComponent
          The path information of the entry representing the node.
private  double volInc
          The increment of the volume.
private  double volume
          The volume of the node's MBR.
 
Constructor Summary
Enlargement(TreeIndexPathComponent<E> pathComponent, double volume, double volInc, double overlapInc)
          Creates an new Enlargement object with the specified parameters.
 
Method Summary
 int compareTo(Enlargement<E> other)
          Compares this Enlargement with the specified Enlargement.
 TreeIndexPathComponent<E> getPathComponent()
          Returns the path information of the entry representing the node.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

pathComponent

private TreeIndexPathComponent<E extends SpatialEntry> pathComponent
The path information of the entry representing the node.


volume

private double volume
The volume of the node's MBR.


volInc

private double volInc
The increment of the volume.


overlapInc

private double overlapInc
The increment of the overlap.

Constructor Detail

Enlargement

public Enlargement(TreeIndexPathComponent<E> pathComponent,
                   double volume,
                   double volInc,
                   double overlapInc)
Creates an new Enlargement object with the specified parameters.

Parameters:
pathComponent - the path information of the entry representing the node
volume - the volume of the node's MBR
volInc - the increment of the volume
overlapInc - the increment of the overlap
Method Detail

compareTo

public int compareTo(Enlargement<E> other)
Compares this Enlargement with the specified Enlargement. First the increment of the overlap will be compared. If both are equal the increment of the volume will be compared. If also both are equal the volumes of both nodes will be compared. If both are equal the ids of the nodes will be compared.

Specified by:
compareTo in interface Comparable<Enlargement<E extends SpatialEntry>>
Parameters:
other - the Enlargement to be compared.
Returns:
a negative integer, zero, or a positive integer as this Enlargement is less than, equal to, or greater than the specified Enlargement.

getPathComponent

public TreeIndexPathComponent<E> getPathComponent()
Returns the path information of the entry representing the node.

Returns:
the path information of the entry representing the node

Release 0.4.0 (2011-09-20_1324)