get_printable_param.hpp File Reference

#include <mlpack/prereqs.hpp>
#include <mlpack/core/util/param_data.hpp>
#include <mlpack/core/util/is_std_vector.hpp>
#include "get_printable_param_impl.hpp"

Include dependency graph for get_printable_param.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.

Functions
template<typename T >
std::string	mlpack::bindings::cli::GetPrintableParam (util::ParamData &data, const typename std::enable_if<!arma::is_arma_type< T >::value >::type *=0, const typename std::enable_if<!util::IsStdVector< T >::value >::type *=0, const typename std::enable_if<!data::HasSerialize< T >::value >::type *=0, const typename std::enable_if<!std::is_same< T, std::tuple< data::DatasetInfo, arma::mat >>::value >::type *=0)
	Print an option.
template<typename T >
std::string	mlpack::bindings::cli::GetPrintableParam (util::ParamData &data, const typename std::enable_if< util::IsStdVector< T >::value >::type *=0)
	Print a vector option, with spaces between it. More...
template<typename T >
std::string	mlpack::bindings::cli::GetPrintableParam (util::ParamData &data, const typename std::enable_if< arma::is_arma_type< T >::value||std::is_same< T, std::tuple< data::DatasetInfo, arma::mat >>::value >::type *=0)
	Print a matrix/tuple option (this just prints the filename).
template<typename T >
std::string	mlpack::bindings::cli::GetPrintableParam (util::ParamData &data, const typename std::enable_if<!arma::is_arma_type< T >::value >::type *=0, const typename std::enable_if< data::HasSerialize< T >::value >::type *=0)
	Print a model option (this just prints the filename).
template<typename T >
void	mlpack::bindings::cli::GetPrintableParam (util::ParamData &data, const void *, void *output)
	Print an option into a std::string. More...

Detailed Description

Author

Ryan Curtin

Print the parameter to stdout, using template metaprogramming to enforce different behavior for different parameter types.

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

GetPrintableParam() [1/2]

template<typename T >

std::string mlpack::bindings::cli::GetPrintableParam	(	util::ParamData &	data,
		const typename std::enable_if< util::IsStdVector< T >::value >::type *	= 0
	)

Print a vector option, with spaces between it.

Print a vector option.

GetPrintableParam() [2/2]

template<typename T >

void mlpack::bindings::cli::GetPrintableParam	(	util::ParamData &	data,
		const void *	,
		void *	output
	)

Print an option into a std::string.

This should print a short, one-line representation of the object. The string will be stored in the output pointer.