GoOption< T > Class Template Reference
The Go option class. More...
Public Member Functions | |
| GoOption (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 &="") | |
| Construct a GoOption object. More... | |
Detailed Description
template<typenameT>
class mlpack::bindings::go::GoOption< T >
template
<
typename
T
>
The Go option class.
Definition at line 41 of file go_option.hpp.
Constructor & Destructor Documentation
◆ GoOption()
|
inline |
Construct a GoOption object.
When constructed, it will register itself with CLI. 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. * (testName) Is not used and added for compatibility reasons.
Definition at line 62 of file go_option.hpp.
References CLI::Add(), ParamData::alias, CLI::ClearSettings(), ParamData::cppType, ParamData::desc, CLI::functionMap, CLI::GetSingleton(), ParamData::input, ParamData::loaded, ParamData::name, ParamData::noTranspose, ParamData::persistent, ParamData::required, CLI::RestoreSettings(), CLI::StoreSettings(), ParamData::tname, TYPENAME, ParamData::value, and ParamData::wasPassed.
The documentation for this class was generated from the following file:
- /var/www/mlpack.ratml.org/mlpack.org/_src/mlpack-3.3.2/src/mlpack/bindings/go/go_option.hpp