print_doc_functions.hpp

Go to the documentation of this file.

#ifndef MLPACK_BINDINGS_PYTHON_PRINT_DOC_FUNCTIONS_HPP
#define MLPACK_BINDINGS_PYTHON_PRINT_DOC_FUNCTIONS_HPP

#include <mlpack/core/util/hyphenate_string.hpp>

namespace mlpack {
namespace bindings {
namespace python {

inline std::string GetBindingName(const std::string& bindingName);

inline std::string PrintImport(const std::string& bindingName);

inline std::string PrintInputOptionInfo();

inline std::string PrintOutputOptionInfo();

template<typename T>
inline std::string PrintValue(const T& value, bool quotes);

// Special overload for booleans.
template<>
inline std::string PrintValue(const bool& value, bool quotes);

inline std::string PrintDefault(const std::string& paramName);

// Recursion base case.
inline std::string PrintInputOptions();

template<typename T, typename... Args>
std::string PrintInputOptions(const std::string& paramName,
                              const T& value,
                              Args... args);

// Recursion base case.
inline std::string PrintOutputOptions();

template<typename T, typename... Args>
std::string PrintOutputOptions(const std::string& paramName,
                               const T& value,
                               Args... args);

template<typename... Args>
std::string ProgramCall(const std::string& programName, Args... args);

inline std::string ProgramCall(const std::string& programName);

inline std::string PrintModel(const std::string& modelName);

inline std::string PrintDataset(const std::string& datasetName);

inline std::string ParamString(const std::string& paramName);

inline bool IgnoreCheck(const std::string& paramName);

inline bool IgnoreCheck(const std::vector<std::string>& constraints);

inline bool IgnoreCheck(
    const std::vector<std::pair<std::string, bool>>& constraints,
    const std::string& paramName);

} // namespace python
} // namespace bindings
} // namespace mlpack

// Include implementation.
#include "print_doc_functions_impl.hpp"

#endif