py_option.hpp
Go to the documentation of this file.
1 
12 #ifndef MLPACK_BINDINGS_PYTHON_PY_OPTION_HPP
13 #define MLPACK_BINDINGS_PYTHON_PY_OPTION_HPP
14 
16 #include "default_param.hpp"
17 #include "get_param.hpp"
18 #include "get_printable_param.hpp"
19 #include "print_class_defn.hpp"
20 #include "print_defn.hpp"
21 #include "print_doc.hpp"
24 #include "import_decl.hpp"
25 
26 namespace mlpack {
27 namespace bindings {
28 namespace python {
29 
33 template<typename T>
34 class PyOption
35 {
36  public:
41  PyOption(const T defaultValue,
42  const std::string& identifier,
43  const std::string& description,
44  const std::string& alias,
45  const std::string& cppName,
46  const bool required = false,
47  const bool input = true,
48  const bool noTranspose = false,
49  const std::string& bindingName = "")
50  {
51  // Create the ParamData object to give to IO.
53 
54  data.desc = description;
55  data.name = identifier;
56  data.tname = TYPENAME(T);
57  data.alias = alias[0];
58  data.wasPassed = false;
59  data.noTranspose = noTranspose;
60  data.required = required;
61  data.input = input;
62  data.loaded = false;
63  data.cppType = cppName;
64 
65  // Every parameter we'll get from Python will have the correct type.
66  data.value = ANY(defaultValue);
67 
68  // Set the function pointers that we'll need. All of these function
69  // pointers will be used by both the program that generates the pyx, and
70  // also the binding itself. (The binding itself will only use GetParam,
71  // GetPrintableParam, and GetRawParam.)
72  IO::AddFunction(data.tname, "GetParam", &GetParam<T>);
73  IO::AddFunction(data.tname, "GetPrintableParam", &GetPrintableParam<T>);
74  IO::AddFunction(data.tname, "DefaultParam", &DefaultParam<T>);
75 
76  // These are used by the pyx generator.
77  IO::AddFunction(data.tname, "PrintClassDefn", &PrintClassDefn<T>);
78  IO::AddFunction(data.tname, "PrintDefn", &PrintDefn<T>);
79  IO::AddFunction(data.tname, "PrintDoc", &PrintDoc<T>);
80  IO::AddFunction(data.tname, "PrintOutputProcessing",
81  &PrintOutputProcessing<T>);
82  IO::AddFunction(data.tname, "PrintInputProcessing",
83  &PrintInputProcessing<T>);
84  IO::AddFunction(data.tname, "ImportDecl", &ImportDecl<T>);
85 
86  // Add the ParamData object to the IO class for the correct binding name.
87  IO::AddParameter(bindingName, std::move(data));
88  }
89 };
90 
91 } // namespace python
92 } // namespace bindings
93 } // namespace mlpack
94 
95 #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
PyOption(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 PyOption object.
Definition: py_option.hpp:41
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
The Python option class.
Definition: py_option.hpp:34
python
Definition: CMakeLists.txt:6
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
auto move(Range &&rng, OutputIt &&it) -> enable_if_t< is_range< Range >::value, decay_t< OutputIt > >
Definition: algorithm.hpp:736
bool noTranspose
True if this is a matrix that should not be transposed.
Definition: param_data.hpp:68