params.hpp

Go to the documentation of this file.

#ifndef MLPACK_CORE_UTIL_PARAMS_HPP
#define MLPACK_CORE_UTIL_PARAMS_HPP

#include "param_data.hpp"
#include "binding_details.hpp"

namespace mlpack {
namespace util {

class Params
{
 public:
  // Convenience typedef for function maps.
  typedef std::map<std::string, std::map<std::string,
      void (*)(ParamData&, const void*, void*)>> FunctionMapType;

  Params(const std::map<char, std::string>& aliases,
         const std::map<std::string, ParamData>& parameters,
         FunctionMapType& functionMap,
         const std::string& bindingName,
         const BindingDetails& doc);

  Params();

  bool Has(const std::string& identifier) const;

  template<typename T>
  T& Get(const std::string& identifier);

  template<typename T>
  std::string GetPrintable(const std::string& identifier);

  template<typename T>
  T& GetRaw(const std::string& identifier);

  // TODO: it would be really nice to remove this!  It's only used by MeanShift
  // and KMeans bindings.
  void MakeInPlaceCopy(const std::string& outputParamName,
                       const std::string& inputParamName);

  std::map<std::string, ParamData>& Parameters() { return parameters; }
  std::map<char, std::string>& Aliases() { return aliases; }

  const std::string& BindingName() const { return bindingName; }

  const BindingDetails& Doc() const { return doc; }

  void SetPassed(const std::string& identifier);

  void CheckInputMatrices();

 private:
  std::map<char, std::string> aliases;
  std::map<std::string, ParamData> parameters;

 public:
  FunctionMapType functionMap;

 private:
  std::string bindingName;

  BindingDetails doc;

  template<typename T>
  void CheckInputMatrix(const T& matrix, const std::string& identifier);
};

} // namespace util
} // namespace mlpack

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

#endif