print_doc_functions.hpp
Go to the documentation of this file.
1 
14 #ifndef MLPACK_BINDINGS_MARKDOWN_PRINT_DOC_FUNCTIONS_HPP
15 #define MLPACK_BINDINGS_MARKDOWN_PRINT_DOC_FUNCTIONS_HPP
16 
17 #include <mlpack/prereqs.hpp>
18 
19 namespace mlpack {
20 namespace bindings {
21 namespace markdown {
22 
27 inline std::string GetBindingName(const std::string& bindingName);
28 
33 inline std::string GetWrapperName(const std::string& bindingName);
34 
38 inline std::string PrintLanguage(const std::string& language);
39 
43 inline std::string PrintImport(const std::string& bindingName);
44 
48 inline std::string PrintInputOptionInfo(const std::string& language);
49 
53 inline std::string PrintOutputOptionInfo(const std::string& language);
54 
58 inline std::string PrintTypeDocs();
59 
63 template<typename T>
64 inline std::string PrintValue(const T& value, bool quotes);
65 
70 inline std::string PrintDefault(const std::string& bindingName,
71  const std::string& paramName);
72 
76 inline std::string PrintDataset(const std::string& dataset);
77 
81 inline std::string PrintModel(const std::string& model);
82 
87 template<typename... Args>
88 std::string ProgramCall(const std::string& programName, Args... args);
89 
93 inline std::string ProgramCall(const std::string& programName);
94 
102 inline std::string ParamString(const std::string& bindingName,
103  const std::string& paramName);
104 
108 inline std::string ParamType(util::Params& p, util::ParamData& d);
109 
113 inline std::string ImportExtLib();
114 
119 inline std::string ImportSplit();
120 
124 inline std::string ImportThis(const std::string& groupName);
125 
129 inline std::string SplitTrainTest(const std::string& datasetName,
130  const std::string& labelName,
131  const std::string& trainDataset,
132  const std::string& trainLabels,
133  const std::string& testDataset,
134  const std::string& testLabels,
135  const std::string& splitRatio);
136 
140 inline std::string GetDataset(const std::string& datasetName,
141  const std::string& url);
142 
147 template<typename... Args>
148 std::string CreateObject(const std::string& bindingName,
149  const std::string& objectName,
150  const std::string& groupName,
151  Args... args);
152 
157 inline std::string CreateObject(const std::string& bindingName,
158  const std::string& objectName,
159  const std::string& groupName);
160 
164 template<typename... Args>
165 std::string CallMethod(const std::string& bindingName,
166  const std::string& objectName,
167  const std::string& methodName,
168  Args... args);
169 
173 inline std::string GetMappedName(const std::string& methodName);
174 
175 inline std::string GetWrapperLink(const std::string& bindingName);
176 
180 template<typename T>
181 inline bool IgnoreCheck(const std::string& bindingName, const T& t);
182 
183 } // namespace markdown
184 } // namespace bindings
185 } // namespace mlpack
186 
187 // Include implementation.
188 #include "print_doc_functions_impl.hpp"
189 
190 #endif
std::string PrintImport(const std::string &bindingName)
Print any imports that need to be done before using the binding.
std::string PrintModel(const std::string &model)
Print a model type parameter (add .bin and return).
Linear algebra utility functions, generally performed on matrices or vectors.
std::string PrintValue(const T &value, bool quotes)
Given a parameter type, print the corresponding value.
std::string ParamString(const std::string &bindingName, const std::string &paramName)
Print what a user would type to invoke the given option name.
std::string CallMethod(const std::string &bindingName, const std::string &objectName, const std::string &methodName, Args... args)
Print the string that calls a method from the object created.
std::string GetBindingName(const std::string &language, const std::string &name)
Given a language name and a binding name, return the name of that binding for that language...
std::string PrintTypeDocs()
Print details about the different types for a language.
std::string ProgramCall(const std::string &programName, Args... args)
Given a program name and arguments for it, print what its invocation would be.
The core includes that mlpack expects; standard C++ includes, Armadillo, cereal, and a few basic mlpa...
std::string ImportExtLib()
Print the import string that imports any external libs.
std::string ParamType(util::Params &p, util::ParamData &d)
Print the user-encountered type of an option.
std::string SplitTrainTest(const std::string &datasetName, const std::string &labelName, const std::string &trainDataset, const std::string &trainLabels, const std::string &testDataset, const std::string &testLabels, const std::string &splitRatio)
Print the string that splits dataset into training and testing.
std::string ImportSplit()
Print the import string that imports mlpack&#39;s preprocess_split method.
std::string PrintDefault(const std::string &bindingName, const std::string &paramName)
Print the default value of an option, unless it is required (in which case Markdown italicized &#39;–&#39; i...
std::string PrintLanguage(const std::string &language)
Print the name of the given language.
std::string GetWrapperName(const std::string &bindingName)
Given the name of the binding, print the name for the wrapper for current language.
bool IgnoreCheck(const std::string &bindingName, const T &t)
Return whether or not a runtime check on parameters should be ignored.
std::string PrintOutputOptionInfo(const std::string &language)
Print any special information about output options.
std::string PrintDataset(const std::string &dataset)
Print a dataset type parameter (add .csv and return).
std::string PrintInputOptionInfo(const std::string &language)
Print any special information about input options.
std::string GetDataset(const std::string &datasetName, const std::string &url)
Print the string that reads dataset from an online source.
std::string GetWrapperLink(const std::string &bindingName)
std::string ImportThis(const std::string &groupName)
Import the current method.
std::string CreateObject(const std::string &bindingName, const std::string &objectName, const std::string &groupName, Args... args)
Print the string that creates object of the given method with the given parameters.
std::string GetMappedName(const std::string &methodName)
Get the mapped name in the corresponding language.