PyOption< T > Class Template Reference
The Python option class. More...
Public Member Functions | |
| PyOption (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 PyOption object. More... | |
Detailed Description
template
class mlpack::bindings::python::PyOption< T >
The Python option class.
Definition at line 37 of file py_option.hpp.
Constructor & Destructor Documentation
◆ PyOption()
|
inline |
Construct a PyOption object.
When constructed, it will register itself with IO. The testName parameter is not used and added for compatibility reasons.
Definition at line 45 of file py_option.hpp.
References IO::Add(), ParamData::alias, IO::ClearSettings(), ParamData::cppType, ParamData::desc, IO::functionMap, IO::GetSingleton(), ParamData::input, ParamData::loaded, ParamData::name, ParamData::noTranspose, ParamData::persistent, ParamData::required, IO::RestoreSettings(), IO::StoreSettings(), ParamData::tname, TYPENAME, ParamData::value, and ParamData::wasPassed.
The documentation for this class was generated from the following file:
- /home/jenkins-mlpack/mlpack.org/_src/mlpack-3.4.2/src/mlpack/bindings/python_documentation.html#py_option.hpp