get_printable_param.hpp File Reference

#include <mlpack/prereqs.hpp>
#include <mlpack/core/util/is_std_vector.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::python::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 of a simple type.
template<typename T >
std::string	mlpack::bindings::python::GetPrintableParam (util::ParamData &data, const typename std::enable_if< util::IsStdVector< T >::value >::type *=0)
	Print a vector option, with spaces between it.
template<typename T >
std::string	mlpack::bindings::python::GetPrintableParam (util::ParamData &data, const typename std::enable_if< arma::is_arma_type< T >::value >::type *=0)
	Print a matrix option (this prints its size).
template<typename T >
std::string	mlpack::bindings::python::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 serializable class option (this prints the class name).
template<typename T >
std::string	mlpack::bindings::python::GetPrintableParam (util::ParamData &data, const typename std::enable_if< std::is_same< T, std::tuple< data::DatasetInfo, arma::mat >>::value >::type *=0)
	Print a combination DatasetInfo/matrix parameter.
template<typename T >
void	mlpack::bindings::python::GetPrintableParam (util::ParamData &data, const void *, void *output)
	Print an option into a std::string. More...

Detailed Description

Author

Ryan Curtin

Get a printable version of parameters.

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()

template<typename T >

void mlpack::bindings::python::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.

Parameters

data	Parameter data struct.
*	(input) Unused parameter.
output	Output storage for the string.