mlpack 3.4.2
print_doc_functions.hpp
Go to the documentation of this file.
1
13#ifndef MLPACK_BINDINGS_JULIA_PRINT_DOC_FUNCTIONS_HPP
14#define MLPACK_BINDINGS_JULIA_PRINT_DOC_FUNCTIONS_HPP
15
17
18namespace mlpack {
19namespace bindings {
20namespace julia {
21
26inline std::string GetBindingName(const std::string& bindingName);
27
31inline std::string PrintImport(const std::string& bindingName);
32
36inline std::string PrintOutputOptionInfo();
37
41inline std::string PrintInputOptionInfo();
42
46inline std::string PrintTypeDocs();
47
51template<typename T>
52inline std::string PrintValue(const T& value, bool quotes);
53
54// Special overload for booleans.
55template<>
56inline std::string PrintValue(const bool& value, bool quotes);
57
61inline std::string PrintDefault(const std::string& paramName);
62
66inline std::string PrintDataset(const std::string& dataset);
67
71inline std::string PrintModel(const std::string& model);
72
76inline std::string PrintType(util::ParamData& param);
77
78// Recursion base case.
79inline std::string PrintInputOptions();
80
86template<typename T, typename... Args>
87std::string PrintInputOptions(const std::string& paramName,
88 const T& value,
89 Args... args);
90
91// Recursion base case.
92inline std::string PrintOutputOptions();
93
94template<typename T, typename... Args>
95std::string PrintOutputOptions(const std::string& paramName,
96 const T& value,
97 Args... args);
98
103template<typename... Args>
104std::string ProgramCall(const std::string& programName, Args... args);
105
110inline std::string ParamString(const std::string& paramName);
111
117inline bool IgnoreCheck(const std::string& paramName);
118
124inline bool IgnoreCheck(const std::vector<std::string>& constraints);
125
132inline bool IgnoreCheck(
133 const std::vector<std::pair<std::string, bool>>& constraints,
134 const std::string& paramName);
135
136} // namespace julia
137} // namespace bindings
138} // namespace mlpack
139
140// Include implementation.
141#include "print_doc_functions_impl.hpp"
142
143#endif
julia
Definition: CMakeLists.txt:6
bool IgnoreCheck(const std::string &paramName)
Print whether or not we should ignore a check on the given parameter.
std::string PrintOutputOptionInfo()
Print any special information about output options.
std::string PrintOutputOptions()
std::string PrintModel(const std::string &model)
Print a model type parameter.
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 PrintTypeDocs()
Print documentation for each of the types.
std::string PrintDefault(const std::string &paramName)
Given a parameter name, print its corresponding default value.
std::string PrintImport(const std::string &bindingName)
Print any imports for Julia.
std::string GetBindingName(const std::string &bindingName)
Given the name of a binding, print its Julia name (this just returns the binding name).
std::string PrintType(util::ParamData &param)
Print the type of a parameter that a user would specify from Julia.
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 PrintDataset(const std::string &dataset)
Print a dataset type parameter.
std::string PrintInputOptions()
std::string PrintInputOptionInfo()
Print any special information about input options.
std::string PrintValue(const T &value, bool quotes)
Given a parameter type, print the corresponding value.
Linear algebra utility functions, generally performed on matrices or vectors.
Definition: cv.hpp:1
This structure holds all of the information about a single parameter, including its value (which is s...
Definition: param_data.hpp:53