mlpack
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 
17 #include <mlpack/core/util/hyphenate_string.hpp>
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 PrintOutputOptionInfo();
38 
42 inline std::string PrintTypeDocs();
43 
47 template<typename T>
48 inline std::string PrintValue(const T& value, bool quotes);
49 
53 inline std::string PrintDefault(const std::string& paramName);
54 
58 inline std::string PrintDataset(const std::string& dataset);
59 
63 inline std::string PrintModel(const std::string& model);
64 
69 inline std::string PrintType(const util::ParamData& param);
70 
74 inline std::string ProcessOptions();
75 
79 template<typename T, typename... Args>
80 std::string ProcessOptions(const std::string& paramName,
81  const T& value,
82  Args... args);
83 
88 template<typename... Args>
89 std::string ProgramCall(const std::string& programName, Args... args);
90 
95 inline std::string ProgramCall(const std::string& programName);
96 
103 inline std::string ParamString(const std::string& paramName);
104 
110 template<typename T>
111 inline bool IgnoreCheck(const T& /* t */) { return false; }
112 
113 } // namespace cli
114 } // namespace bindings
115 } // namespace mlpack
116 
117 // Include implementation.
118 #include "print_doc_functions_impl.hpp"
119 
120 #endif
mlpack::bindings::cli::PrintTypeDocs
std::string PrintTypeDocs()
Print documentation for each of the types.
mlpack::bindings::cli::ProgramCall
std::string ProgramCall(const std::string &programName, Args... args)
Given a program name and arguments for it, print what its invocation would be.
mlpack
strip_type.hpp
Definition: add_to_po.hpp:21
mlpack::bindings::cli::GetBindingName
std::string GetBindingName(const std::string &bindingName)
Given the name of a binding, print its command-line name (this returns "mlpack_<bindingName>".
mlpack::bindings::cli::PrintImport
std::string PrintImport(const std::string &bindingName)
Print any imports for CLI (there are none, so this returns an empty string).
mlpack::bindings::go::programName
std::string programName
mlpack::bindings::cli::ParamString
std::string ParamString(const std::string &paramName)
Print what a user would type to invoke the given option name.
mlpack::bindings::cli::PrintDataset
std::string PrintDataset(const std::string &dataset)
Print a dataset type parameter (add .csv and return).
mlpack::bindings::cli::IgnoreCheck
bool IgnoreCheck(const T &)
Return whether or not a runtime check on parameters should be ignored.
Definition: print_doc_functions.hpp:111
hyphenate_string.hpp
mlpack::bindings::cli::PrintOutputOptionInfo
std::string PrintOutputOptionInfo()
Print any special information about output options.
mlpack::bindings::cli::PrintType
std::string PrintType(const util::ParamData &param)
Print the type of a parameter that a user would specify from the command-line.
mlpack::bindings::cli::PrintDefault
std::string PrintDefault(const std::string &paramName)
Given a parameter name, print its corresponding default value.
mlpack::bindings::cli::PrintValue
std::string PrintValue(const T &value, bool quotes)
Given a parameter type, print the corresponding value.
mlpack::bindings::cli::PrintModel
std::string PrintModel(const std::string &model)
Print a model type parameter (add .bin and return).
mlpack::bindings::cli::ProcessOptions
std::string ProcessOptions()
Base case for recursion.