\section{/var/www/mlpack.ratml.\+org/mlpack.org/\+\_\+src/mlpack-\/3.3.2/src/mlpack/bindings/markdown/print\+\_\+doc\+\_\+functions.hpp File Reference}
\label{markdown_2print__doc__functions_8hpp}\index{/var/www/mlpack.\+ratml.\+org/mlpack.\+org/\+\_\+src/mlpack-\/3.\+3.\+2/src/mlpack/bindings/markdown/print\+\_\+doc\+\_\+functions.\+hpp@{/var/www/mlpack.\+ratml.\+org/mlpack.\+org/\+\_\+src/mlpack-\/3.\+3.\+2/src/mlpack/bindings/markdown/print\+\_\+doc\+\_\+functions.\+hpp}}
Include dependency graph for print\+\_\+doc\+\_\+functions.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{markdown_2print__doc__functions_8hpp__incl}
\end{center}
\end{figure}
\subsection*{Namespaces}
\begin{DoxyCompactItemize}
\item 
 \textbf{ mlpack}
\begin{DoxyCompactList}\small\item\em Linear algebra utility functions, generally performed on matrices or vectors. \end{DoxyCompactList}\item 
 \textbf{ mlpack\+::bindings}
\item 
 \textbf{ mlpack\+::bindings\+::markdown}
\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
std\+::string \textbf{ Get\+Binding\+Name} (const std\+::string \&binding\+Name)
\begin{DoxyCompactList}\small\item\em Given the name of the binding, print the name for the current language (as given by \doxyref{Binding\+Info}{p.}{classmlpack_1_1bindings_1_1markdown_1_1BindingInfo}). \end{DoxyCompactList}\item 
{\footnotesize template$<$typename T $>$ }\\bool \textbf{ Ignore\+Check} (const T \&t)
\begin{DoxyCompactList}\small\item\em Return whether or not a runtime check on parameters should be ignored. \end{DoxyCompactList}\item 
std\+::string \textbf{ Param\+String} (const std\+::string \&param\+Name)
\begin{DoxyCompactList}\small\item\em Print what a user would type to invoke the given option name. \end{DoxyCompactList}\item 
std\+::string \textbf{ Param\+Type} (const util\+::\+Param\+Data \&d)
\begin{DoxyCompactList}\small\item\em Print the user-\/encountered type of an option. \end{DoxyCompactList}\item 
std\+::string \textbf{ Print\+Dataset} (const std\+::string \&dataset)
\begin{DoxyCompactList}\small\item\em Print a dataset type parameter (add .csv and return). \end{DoxyCompactList}\item 
std\+::string \textbf{ Print\+Default} (const std\+::string \&param\+Name)
\begin{DoxyCompactList}\small\item\em Print the default value of an option, unless it is required (in which case Markdown italicized \textquotesingle{}--\textquotesingle{} is printed). \end{DoxyCompactList}\item 
std\+::string \textbf{ Print\+Import} (const std\+::string \&binding\+Name)
\begin{DoxyCompactList}\small\item\em Print any imports that need to be done before using the binding. \end{DoxyCompactList}\item 
std\+::string \textbf{ Print\+Input\+Option\+Info} (const std\+::string \&language)
\begin{DoxyCompactList}\small\item\em Print any special information about input options. \end{DoxyCompactList}\item 
std\+::string \textbf{ Print\+Language} (const std\+::string \&language)
\begin{DoxyCompactList}\small\item\em Print the name of the given language. \end{DoxyCompactList}\item 
std\+::string \textbf{ Print\+Model} (const std\+::string \&model)
\begin{DoxyCompactList}\small\item\em Print a model type parameter (add .bin and return). \end{DoxyCompactList}\item 
std\+::string \textbf{ Print\+Output\+Option\+Info} (const std\+::string \&language)
\begin{DoxyCompactList}\small\item\em Print any special information about output options. \end{DoxyCompactList}\item 
std\+::string \textbf{ Print\+Type\+Docs} ()
\begin{DoxyCompactList}\small\item\em Print details about the different types for a language. \end{DoxyCompactList}\item 
{\footnotesize template$<$typename T $>$ }\\std\+::string \textbf{ Print\+Value} (const T \&value, bool quotes)
\begin{DoxyCompactList}\small\item\em Given a parameter type, print the corresponding value. \end{DoxyCompactList}\item 
{\footnotesize template$<$typename... Args$>$ }\\std\+::string \textbf{ Program\+Call} (const std\+::string \&program\+Name, Args... args)
\begin{DoxyCompactList}\small\item\em Given a program name and arguments for it, print what its invocation would be. \end{DoxyCompactList}\item 
std\+::string \textbf{ Program\+Call} (const std\+::string \&program\+Name)
\begin{DoxyCompactList}\small\item\em Given a program name, print a call assuming that all arguments are specified. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
\begin{DoxyAuthor}{Author}
Ryan Curtin
\end{DoxyAuthor}
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 B\+SD license. You should have received a copy of the 3-\/clause B\+SD license along with mlpack. If not, see {\tt http\+://www.\+opensource.\+org/licenses/\+B\+S\+D-\/3-\/\+Clause} for more information.