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