mlpack 3.4.2
Namespaces | Functions
print_doc_functions.hpp File Reference
Include dependency graph for print_doc_functions.hpp:

Go to the source code of this file.

Namespaces

namespace  mlpack
 Linear algebra utility functions, generally performed on matrices or vectors.
 
namespace  mlpack::bindings
 
namespace  mlpack::bindings::go
 

Functions

std::string GetBindingName (const std::string &bindingName)
 Given the name of a binding, print its Go name. More...
 
void GetOptions (std::vector< std::tuple< std::string, std::string > > &)
 
template<typename T , typename... Args>
void GetOptions (std::vector< std::tuple< std::string, std::string > > &results, const std::string &paramName, const T &value, Args... args)
 Assemble a vector of string tuples indicating parameter names and what should be printed for them. More...
 
bool IgnoreCheck (const std::string &paramName)
 Print whether or not we should ignore a check on the given parameter. More...
 
bool IgnoreCheck (const std::vector< std::pair< std::string, bool > > &constraints, const std::string &paramName)
 Print whether or not we should ignore a check on the given set of constraints. 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...
 
std::string ParamString (const std::string &paramName)
 Given the parameter name, determine what it would actually be when passed to the command line. More...
 
std::string PrintDataset (const std::string &datasetName)
 Given the name of a matrix, print it. More...
 
std::string PrintDefault (const std::string &paramName)
 Given a parameter name, print its corresponding default value. More...
 
std::string PrintImport ()
 Print any import information for the Go binding. More...
 
std::string PrintInputOptionInfo ()
 Print any special information about input options. More...
 
std::string PrintInputOptions ()
 
template<typename T , typename... Args>
std::string PrintInputOptions (const std::string &paramName, const T &value, Args... args)
 Print an input option. More...
 
std::string PrintModel (const std::string &modelName)
 Given the name of a model, print it. More...
 
std::string PrintOptionalInputs ()
 
template<typename T , typename... Args>
std::string PrintOptionalInputs (const std::string &paramName, const T &value, Args... args)
 Print an input option. More...
 
std::string PrintOutputOptionInfo ()
 Print any special information about output options. More...
 
std::string PrintOutputOptions ()
 
template<typename... Args>
std::string PrintOutputOptions (Args... args)
 
template<>
std::string PrintValue (const bool &value, bool quotes)
 
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 name of a binding and a variable number of arguments (and their contents), print the corresponding function call. More...
 

Detailed Description

Author
Yashwant Singh
Yasmine Dumouchel

This file contains functions useful for printing documentation strings related to Go 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.