default_param.hpp File Reference

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

Include dependency graph for default_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::DefaultParamImpl (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::string >::value >::type *=0, const typename std::enable_if<!std::is_same< T, std::tuple< mlpack::data::DatasetInfo, arma::mat >>::value >::type *=0)
	Return the default value of an option. More...
template<typename T >
std::string	mlpack::bindings::cli::DefaultParamImpl (util::ParamData &data, const typename std::enable_if< util::IsStdVector< T >::value >::type *=0)
	Return the default value of a vector option.
template<typename T >
std::string	mlpack::bindings::cli::DefaultParamImpl (util::ParamData &data, const typename std::enable_if< std::is_same< T, std::string >::value >::type *=0)
	Return the default value of a string option.
template<typename T >
std::string	mlpack::bindings::cli::DefaultParamImpl (util::ParamData &data, const typename std::enable_if< arma::is_arma_type< T >::value||std::is_same< T, std::tuple< mlpack::data::DatasetInfo, arma::mat >>::value >::type *=0)
	Return the default value of a matrix option, a tuple option, a serializable option, or a string option (this returns the default filename, or '' if the default is no file). More...
template<typename T >
std::string	mlpack::bindings::cli::DefaultParamImpl (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)
	Return the default value of a model option (this returns the default filename, or '' if the default is no file). More...
template<typename T >
void	mlpack::bindings::cli::DefaultParam (util::ParamData &data, const void *, void *output)
	Return the default value of an option. More...

Detailed Description

Author

Ryan Curtin

Return the default value of a parameter, depending on its type.

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

DefaultParam()

template<typename T >

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

Return the default value of an option.

This is the function that will be placed into the CLI functionMap.

DefaultParamImpl() [1/3]

template<typename T >

std::string mlpack::bindings::cli::DefaultParamImpl	(	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::string >::value >::type *	= 0,
		const typename std::enable_if<!std::is_same< T, std::tuple< mlpack::data::DatasetInfo, arma::mat >>::value >::type *	= 0
	)

Return the default value of an option.

This is for regular types.

DefaultParamImpl() [2/3]

template<typename T >

std::string mlpack::bindings::cli::DefaultParamImpl	(	util::ParamData &	data,
		const typename std::enable_if< arma::is_arma_type< T >::value||std::is_same< T, std::tuple< mlpack::data::DatasetInfo, arma::mat >>::value >::type *	= 0
	)

Return the default value of a matrix option, a tuple option, a serializable option, or a string option (this returns the default filename, or '' if the default is no file).

Return the default value of a matrix option (an empty filename).

DefaultParamImpl() [3/3]

template<typename T >

std::string mlpack::bindings::cli::DefaultParamImpl	(	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
	)

Return the default value of a model option (this returns the default filename, or '' if the default is no file).

Return the default value of a model option (an empty filename).