nca.hpp

Go to the documentation of this file.

#ifndef MLPACK_METHODS_NCA_NCA_HPP
#define MLPACK_METHODS_NCA_NCA_HPP

#include <mlpack/prereqs.hpp>
#include <mlpack/core/metrics/lmetric.hpp>
#include <mlpack/core/optimizers/sgd/sgd.hpp>

#include "nca_softmax_error_function.hpp"

namespace mlpack {
namespace nca  {

template<typename MetricType = metric::SquaredEuclideanDistance,
         template<typename> class OptimizerType = optimization::SGD>
class NCA
{
 public:
  NCA(const arma::mat& dataset,
      const arma::Row<size_t>& labels,
      MetricType metric = MetricType());

  void LearnDistance(arma::mat& outputMatrix);

  const arma::mat& Dataset() const { return dataset; }
  const arma::Row<size_t>& Labels() const { return labels; }

  const OptimizerType<SoftmaxErrorFunction<MetricType> >& Optimizer() const
  { return optimizer; }
  OptimizerType<SoftmaxErrorFunction<MetricType> >& Optimizer()
  { return optimizer; }

 private:
  const arma::mat& dataset;
  const arma::Row<size_t>& labels;

  MetricType metric;

  SoftmaxErrorFunction<MetricType> errorFunction;

  OptimizerType<SoftmaxErrorFunction<MetricType> > optimizer;
};

} // namespace nca
} // namespace mlpack

// Include the implementation.
#include "nca_impl.hpp"

#endif