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.
Namespaces | |
| mlpack | |
Linear algebra utility functions, generally performed on matrices or vectors. | |
| mlpack::bindings | |
| mlpack::bindings::markdown | |
Functions | |
| template<typename... Args> | |
| std::string | CallMethod (const std::string &bindingName, const std::string &objectName, const std::string &methodName, Args... args) |
| Print the string that calls a method from the object created. More... | |
| template<typename... Args> | |
| std::string | CreateObject (const std::string &bindingName, const std::string &objectName, const std::string &groupName, Args... args) |
| Print the string that creates object of the given method with the given parameters. More... | |
| std::string | CreateObject (const std::string &bindingName, const std::string &objectName, const std::string &groupName) |
| Print the string that creates object of the given method with default parameters. More... | |
| std::string | GetBindingName (const std::string &bindingName) |
| Given the name of the binding, print the name for the current language (as given by BindingInfo). More... | |
| std::string | GetDataset (const std::string &datasetName, const std::string &url) |
| Print the string that reads dataset from an online source. More... | |
| std::string | GetMappedName (const std::string &methodName) |
| Get the mapped name in the corresponding language. More... | |
| std::string | GetWrapperLink (const std::string &bindingName) |
| std::string | GetWrapperName (const std::string &bindingName) |
| Given the name of the binding, print the name for the wrapper for current language. More... | |
template < typename T > | |
| bool | IgnoreCheck (const std::string &bindingName, const T &t) |
| Return whether or not a runtime check on parameters should be ignored. More... | |
| std::string | ImportExtLib () |
| Print the import string that imports any external libs. More... | |
| std::string | ImportSplit () |
| Print the import string that imports mlpack's preprocess_split method. More... | |
| std::string | ImportThis (const std::string &groupName) |
| Import the current method. More... | |
| std::string | ParamString (const std::string &bindingName, const std::string ¶mName) |
| Print what a user would type to invoke the given option name. More... | |
| std::string | ParamType (util::Params &p, util::ParamData &d) |
| Print the user-encountered type of an option. 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 ¶mName) |
| Print the default value of an option, unless it is required (in which case Markdown italicized '–' is printed). More... | |
| std::string | PrintImport (const std::string &bindingName) |
| Print any imports that need to be done before using the binding. More... | |
| std::string | PrintInputOptionInfo (const std::string &language) |
| Print any special information about input options. More... | |
| std::string | PrintLanguage (const std::string &language) |
| Print the name of the given language. More... | |
| std::string | PrintModel (const std::string &model) |
| Print a model type parameter (add .bin and return). More... | |
| std::string | PrintOutputOptionInfo (const std::string &language) |
| Print any special information about output options. More... | |
| std::string | PrintTypeDocs () |
| Print details about the different types for a language. More... | |
template < typename T > | |
| std::string | PrintValue (const T &value, bool quotes) |
| Given a parameter type, print the corresponding value. 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 call assuming that all arguments are specified. More... | |
| std::string | SplitTrainTest (const std::string &datasetName, const std::string &labelName, const std::string &trainDataset, const std::string &trainLabels, const std::string &testDataset, const std::string &testLabels, const std::string &splitRatio) |
| Print the string that splits dataset into training and testing. More... | |
Detailed Description
This file wraps the different printing functionality of different binding types. If a new binding type is added, this code will need to be modified so that Markdown can be printed.
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 http://www.opensource.org/licenses/BSD-3-Clause for more information.
Definition in file print_doc_functions.hpp.