package org.spaceroots.mantissa.functions.scalar;

import java.io.Serializable;

/** This class represents an (x, f(x)) pair for scalar functions.

 * 
A scalar function is a function of one scalar parameter x whose
 * value is a scalar. This class is used has a simple placeholder to
 * contain both an abscissa and the value of the function at this
 * abscissa.

 * @see SampledFunction
 * @see org.spaceroots.mantissa.functions.vectorial.VectorialValuedPair

 * @version $Id: ScalarValuedPair.java 1666 2005-12-15 16:37:55Z luc $
 * @author L. Maisonobe

 */
public class ScalarValuedPair
  implements Serializable {

  /** Simple constructor.
   * Build an instance from its coordinates
   * @param x abscissa
   * @param y ordinate (value of the function)
   */
  public ScalarValuedPair(double x, double y) {
    this.x = x;
    this.y = y;
  }

  /** Copy-constructor.
   * @param p point to copy
   */
  public ScalarValuedPair(ScalarValuedPair p) {
    x = p.x;
    y = p.y;
  }

  /**
   * Getter for the abscissa.
   * @return value of the abscissa
   */
  public double getX() {
    return x;
  }

  /**
   * Getter for the ordinate.
   * @return value of the ordinate
   */
  public double getY() {
    return y;
  }

  /**
   * Setter for the abscissa.
   * @param x new value for the abscissa
   */
  public void setX(double x) {
    this.x = x;
  }

  /**
   * Setter for the ordinate.
   * @param y new value for the ordinate
   */
  public void setY(double y) {
    this.y = y;
  }

  /** Abscissa of the point. */
  private double x;

  /** Scalar ordinate of the point, y = f (x). */
  private double y;

  private static final long serialVersionUID = 1884346552569300794L;

}