mlpack  2.2.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
option.hpp
Go to the documentation of this file.
1 
13 #ifndef MLPACK_CORE_UTIL_OPTION_HPP
14 #define MLPACK_CORE_UTIL_OPTION_HPP
15 
16 #include <string>
17 
18 #include "cli.hpp"
19 
20 namespace mlpack {
21 namespace util {
22 
31 template<typename N>
32 class Option
33 {
34  public:
50  Option(const bool ignoreTemplate,
51  const N defaultValue,
52  const std::string& identifier,
53  const std::string& description,
54  const std::string& alias,
55  const bool required = false,
56  const bool input = true);
57 
67  Option(const std::string& identifier,
68  const std::string& description,
69  const std::string& alias);
70 };
71 
81 {
82  public:
92  ProgramDoc(const std::string& programName,
93  const std::string& documentation);
94 
96  std::string programName;
98  std::string documentation;
99 };
100 
101 } // namespace util
102 } // namespace mlpack
103 
104 // For implementations of templated functions
105 #include "option_impl.hpp"
106 
107 #endif
A static object whose constructor registers a parameter with the CLI class.
Definition: option.hpp:32
Option(const bool ignoreTemplate, const N defaultValue, const std::string &identifier, const std::string &description, const std::string &alias, const bool required=false, const bool input=true)
Construct an Option object.
std::string programName
The name of the program.
Definition: option.hpp:96
std::string documentation
Documentation for what the program does.
Definition: option.hpp:98
ProgramDoc(const std::string &programName, const std::string &documentation)
Construct a ProgramDoc object.
A static object whose constructor registers program documentation with the CLI class.
Definition: option.hpp:80