print_help.cpp File Reference

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

Include dependency graph for print_help.cpp:

Namespaces
	mlpack
	Linear algebra utility functions, generally performed on matrices or vectors.

Functions
void	mlpack::bindings::cli::PrintHelp (const std::string &param="")
	Print the help for the given parameter. More...

Detailed Description

Author

Matthew Amidon

Ryan Curtin

Print help for a given function.

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.

Function Documentation

PrintHelp()

void mlpack::bindings::cli::PrintHelp

(

const std::string &

param = ""

)

Print the help for the given parameter.

If no parameter is specified, then help will be printed for all parameters.

Parameters

param

Parameter name to print help for.