distance.java

JAVA版的蚂蚁算法(Ant Colony Optimization Algorithms)

package dk.itu.nulx30.util;

/**
 * This class extends <code>BinaryHeapElement</code> but is only a wrapperclass
 * which has exchanged the priority of the <code>BinaryHeapElement</code> with
 * a distance.
 *
 * @author  Mikkel Bundgaard
 * @author  Troels C. Damgaard
 * @author  Federico Decara
 * @author  Jacob W. Winther
 */
public class Distance extends BinaryHeapElement {

  /**
   * Class constructor specifying the distance (priority) and vertex (lookup index)
   * of this object.
   *
   * @param newDistance the distance (priority) of this object.
   * @param newVertex the vertex (lookup index) of this object.
   */
  public Distance( double newDistance, int newVertex ) {
    setPriority( newDistance );
    setIndex( newVertex );
  }
  
  /**
   * This method sets the distances (priority) of this element.
   *
   * @param newDistance the new distance of this object.
   */
  public void setDistance( double newDistance ) {
    setPriority( newDistance );
  }
  
  /**
   * This method returns the result of the getPriority method.
   *
   * @return the distance (priority) of this object.
   *
   * @see# BinaryHeapElement#getPriority()
   */
  public double getDistance() {
    return getPriority();
  }
  
  /**
   * Provides a string representation of this object consisting of 
   * the priority of the object.
   *
   * @return a string representation of the object.
   */
  public String toString() {
    return Double.toString( getPriority() );
  }
}