mlpack 3.4.2
print_doc_functions.hpp
Go to the documentation of this file.
1
14#ifndef MLPACK_BINDINGS_GO_PRINT_DOC_FUNCTIONS_HPP
15#define MLPACK_BINDINGS_GO_PRINT_DOC_FUNCTIONS_HPP
16
18
19namespace mlpack {
20namespace bindings {
21namespace go {
22
26inline std::string GetBindingName(const std::string& bindingName);
27
31inline std::string PrintImport();
32
36inline std::string PrintOutputOptionInfo();
37
41inline std::string PrintInputOptionInfo();
42
46template<typename T>
47inline std::string PrintValue(const T& value, bool quotes);
48
49// Special overload for booleans.
50template<>
51inline std::string PrintValue(const bool& value, bool quotes);
52
56inline std::string PrintDefault(const std::string& paramName);
57
58// Base case: no modification needed.
59inline void GetOptions(
60 std::vector<std::tuple<std::string, std::string>>& /* results */);
61
67template<typename T, typename... Args>
69 std::vector<std::tuple<std::string, std::string>>& results,
70 const std::string& paramName,
71 const T& value,
72 Args... args);
73
74// Recursion base case.
75inline std::string PrintOptionalInputs(/* option */);
76
77// Recursion base case.
78inline std::string PrintInputOptions(/* option */);
79
84template<typename T, typename... Args>
85std::string PrintOptionalInputs(const std::string& paramName,
86 const T& value,
87 Args... args);
88
93template<typename T, typename... Args>
94std::string PrintInputOptions(const std::string& paramName,
95 const T& value,
96 Args... args);
97
98// Recursion base case.
99inline std::string PrintOutputOptions();
100
101template<typename... Args>
102std::string PrintOutputOptions(Args... args);
103
108template<typename... Args>
109std::string ProgramCall(const std::string& programName, Args... args);
110
114inline std::string PrintModel(const std::string& modelName);
115
120inline std::string PrintDataset(const std::string& datasetName);
121
126inline std::string ParamString(const std::string& paramName);
127
131inline bool IgnoreCheck(const std::string& paramName);
132
137inline bool IgnoreCheck(const std::vector<std::string>& constraints);
138
143inline bool IgnoreCheck(
144 const std::vector<std::pair<std::string, bool>>& constraints,
145 const std::string& paramName);
146
147} // namespace go
148} // namespace bindings
149} // namespace mlpack
150
151// Include implementation.
152#include "print_doc_functions_impl.hpp"
153
154#endif
go
Definition: CMakeLists.txt:6
void GetOptions(std::vector< std::tuple< std::string, std::string > > &)
std::string programName
std::string PrintOutputOptionInfo()
Print any special information about output options.
std::string ProgramCall(const std::string &programName, Args... args)
Given a name of a binding and a variable number of arguments (and their contents),...
std::string PrintModel(const std::string &modelName)
Given the name of a model, print it.
std::string PrintOutputOptions()
std::string PrintOptionalInputs()
bool IgnoreCheck(const std::string &paramName)
Print whether or not we should ignore a check on the given parameter.
std::string GetBindingName(const std::string &bindingName)
Given the name of a binding, print its Go name.
std::string PrintInputOptions()
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 PrintDataset(const std::string &datasetName)
Given the name of a matrix, print it.
std::string PrintImport()
Print any import information for the Go binding.
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 PrintInputOptionInfo()
Print any special information about input options.
Linear algebra utility functions, generally performed on matrices or vectors.
Definition: cv.hpp:1