source: trunk/yat/statistics/Distance.h @ 683

#ifndef _theplu_yat_statistics_distance_
#define _theplu_yat_statistics_distance_

// $Id: Distance.h 683 2006-10-11 22:20:36Z jari $

/*
  Copyright (C) The authors contributing to this file.

  This file is part of the yat library, http://lev.thep.lu.se/trac/yat

  The yat library is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of the
  License, or (at your option) any later version.

  The yat library 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 GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/

namespace theplu{
namespace yat{

  namespace utility {
    class vector;
  }
  namespace classifier {
    class DataLookup1D;
  }

namespace statistics{

  ///
  /// Interface class for calculating distances between arrays.
  ///
  class Distance
  {
  public:

    Distance()
    {
    }

    virtual ~Distance() 
    {
    }

    ///
    /// @return distance
    ///
    virtual double operator()(const utility::vector& x, 
                              const utility::vector& y) const = 0;


    ///
    /// This function is virtual, and implemented in this base class
    /// copying the lookups to utilty::vectors followed by calling
    /// appropriate function. If speed is crucial you can implement
    /// this function in inherited class avoiding the copying.
    ///
    /// @return distance
    ///
    virtual double operator()(const classifier::DataLookup1D& x, 
                              const classifier::DataLookup1D& y) const;
        
    
    ///
    /// @return weighted distance
    ///
    virtual double operator()(const utility::vector& x, 
                              const utility::vector& y, 
                              const utility::vector& wx, 
                              const utility::vector& wy) const = 0;
    
    ///
    /// This function is virtual, and implemented in this base class
    /// copying the lookups to utilty::vectors followed by calling
    /// appropiate function. If speed is crucial you can implement
    /// this function in inherited class avoiding the copying.
    ///
    /// @return weighted distance
    ///
    virtual double operator()(const classifier::DataLookup1D& x, 
                              const classifier::DataLookup1D& y,
                              const classifier::DataLookup1D& wx,
                              const classifier::DataLookup1D& wy) const;
    
  private:
  };

}}} // of namespace statistics, yat, and theplu

#endif