lmetric.hpp

Go to the documentation of this file.

#ifndef MLPACK_CORE_METRICS_LMETRIC_HPP
#define MLPACK_CORE_METRICS_LMETRIC_HPP

#include <mlpack/prereqs.hpp>

namespace mlpack {
namespace metric {

template<int TPower, bool TTakeRoot = true>
class LMetric
{
 public:
  /***
   * Default constructor does nothing, but is required to satisfy the Metric
   * policy.
   */
  LMetric() { }

  template<typename VecTypeA, typename VecTypeB>
  static typename VecTypeA::elem_type Evaluate(const VecTypeA& a,
                                               const VecTypeB& b);

  template<typename Archive>
  void Serialize(Archive& /* ar */, const unsigned int /* version */) { }

  static const int Power = TPower;
  static const bool TakeRoot = TTakeRoot;
};

// Convenience typedefs.

typedef LMetric<1, false> ManhattanDistance;

typedef LMetric<2, false> SquaredEuclideanDistance;

typedef LMetric<2, true> EuclideanDistance;

typedef LMetric<INT_MAX, false> ChebyshevDistance;


} // namespace metric
} // namespace mlpack

// Include implementation.
#include "lmetric_impl.hpp"

#endif