distancefunction.h

/* 
 * Copyright (C) 2006-2013  Music Technology Group - Universitat Pompeu Fabra
 *
 * This file is part of Gaia
 * 
 * Gaia is free software: you can redistribute it and/or modify it under 
 * the terms of the GNU Affero General Public License as published by the Free 
 * Software Foundation (FSF), either version 3 of the License, or (at your 
 * option) any later version.
 * 
 * This program 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.  See the GNU General Public License for more 
 * details.
 * 
 * You should have received a copy of the Affero GNU General Public License
 * version 3 along with this program.  If not, see http://www.gnu.org/licenses/
 */

#ifndef GAIA_DISTANCEFUNCTION_H
#define GAIA_DISTANCEFUNCTION_H

#include "layoutawarefactory.h"
#include "parameter.h"
#include "point.h"

namespace gaia2 {


class DistanceFunction {
 public:

  QString name;

  DistanceFunction(const PointLayout& layout, const ParameterMap& params);
  virtual ~DistanceFunction() {}

  virtual Real operator()(const Point& p1, const Point& p2,
                          int seg1 = 0, int seg2 = 0) const = 0;

  const PointLayout& layout() const { return _layout; }

  const Region& checkFixedLength(const Region& region) const;

  QStringList validParams;

 protected:
  PointLayout _layout;
  ParameterMap _params;
  Region _region;


};


typedef LayoutAwareFactory<QString, DistanceFunction, PointLayout, ParameterMap> MetricFactory;
typedef MetricFactory DistanceFunctionFactory;

typedef QPair<int, Real> DimWeight;

void registerMetrics();


} // namespace gaia2

#endif // GAIA_DISTANCEFUNCTION_H