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::julia | |
Functions | |
| std::string | GetBindingName (const std::string &bindingName) |
| Given the name of a binding, print its Julia name (this just returns the binding name). More... | |
| bool | IgnoreCheck (const std::string ¶mName) |
| Print whether or not we should ignore a check on the given parameter. More... | |
| bool | IgnoreCheck (const std::vector< std::string > &constraints) |
| Print whether or not we should ignore a check on the given set of constraints. More... | |
| bool | IgnoreCheck (const std::vector< std::pair< std::string, bool >> &constraints, const std::string ¶mName) |
| Print whether or not we should ignore a check on the given set of constraints. More... | |
| std::string | ParamString (const std::string ¶mName) |
| Given the parameter name, determine what it would actually be when passed to the command line. More... | |
| std::string | PrintDataset (const std::string &dataset) |
| Print a dataset type parameter. More... | |
| std::string | PrintDefault (const std::string &bindingName, const std::string ¶mName) |
| Given a parameter name, print its corresponding default value. More... | |
| std::string | PrintImport (const std::string &bindingName) |
| Print any imports for Julia. More... | |
| std::string | PrintInputOptionInfo () |
| Print any special information about input options. More... | |
| std::string | PrintInputOptions (util::Params &p) |
| template<typename T , typename... Args> | |
| std::string | PrintInputOptions (util::Params &p, const std::string ¶mName, const T &value, Args... args) |
| Print an input option. More... | |
| std::string | PrintModel (const std::string &model) |
| Print a model type parameter. More... | |
| std::string | PrintOutputOptionInfo () |
| Print any special information about output options. More... | |
| std::string | PrintOutputOptions (util::Params &p) |
| template<typename T , typename... Args> | |
| std::string | PrintOutputOptions (util::Params &p, const std::string ¶mName, const T &value, Args... args) |
| std::string | PrintType (util::ParamData ¶m) |
| Print the type of a parameter that a user would specify from Julia. 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... | |
template < > | |
| std::string | PrintValue (const bool &value, bool quotes) |
| template<typename... Args> | |
| std::string | ProgramCall (const std::string &programName, Args... args) |
| Given a name of a binding and a variable number of arguments (and their contents), print the corresponding function call. More... | |
| std::string | ProgramCall (util::Params &p, const std::string &programName) |
| Given a name of a binding, print an example call that uses all parameters (for Markdown documentation). More... | |
Detailed Description
This file contains functions useful for printing documentation strings related to Julia bindings.
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.