go_option.hpp
Go to the documentation of this file.
1 
12 #ifndef MLPACK_BINDINGS_GOLANG_GO_OPTION_HPP
13 #define MLPACK_BINDINGS_GOLANG_GO_OPTION_HPP
14 
16 #include "get_param.hpp"
17 #include "get_type.hpp"
18 #include "default_param.hpp"
19 #include "get_printable_param.hpp"
20 #include "print_defn_input.hpp"
21 #include "print_defn_output.hpp"
22 #include "print_doc.hpp"
24 #include "print_method_config.hpp"
25 #include "print_method_init.hpp"
27 
28 namespace mlpack {
29 namespace bindings {
30 namespace go {
31 
32 // Defined in mlpack_main.hpp.
33 extern std::string programName;
34 
38 template<typename T>
39 class GoOption
40 {
41  public:
60  GoOption(const T defaultValue,
61  const std::string& identifier,
62  const std::string& description,
63  const std::string& alias,
64  const std::string& cppName,
65  const bool required = false,
66  const bool input = true,
67  const bool noTranspose = false,
68  const std::string& /*testName*/ = "")
69  {
70  // Create the ParamData object to give to IO.
71  util::ParamData data;
72 
73  data.desc = description;
74  data.name = identifier;
75  data.tname = TYPENAME(T);
76  data.alias = alias[0];
77  data.wasPassed = false;
78  data.noTranspose = noTranspose;
79  data.required = required;
80  data.input = input;
81  data.loaded = false;
82  // Only "verbose" and "copy_all_inputs" will be persistent.
83  if (identifier == "verbose" /*|| identifier == "copy_all_inputs"*/)
84  data.persistent = true;
85  else
86  data.persistent = false;
87  data.cppType = cppName;
88 
89  data.value = boost::any(defaultValue);
90 
91  // Restore the parameters for this program.
92  if (identifier != "verbose" /*&& identifier != "copy_all_inputs"*/)
93  IO::RestoreSettings(programName, false);
94 
95  // Set the function pointers that we'll need. All of these function
96  // pointers will be used by both the program that generates the .cpp,
97  // the .h, and the .go binding files.
98  IO::GetSingleton().functionMap[data.tname]["GetParam"] = &GetParam<T>;
99  IO::GetSingleton().functionMap[data.tname]["GetPrintableParam"] =
100  &GetPrintableParam<T>;
101 
102  IO::GetSingleton().functionMap[data.tname]["DefaultParam"] =
103  &DefaultParam<T>;
104  IO::GetSingleton().functionMap[data.tname]["PrintDefnInput"] =
105  &PrintDefnInput<T>;
106  IO::GetSingleton().functionMap[data.tname]["PrintDefnOutput"] =
107  &PrintDefnOutput<T>;
108  IO::GetSingleton().functionMap[data.tname]["PrintDoc"] = &PrintDoc<T>;
109  IO::GetSingleton().functionMap[data.tname]["PrintOutputProcessing"] =
110  &PrintOutputProcessing<T>;
111  IO::GetSingleton().functionMap[data.tname]["PrintMethodConfig"] =
112  &PrintMethodConfig<T>;
113  IO::GetSingleton().functionMap[data.tname]["PrintMethodInit"] =
114  &PrintMethodInit<T>;
115  IO::GetSingleton().functionMap[data.tname]["PrintInputProcessing"] =
116  &PrintInputProcessing<T>;
117  IO::GetSingleton().functionMap[data.tname]["GetType"] = &GetType<T>;
118 
119  // Add the ParamData object, then store. This is necessary because we may
120  // import more than one .so that uses IO, so we have to keep the options
121  // separate. programName is a global variable from mlpack_main.hpp.
122  IO::Add(std::move(data));
123  if (identifier != "verbose" /*&& identifier != "copy_all_inputs"*/)
124  IO::StoreSettings(programName);
126  }
127 };
128 
129 } // namespace go
130 } // namespace bindings
131 } // namespace mlpack
132 
133 #endif
boost::any value
The actual value that is held.
Definition: param_data.hpp:82
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:66
bool persistent
If this should be preserved across different settings (i.e.
Definition: param_data.hpp:79
static void StoreSettings(const std::string &name)
Take all parameters and function mappings and store them, under the given name.
GoOption(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 &="")
Construct a GoOption object.
Definition: go_option.hpp:60
The Go option class.
Definition: go_option.hpp:39
static void Add(util::ParamData &&d)
Adds a parameter to the hierarchy; use the PARAM_*() macros instead of this (i.e. ...
go
Definition: CMakeLists.txt:6
std::string desc
Description of this parameter, if any.
Definition: param_data.hpp:58
static void RestoreSettings(const std::string &name, const bool fatal=true)
Restore all of the parameters and function mappings of the given name, if they exist.
bool input
True if this option is an input option (otherwise, it is output).
Definition: param_data.hpp:73
std::string programName
This structure holds all of the information about a single parameter, including its value (which is s...
Definition: param_data.hpp:52
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:76
#define TYPENAME(x)
The TYPENAME macro is used internally to convert a type into a string.
Definition: param_data.hpp:22
static IO & GetSingleton()
Retrieve the singleton.
char alias
Alias for this parameter.
Definition: param_data.hpp:63
std::string tname
Type information of this parameter.
Definition: param_data.hpp:61
static void ClearSettings()
Clear all of the settings, removing all parameters and function mappings.
std::string name
Name of this parameter.
Definition: param_data.hpp:56
bool required
True if this option is required.
Definition: param_data.hpp:71
FunctionMapType functionMap
Definition: io.hpp:299
std::string cppType
The true name of the type, as it would be written in C++.
Definition: param_data.hpp:84
bool noTranspose
True if this is a matrix that should not be transposed.
Definition: param_data.hpp:69