mahalanobis_distance.hpp

Go to the documentation of this file.

/***
 * @file mahalanobis_dstance.h
 * @author Ryan Curtin
 *
 * The Mahalanobis distance.
 *
 * mlpack is free software; you may redistribute it and/or modify it under the
 * terms of the 3-clause BSD license.  You should have received a copy of the
 * 3-clause BSD license along with mlpack.  If not, see
 * http://www.opensource.org/licenses/BSD-3-Clause for more information.
 */
#ifndef MLPACK_CORE_METRICS_MAHALANOBIS_DISTANCE_HPP
#define MLPACK_CORE_METRICS_MAHALANOBIS_DISTANCE_HPP

#include <mlpack/prereqs.hpp>

namespace mlpack {
namespace metric {

template<bool TakeRoot = true>
class MahalanobisDistance
{
 public:
  MahalanobisDistance() { }

  MahalanobisDistance(const size_t dimensionality) :
      covariance(arma::eye<arma::mat>(dimensionality, dimensionality)) { }

  MahalanobisDistance(const arma::mat& covariance) : covariance(covariance) { }

  template<typename VecTypeA, typename VecTypeB>
  double Evaluate(const VecTypeA& a, const VecTypeB& b);

  const arma::mat& Covariance() const { return covariance; }

  arma::mat& Covariance() { return covariance; }

  template<typename Archive>
  void Serialize(Archive& ar, const unsigned int version);

 private:
  arma::mat covariance;
};

} // namespace distance
} // namespace mlpack

#include "mahalanobis_distance_impl.hpp"

#endif