edu.stanford.nlp.math.DoubleAD Maven / Gradle / Ivy

package edu.stanford.nlp.math;

/**
 * The class DoubleAD was created to extend the
 * current calculations of gradient to automatically include a calculation of the
 * hessian vector product with another vector v.  This is used with the
 * Stochastic Meta Descent Optimization, but could be extended for use in any application
 * that requires a additional order of differentiation without explicitly creating the code.
 *
 * @author Alex Kleeman
 * @version 2006/12/06
 */

public class DoubleAD extends Number {
  /**
   * 
   */
  private static final long serialVersionUID = -5702334375099248894L;
  private double val;
  private double dot;


  public DoubleAD(){
    setval(0);
    setdot(1);
  }

  public DoubleAD(double initVal, double initDot){
    val = initVal;
    dot = initDot;
  }

  public boolean equals(DoubleAD b){
    if(b.getval() == val && b.getdot() == dot){
      return true;
    } else return false;
  }
  
  public boolean equals(double valToCompare,double dotToCompare){
    if(valToCompare == val && dotToCompare == dot){
      return true;
    }else return false;
  }

  public boolean equals(double valToCompare,double dotToCompare,double TOL){
    if( Math.abs(valToCompare - val) < TOL && Math.abs(dotToCompare - dot) < TOL){
      return true;
    }else return false;
  }

  public double getval(){
    return val;
  }

  public double getdot(){
    return dot;
  }

  public void set(double value, double dotValue){
    val = value;
    dot = dotValue;
  }

  public void setval(double a){
    val = a;
  }

  public void setdot(double a){
    dot = a;
  }

  public void plusEqualsConst(double a){
    setval(val + a);
  }



  public void plusEquals(DoubleAD a){
    setval(val + a.getval() );
    setdot(dot + a.getdot() );
  }

  public void minusEquals(DoubleAD a){
    setval(val - a.getval() );
    setdot(dot - a.getdot() );
  }

  public void minusEqualsConst(double a){
    setval(val - a);
  }


  @Override
  public double doubleValue() {
    return getval();
  }

  @Override
  public float floatValue() {
    return (float) doubleValue();
  }

  @Override
  public int intValue() {
    return (int) doubleValue();
  }

  @Override
  public long longValue() {
    return (long) doubleValue();
  }

  @Override
  public String toString() {
      return "Value= " + val + "; Dot= " + dot;
  }

}