print_doc_functions.hpp
Go to the documentation of this file.
1 
14 #ifndef MLPACK_BINDINGS_CLI_PRINT_DOC_FUNCTIONS_HPP
15 #define MLPACK_BINDINGS_CLI_PRINT_DOC_FUNCTIONS_HPP
16 
18 
19 namespace mlpack {
20 namespace bindings {
21 namespace cli {
22 
27 inline std::string GetBindingName(const std::string& bindingName);
28 
32 inline std::string PrintImport(const std::string& bindingName);
33 
37 inline std::string PrintInputOptionInfo();
38 
42 inline std::string PrintOutputOptionInfo();
43 
47 inline std::string PrintTypeDocs();
48 
52 template<typename T>
53 inline std::string PrintValue(const T& value, bool quotes);
54 
58 inline std::string PrintDefault(const std::string& paramName);
59 
63 inline std::string PrintDataset(const std::string& dataset);
64 
68 inline std::string PrintModel(const std::string& model);
69 
74 inline std::string PrintType(const util::ParamData& param);
75 
79 inline std::string ProcessOptions();
80 
84 template<typename T, typename... Args>
85 std::string ProcessOptions(const std::string& paramName,
86  const T& value,
87  Args... args);
88 
93 template<typename... Args>
94 std::string ProgramCall(const std::string& programName, Args... args);
95 
100 inline std::string ProgramCall(const std::string& programName);
101 
108 inline std::string ParamString(const std::string& paramName);
109 
115 template<typename T>
116 inline bool IgnoreCheck(const T& /* t */) { return false; }
117 
118 } // namespace cli
119 } // namespace bindings
120 } // namespace mlpack
121 
122 // Include implementation.
123 #include "print_doc_functions_impl.hpp"
124 
125 #endif
std::string PrintTypeDocs()
Print documentation for each of the types.
std::string ProgramCall(const std::string &programName, Args... args)
Given a program name and arguments for it, print what its invocation would be.
Linear algebra utility functions, generally performed on matrices or vectors.
Definition: add_to_po.hpp:21
std::string GetBindingName(const std::string &bindingName)
Given the name of a binding, print its command-line name (this returns "mlpack_<bindingName>".
std::string PrintImport(const std::string &bindingName)
Print any imports for CLI (there are none, so this returns an empty string).
std::string PrintInputOptionInfo()
Print any special information about input options.
std::string programName
std::string ParamString(const std::string &paramName)
Print what a user would type to invoke the given option name.
std::string PrintDataset(const std::string &dataset)
Print a dataset type parameter (add .csv and return).
bool IgnoreCheck(const T &)
Return whether or not a runtime check on parameters should be ignored.
std::string PrintOutputOptionInfo()
Print any special information about output options.
std::string PrintType(const util::ParamData &param)
Print the type of a parameter that a user would specify from the command-line.
std::string PrintDefault(const std::string &paramName)
Given a parameter name, print its corresponding default value.
std::string PrintValue(const T &value, bool quotes)
Given a parameter type, print the corresponding value.
std::string PrintModel(const std::string &model)
Print a model type parameter (add .bin and return).
std::string ProcessOptions()
Base case for recursion.