mlpack 3.4.2
print_doc_functions.hpp
Go to the documentation of this file.
1
13#ifndef MLPACK_BINDINGS_R_PRINT_DOC_FUNCTIONS_HPP
14#define MLPACK_BINDINGS_R_PRINT_DOC_FUNCTIONS_HPP
15
17
18namespace mlpack {
19namespace bindings {
20namespace r {
21
25inline std::string GetBindingName(const std::string& bindingName);
26
30inline std::string PrintImport();
31
35inline std::string PrintInputOptionInfo();
36
40inline std::string PrintOutputOptionInfo();
41
45template<typename T>
46inline std::string PrintValue(const T& value, bool quotes);
47
51template<>
52inline std::string PrintValue(const bool& value, bool quotes);
53
57inline std::string PrintDefault(const std::string& paramName);
58
62inline std::string PrintInputOptions();
63
68template<typename T, typename... Args>
69std::string PrintInputOptions(const std::string& paramName,
70 const T& value,
71 Args... args);
72
76inline std::string PrintOutputOptions(const bool /* markdown */);
77
78template<typename T, typename... Args>
79std::string PrintOutputOptions(const bool markdown,
80 const std::string& paramName,
81 const T& value,
82 Args... args);
83
88template<typename... Args>
89std::string ProgramCall(const bool markdown,
90 const std::string& programName,
91 Args... args);
92
97inline std::string ProgramCall(const std::string& programName);
98
102inline std::string PrintModel(const std::string& modelName);
103
108inline std::string PrintDataset(const std::string& datasetName);
109
114inline std::string ParamString(const std::string& paramName);
115
119inline bool IgnoreCheck(const std::string& paramName);
120
125inline bool IgnoreCheck(const std::vector<std::string>& constraints);
126
131inline bool IgnoreCheck(
132 const std::vector<std::pair<std::string, bool>>& constraints,
133 const std::string& paramName);
134
135} // namespace r
136} // namespace bindings
137} // namespace mlpack
138
139// Include implementation.
140#include "print_doc_functions_impl.hpp"
141
142#endif
std::string programName
std::string PrintValue(const T &value, bool quotes)
Given a parameter type, print the corresponding value.
std::string PrintOutputOptions(const bool)
Recursion base case.
std::string PrintOutputOptionInfo()
Print any special information about output options.
std::string ParamString(const std::string &paramName)
Given the parameter name, determine what it would actually be when passed to the command line.
std::string GetBindingName(const std::string &bindingName)
Given the name of a binding, print its R name.
std::string PrintDefault(const std::string &paramName)
Given a parameter name, print its corresponding default value.
std::string PrintModel(const std::string &modelName)
Given the name of a model, print it.
bool IgnoreCheck(const std::string &paramName)
Print whether or not we should ignore a check on the given parameter.
std::string PrintDataset(const std::string &datasetName)
Given the name of a matrix, print it.
std::string PrintInputOptions()
Recursion base case.
std::string PrintInputOptionInfo()
Print any special information about input options.
std::string ProgramCall(const bool markdown, const std::string &programName, Args... args)
Given a name of a binding and a variable number of arguments (and their contents),...
std::string PrintImport()
Print any import information for the R binding.
Linear algebra utility functions, generally performed on matrices or vectors.
Definition: cv.hpp:1