mlpack 3.4.2
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
19namespace mlpack {
20namespace bindings {
21namespace markdown {
22
27inline std::string GetBindingName(const std::string& bindingName);
28
32inline std::string PrintLanguage(const std::string& language);
33
37inline std::string PrintImport(const std::string& bindingName);
38
42inline std::string PrintInputOptionInfo(const std::string& language);
43
47inline std::string PrintOutputOptionInfo(const std::string& language);
48
52inline std::string PrintTypeDocs();
53
57template<typename T>
58inline std::string PrintValue(const T& value, bool quotes);
59
64inline std::string PrintDefault(const std::string& paramName);
65
69inline std::string PrintDataset(const std::string& dataset);
70
74inline std::string PrintModel(const std::string& model);
75
80template<typename... Args>
81std::string ProgramCall(const std::string& programName, Args... args);
82
86inline std::string ProgramCall(const std::string& programName);
87
95inline std::string ParamString(const std::string& paramName);
96
100inline std::string ParamType(util::ParamData& d);
101
105template<typename T>
106inline 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
std::string programName
std::string PrintInputOptionInfo(const std::string &language)
Print any special information about input options.
std::string PrintDefault(const std::string &paramName)
Print the default value of an option, unless it is required (in which case Markdown italicized '–' is...
std::string PrintDataset(const std::string &dataset)
Print a dataset type parameter (add .csv and return).
std::string PrintLanguage(const std::string &language)
Print the name of the given language.
bool IgnoreCheck(const T &t)
Return whether or not a runtime check on parameters should be ignored.
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 PrintModel(const std::string &model)
Print a model type parameter (add .bin and return).
std::string PrintTypeDocs()
Print details about the different types for a language.
std::string PrintImport(const std::string &bindingName)
Print any imports that need to be done before using the binding.
std::string ParamType(util::ParamData &d)
Print the user-encountered type of an option.
std::string ParamString(const std::string &paramName)
Print what a user would type to invoke the given option name.
std::string PrintOutputOptionInfo(const std::string &language)
Print any special information about output options.
std::string PrintValue(const T &value, bool quotes)
Given a parameter type, print the corresponding value.
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.
Linear algebra utility functions, generally performed on matrices or vectors.
Definition: cv.hpp:1
The core includes that mlpack expects; standard C++ includes and Armadillo.
This structure holds all of the information about a single parameter, including its value (which is s...
Definition: param_data.hpp:53