io.github.msdk.spectra.similarity.MSDKSpectraComparisonAlgorithm Maven / Gradle / Ivy

Go to download
/*
 * (C) Copyright 2015-2017 by MSDK Development Team
 *
 * This software is dual-licensed under either
 *
 * (a) the terms of the GNU Lesser General Public License version 2.1 as published by the Free
 * Software Foundation
 *
 * or (per the licensee's choosing)
 *
 * (b) the terms of the Eclipse Public License v1.0 as published by the Eclipse Foundation.
 */

package io.github.msdk.spectra.similarity;

import javax.annotation.Nonnull;

/**
 * 
 * MSDKSpectraComparisonAlgorithm interface.
 * 
 */
public interface MSDKSpectraComparisonAlgorithm {

  /**
   * Compares two MS spectra and returns a score.
   *
   * @param mzValuesSpectrum1 an array of double.
   * @param intensityValuesSpectrum1 an array of float.
   * @param sizeSpectrum1 a {@link java.lang.Integer} object.
   * @param mzValuesSpectrum2 an array of double.
   * @param intensityValuesSpectrum2 an array of float.
   * @param sizeSpectrum2 a {@link java.lang.Integer} object.
   * @return a {@link java.lang.Double} object.
   */
  @Nonnull
  Double compareSpectra(@Nonnull double mzValuesSpectrum1[],
      @Nonnull float intensityValuesSpectrum1[], @Nonnull Integer sizeSpectrum1,
      @Nonnull double mzValuesSpectrum2[], @Nonnull float intensityValuesSpectrum2[],
      @Nonnull Integer sizeSpectrum2);

}