ROption< T > Class Template Reference
The R option class. More...
Public Member Functions | |
| ROption (const T defaultValue, const std::string &identifier, const std::string &description, const std::string &alias, const std::string &cppName, const bool required=false, const bool input=true, const bool noTranspose=false, const std::string &bindingName="") | |
| Construct a ROption object. More... | |
Detailed Description
template<typenameT>
class mlpack::bindings::r::ROption< T >
template
<
typename
T
>
The R option class.
Definition at line 31 of file R_option.hpp.
Constructor & Destructor Documentation
◆ ROption()
|
inline |
Construct a ROption object.
When constructed, it will register itself with IO. The testName parameter is not used and added for compatibility reasons.
- Parameters
-
defaultValue Default value this parameter will be initialized to (for flags, this should be false, for instance). identifier The name of the option (no dashes in front; for –help, we would pass "help"). description A short string describing the option. alias Short name of the parameter. "" for no alias. cppName Name of the C++ type of this parameter (i.e. "int"). required Whether or not the option is required at runtime. input Whether or not the option is an input option. noTranspose If the parameter is a matrix and this is true, then the matrix will not be transposed on loading. bindingName Name of the binding that this parameter is for.
Definition at line 52 of file R_option.hpp.
References IO::AddFunction(), IO::AddParameter(), ParamData::alias, ParamData::cppType, ParamData::desc, ParamData::input, ParamData::loaded, ParamData::name, ParamData::noTranspose, ParamData::required, ParamData::tname, TYPENAME, ParamData::value, and ParamData::wasPassed.
The documentation for this class was generated from the following file:
- /home/ryan/src/mlpack.org/_src/mlpack-git/src/mlpack/bindings/R/R_option.hpp