org.jcamp.spectrum.IOrderedDataArray1D Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jcamp-dx Show documentation

The JCAMP-DX project is the reference implemention of the IUPAC JCAMP-DX spectroscopy data standard.

The newest version!

package org.jcamp.spectrum;

import java.io.Serializable;

import org.jcamp.math.DataException;
import org.jcamp.math.IOrderedArray1D;
import org.jcamp.math.Range1D;
import org.jcamp.units.IMeasurable;

/**
 * 1D ordered data arrays extended by unit and label.
 * 
 * @author Thomas Weber
 */
public interface IOrderedDataArray1D
  extends IOrderedArray1D, IMeasurable, Cloneable, Serializable {
  
  /**
   * gets data point indices around position
   * @param double position to search
   * @return int[] array of {floorIndex, ceilIndex}
   * @exception DataException thrown if position out of data range
   */
  int[] boundIndices(double position) throws org.jcamp.math.DataException;

  /**
   * gets data point values around position
   * @param double position to search
   * @return Range1D.Double
   * @exception DataException thrown if position out of data range
   */
  Range1D.Double bounds(double position) throws org.jcamp.math.DataException;

  /**
   * gets next data point greater than position
   * @param double position to search
   * @return double
   * @exception DataException thrown if position out of data range
   */
  double ceil(double position) throws org.jcamp.math.DataException;

  /**
   * gets next data point index greater than position
   * @param double position to search
   * @return double
   * @exception DataException thrown if position out of data range
   */
  int ceilIndex(double position) throws org.jcamp.math.DataException;

  public Object clone();

  /**
   * gets next data point lesser than position
   * @param double position to search
   * @return double
   * @exception DataException thrown if position out of data range
   */
  double floor(double position) throws org.jcamp.math.DataException;

  /**
   * gets next data point index lesser than position
   * @param double position to search
   * @return double
   * @exception DataException thrown if position out of data range
   */
  int floorIndex(double position) throws org.jcamp.math.DataException;

  /**
   * get data label.
   * 
   * @return java.lang.String
   */
  String getLabel();

  /**
   * indicates ascending data points.
   * 
   * @return boolean
   */
  boolean isAscending();

  /**
   * sets data label
   * 
   * @param label java.lang.String
   */
  void setLabel(String label);
}