maltcms.commands.distances.dtwng.TwoFeatureVectorOperation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maltcms-commands Show documentation

Similarities for Feature Vectors and Time Series thereof, such as Cosine and Dynamic Time Warping.

The newest version!

/* 
 * Maltcms, modular application toolkit for chromatography-mass spectrometry. 
 * Copyright (C) 2008-2014, The authors of Maltcms. All rights reserved.
 *
 * Project website: http://maltcms.sf.net
 *
 * Maltcms may be used under the terms of either the
 *
 * GNU Lesser General Public License (LGPL)
 * http://www.gnu.org/licenses/lgpl.html
 *
 * or the
 *
 * Eclipse Public License (EPL)
 * http://www.eclipse.org/org/documents/epl-v10.php
 *
 * As a user/recipient of Maltcms, you may choose which license to receive the code 
 * under. Certain files or entire directories may not be covered by this 
 * dual license, but are subject to licenses compatible to both LGPL and EPL.
 * License exceptions are explicitly declared in all relevant files or in a 
 * LICENSE file in the relevant directories.
 *
 * Maltcms is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. Please consult the relevant license documentation
 * for details.
 */
package maltcms.commands.distances.dtwng;

import cross.IConfigurable;
import maltcms.datastructures.array.IFeatureVector;
import org.apache.commons.configuration.Configuration;

/**
 * Abstract TwoFeatureVectorOperation class.
 *
 * @author Nils Hoffmann
 * 
 */
public abstract class TwoFeatureVectorOperation implements IConfigurable {

    /**
     * apply.
     *
     * @param f1 a {@link maltcms.datastructures.array.IFeatureVector} object.
     * @param f2 a {@link maltcms.datastructures.array.IFeatureVector} object.
     * @return a double.
     */
    public abstract double apply(IFeatureVector f1, IFeatureVector f2);

    /**
     * isMinimize.
     *
     * @return a boolean.
     */
    public abstract boolean isMinimize();

    /** {@inheritDoc} */
    @Override
    public void configure(Configuration cfg) {
    }
}