Page History

/**
 * Basic vector interface.
 */
public interface VectorInterface {
  
  /**
   * @return size of the vector
   */
  public int size();

  /**
   * @param index
   * @return v(index)
   */
  public double get(int index); 
  
  /**
   * v(index) = value
   *  
   * @param index
   * @param value
   */
  public void set(int index, double value);
  
  /**
   * @param v
   * @return x = v 
   */
  public Vector set(Vector v);

  /**
   * v(index) += value
   *  
   * @param index
   * @param value
   */
  public void add(int index, double value);
  
  /**
   * @param alpha
   * @param v
   * @return  x = alpha*v + x
   */
  public booleanVector add(double alpha, Vector v);

  /**
   * @param v
   * @return x = v + x
   */
  public Vector add(Vector v);
  
  /**
   * @param v
   * @return x dot v
   */
  public double dot(Vector v);

  /**
   * Computes the given norm of the vector
   * 
   * @param type
   * @return norm of the vector
   */
  public double norm(Norm type);

  /**
   * Supported vector-norms.
   */
  enum Norm {

    /** Sum of the absolute values of the entries */
    One,

    /** The root of sum of squares */
    Two,

    /**
     * As the 2 norm may overflow, an overflow resistant version is also
     * available. Note that it may be slower.
     */
    TwoRobust,

    /** Largest entry in absolute value */
    Infinity
  }
}