print_doc_functions.hpp File Reference
Include dependency graph for print_doc_functions.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.


Linear algebra utility functions, generally performed on matrices or vectors.


std::string GetBindingName (const std::string &bindingName)
 Given the name of a binding, print its command-line name (this returns "mlpack_<bindingName>". More...

bool IgnoreCheck (const T &)
 Return whether or not a runtime check on parameters should be ignored. More...

std::string ParamString (const std::string &bindingName, 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 &bindingName, 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 PrintInputOptionInfo ()
 Print any special information about input options. 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 (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...

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 (util::Params &params, 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 (util::Params &p, const std::string &programName)
 Given a program name, print a program call invocation assuming that all options are specified. More...


Detailed Description

Ryan Curtin

This will generate a string representing what a user should type to invoke a given option. For the command-line bindings, this will generate strings like '–param_name=x' or '–param_name'.

mlpack is free software; you may redistribute it and/or modify it under the terms of the 3-clause BSD license. You should have received a copy of the 3-clause BSD license along with mlpack. If not, see for more information.

Definition in file print_doc_functions.hpp.