mlpack
Namespaces | Functions
print_type_doc.hpp File Reference
#include <mlpack/core/util/is_std_vector.hpp>
#include "print_type_doc_impl.hpp"
Include dependency graph for print_type_doc.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::PrintTypeDoc (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)
 Return a string representing the command-line type of an option.
 
template<typename T >
std::string mlpack::bindings::python::PrintTypeDoc (util::ParamData &data, const typename std::enable_if< util::IsStdVector< T >::value >::type *=0)
 Return a string representing the command-line type of a vector.
 
template<typename T >
std::string mlpack::bindings::python::PrintTypeDoc (util::ParamData &data, const typename std::enable_if< arma::is_arma_type< T >::value >::type *=0)
 Return a string representing the command-line type of a matrix option.
 
template<typename T >
std::string mlpack::bindings::python::PrintTypeDoc (util::ParamData &data, const typename std::enable_if< std::is_same< T, std::tuple< data::DatasetInfo, arma::mat >>::value >::type *=0)
 Return a string representing the command-line type of a matrix tuple option.
 
template<typename T >
std::string mlpack::bindings::python::PrintTypeDoc (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 a string representing the command-line type of a model.
 
template<typename T >
void mlpack::bindings::python::PrintTypeDoc (util::ParamData &data, const void *, void *output)
 Print the command-line type of an option into a string.
 

Detailed Description

Author
Ryan Curtin

Print documentation for a given type, detailing what the type actually is to the user.

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.