R_option.hpp
Go to the documentation of this file.
1 
12 #ifndef MLPACK_BINDINGS_R_R_OPTION_HPP
13 #define MLPACK_BINDINGS_R_R_OPTION_HPP
15 #include "get_param.hpp"
16 #include "get_printable_param.hpp"
17 #include "print_input_param.hpp"
20 #include "print_doc.hpp"
21 #include "print_serialize_util.hpp"
22 
23 namespace mlpack {
24 namespace bindings {
25 namespace r {
26 
30 template<typename T>
31 class ROption
32 {
33  public:
52  ROption(const T defaultValue,
53  const std::string& identifier,
54  const std::string& description,
55  const std::string& alias,
56  const std::string& cppName,
57  const bool required = false,
58  const bool input = true,
59  const bool noTranspose = false,
60  const std::string& bindingName = "")
61  {
62  // Create the ParamData object to give to IO.
64  data.desc = description;
65  data.name = identifier;
66  data.tname = TYPENAME(T);
67  data.alias = alias[0];
68  data.wasPassed = false;
69  data.noTranspose = noTranspose;
70  data.required = required;
71  data.input = input;
72  data.loaded = false;
73  data.cppType = cppName;
74 
75  // Every parameter we'll get from R will have the correct type.
76  data.value = ANY(defaultValue);
77 
78  // Set the function pointers that we'll need. All of these function
79  // pointers will be used by both the program that generates the R, and
80  // also the binding itself. (The binding itself will only use GetParam,
81  // GetPrintableParam, and GetRawParam.)
82  IO::AddFunction(data.tname, "GetParam", &GetParam<T>);
83  IO::AddFunction(data.tname, "GetPrintableParam", &GetPrintableParam<T>);
84 
85  // These are used by the R generator.
86  IO::AddFunction(data.tname, "PrintDoc", &PrintDoc<T>);
87  IO::AddFunction(data.tname, "PrintInputParam", &PrintInputParam<T>);
88  IO::AddFunction(data.tname, "PrintOutputProcessing",
89  &PrintOutputProcessing<T>);
90  IO::AddFunction(data.tname, "PrintInputProcessing",
91  &PrintInputProcessing<T>);
92  IO::AddFunction(data.tname, "PrintSerializeUtil", &PrintSerializeUtil<T>);
93 
94  // Add the ParamData object.
95  IO::AddParameter(bindingName, std::move(data));
96  }
97 };
98 
99 } // namespace r
100 } // namespace bindings
101 } // namespace mlpack
102 
103 #endif
ANY value
The actual value that is held.
Definition: param_data.hpp:78
Linear algebra utility functions, generally performed on matrices or vectors.
bool wasPassed
True if the option was passed to the program.
Definition: param_data.hpp:65
std::string desc
Description of this parameter, if any.
Definition: param_data.hpp:57
#define ANY
Definition: prereqs.hpp:82
bool input
True if this option is an input option (otherwise, it is output).
Definition: param_data.hpp:72
This structure holds all of the information about a single parameter, including its value (which is s...
Definition: param_data.hpp:51
bool loaded
If this is an input parameter that needs extra loading, this indicates whether or not it has been loa...
Definition: param_data.hpp:75
constexpr auto data(Container const &container) noexcept -> decltype(container.data())
Definition: iterator.hpp:79
#define TYPENAME(x)
The TYPENAME macro is used internally to convert a type into a string.
Definition: param_data.hpp:21
char alias
Alias for this parameter.
Definition: param_data.hpp:62
std::string tname
Type information of this parameter.
Definition: param_data.hpp:60
std::string name
Name of this parameter.
Definition: param_data.hpp:55
static void AddFunction(const std::string &type, const std::string &name, void(*func)(util::ParamData &, const void *, void *))
Add a function to the function map.
bool required
True if this option is required.
Definition: param_data.hpp:70
static void AddParameter(const std::string &bindingName, util::ParamData &&d)
Adds a parameter to the hierarchy; use the PARAM_*() macros instead of this (i.e. ...
std::string cppType
The true name of the type, as it would be written in C++.
Definition: param_data.hpp:80
ROption(const T defaultValue, const std::string &identifier, const std::string &description, const std::string &alias, const std::string &cppName, const bool required=false, const bool input=true, const bool noTranspose=false, const std::string &bindingName="")
Construct a ROption object.
Definition: R_option.hpp:52
auto move(Range &&rng, OutputIt &&it) -> enable_if_t< is_range< Range >::value, decay_t< OutputIt > >
Definition: algorithm.hpp:736
The R option class.
Definition: R_option.hpp:31
bool noTranspose
True if this is a matrix that should not be transposed.
Definition: param_data.hpp:68