mlpack
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 
32 inline std::string PrintLanguage(const std::string& language);
33 
37 inline std::string PrintImport(const std::string& bindingName);
38 
42 inline std::string PrintInputOptionInfo(const std::string& language);
43 
47 inline std::string PrintOutputOptionInfo(const std::string& language);
48 
52 inline std::string PrintTypeDocs();
53 
57 template<typename T>
58 inline std::string PrintValue(const T& value, bool quotes);
59 
64 inline std::string PrintDefault(const std::string& paramName);
65 
69 inline std::string PrintDataset(const std::string& dataset);
70 
74 inline std::string PrintModel(const std::string& model);
75 
80 template<typename... Args>
81 std::string ProgramCall(const std::string& programName, Args... args);
82 
86 inline std::string ProgramCall(const std::string& programName);
87 
95 inline std::string ParamString(const std::string& paramName);
96 
100 inline std::string ParamType(util::ParamData& d);
101 
105 template<typename T>
106 inline bool IgnoreCheck(const T& t);
107 
108 } // namespace markdown
109 } // namespace bindings
110 } // namespace mlpack
111 
112 // Include implementation.
113 #include "print_doc_functions_impl.hpp"
114 
115 #endif
mlpack::bindings::markdown::PrintImport
std::string PrintImport(const std::string &bindingName)
Print any imports that need to be done before using the binding.
mlpack::bindings::markdown::ParamString
std::string ParamString(const std::string ¶mName)
Print what a user would type to invoke the given option name.
mlpack::bindings::markdown::PrintModel
std::string PrintModel(const std::string &model)
Print a model type parameter (add .bin and return).
mlpack
Linear algebra utility functions, generally performed on matrices or vectors.
Definition: add_to_cli11.hpp:21
mlpack::bindings::markdown::PrintValue
std::string PrintValue(const T &value, bool quotes)
Given a parameter type, print the corresponding value.
mlpack::bindings::markdown::GetBindingName
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...
mlpack::bindings::markdown::PrintTypeDocs
std::string PrintTypeDocs()
Print details about the different types for a language.
mlpack::bindings::markdown::ProgramCall
std::string ProgramCall(const std::string &programName, Args... args)
Given a program name and arguments for it, print what its invocation would be.
prereqs.hpp
The core includes that mlpack expects; standard C++ includes and Armadillo.
mlpack::bindings::markdown::PrintLanguage
std::string PrintLanguage(const std::string &language)
Print the name of the given language.
mlpack::bindings::go::programName
std::string programName
mlpack::bindings::markdown::PrintOutputOptionInfo
std::string PrintOutputOptionInfo(const std::string &language)
Print any special information about output options.
mlpack::bindings::markdown::PrintDataset
std::string PrintDataset(const std::string &dataset)
Print a dataset type parameter (add .csv and return).
mlpack::bindings::markdown::PrintInputOptionInfo
std::string PrintInputOptionInfo(const std::string &language)
Print any special information about input options.
mlpack::bindings::markdown::IgnoreCheck
bool IgnoreCheck(const T &t)
Return whether or not a runtime check on parameters should be ignored.
Definition: print_doc_functions.hpp:117
mlpack::bindings::markdown::ParamType
std::string ParamType(util::ParamData &d)
Print the user-encountered type of an option.
mlpack::bindings::markdown::PrintDefault
std::string PrintDefault(const std::string ¶mName)
Print the default value of an option, unless it is required (in which case Markdown italicized '–' i...