ra_model.hpp

Go to the documentation of this file.

#ifndef MLPACK_METHODS_RANN_RA_MODEL_HPP
#define MLPACK_METHODS_RANN_RA_MODEL_HPP

#include <mlpack/core/tree/binary_space_tree.hpp>
#include <mlpack/core/tree/cover_tree.hpp>
#include <mlpack/core/tree/rectangle_tree.hpp>
#include <mlpack/core/tree/octree.hpp>

#include "ra_search.hpp"

namespace mlpack {
namespace neighbor {

template<typename SortPolicy>
class RAModel
{
 public:
  enum TreeTypes
  {
    KD_TREE,
    COVER_TREE,
    R_TREE,
    R_STAR_TREE,
    X_TREE,
    HILBERT_R_TREE,
    R_PLUS_TREE,
    R_PLUS_PLUS_TREE,
    UB_TREE,
    OCTREE
  };

 private:
  TreeTypes treeType;
  size_t leafSize;

  bool randomBasis;
  arma::mat q;

  template<template<typename TreeMetricType,
                    typename TreeStatType,
                    typename TreeMatType> class TreeType>
  using RAType = RASearch<SortPolicy,
                          metric::EuclideanDistance,
                          arma::mat,
                          TreeType>;

  RAType<tree::KDTree>* kdTreeRA;
  RAType<tree::StandardCoverTree>* coverTreeRA;
  RAType<tree::RTree>* rTreeRA;
  RAType<tree::RStarTree>* rStarTreeRA;
  RAType<tree::XTree>* xTreeRA;
  RAType<tree::HilbertRTree>* hilbertRTreeRA;
  RAType<tree::RPlusTree>* rPlusTreeRA;
  RAType<tree::RPlusPlusTree>* rPlusPlusTreeRA;
  RAType<tree::UBTree>* ubTreeRA;
  RAType<tree::Octree>* octreeRA;

 public:
  RAModel(TreeTypes treeType = TreeTypes::KD_TREE, bool randomBasis = false);

  RAModel(const RAModel& other);

  RAModel(RAModel&& other);

  RAModel& operator=(const RAModel& other);

  RAModel& operator=(RAModel&& other);

  ~RAModel();

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

  const arma::mat& Dataset() const;

  bool SingleMode() const;
  bool& SingleMode();

  bool Naive() const;
  bool& Naive();

  double Tau() const;
  double& Tau();

  double Alpha() const;
  double& Alpha();

  bool SampleAtLeaves() const;
  bool& SampleAtLeaves();

  bool FirstLeafExact() const;
  bool& FirstLeafExact();

  size_t SingleSampleLimit() const;
  size_t& SingleSampleLimit();

  size_t LeafSize() const;
  size_t& LeafSize();

  TreeTypes TreeType() const;
  TreeTypes& TreeType();

  bool RandomBasis() const;
  bool& RandomBasis();

  void BuildModel(arma::mat&& referenceSet,
                  const size_t leafSize,
                  const bool naive,
                  const bool singleMode);

  void Search(arma::mat&& querySet,
              const size_t k,
              arma::Mat<size_t>& neighbors,
              arma::mat& distances);

  void Search(const size_t k,
              arma::Mat<size_t>& neighbors,
              arma::mat& distances);

  std::string TreeName() const;
};

} // namespace neighbor
} // namespace mlpack

#include "ra_model_impl.hpp"

#endif