print_doc_functions.hpp File Reference

Include dependency graph for print_doc_functions.hpp:

Go to the source code of this file.

Namespaces
	mlpack
	.hpp
	mlpack::bindings
	mlpack::bindings::cli

Functions
std::string	GetBindingName (const std::string &bindingName)
	Given the name of a binding, print its command-line name (this returns "mlpack_<bindingName>". More...
template<typename T >
bool	IgnoreCheck (const T &)
	Return whether or not a runtime check on parameters should be ignored. More...
std::string	ParamString (const std::string &paramName)
	Print what a user would type to invoke the given option name. More...
std::string	PrintDataset (const std::string &dataset)
	Print a dataset type parameter (add .csv and return). More...
std::string	PrintDefault (const std::string &paramName)
	Given a parameter name, print its corresponding default value. More...
std::string	PrintImport (const std::string &bindingName)
	Print any imports for CLI (there are none, so this returns an empty string). More...
std::string	PrintModel (const std::string &model)
	Print a model type parameter (add .bin and return). More...
std::string	PrintOutputOptionInfo ()
	Print any special information about output options. More...
std::string	PrintType (const util::ParamData &param)
	Print the type of a parameter that a user would specify from the command-line. More...
std::string	PrintTypeDocs ()
	Print documentation for each of the types. More...
template<typename T >
std::string	PrintValue (const T &value, bool quotes)
	Given a parameter type, print the corresponding value. More...
std::string	ProcessOptions ()
	Base case for recursion. More...
template<typename T , typename... Args>
std::string	ProcessOptions (const std::string &paramName, const T &value, Args...args)
	Print an option for a command-line argument. More...
template<typename... Args>
std::string	ProgramCall (const std::string &programName, Args...args)
	Given a program name and arguments for it, print what its invocation would be. More...
std::string	ProgramCall (const std::string &programName)
	Given a program name, print a program call invocation assuming that all options are specified. More...