mlpack  2.0.1
option.hpp
Go to the documentation of this file.
1 
15 #ifndef __MLPACK_CORE_UTIL_OPTION_HPP
16 #define __MLPACK_CORE_UTIL_OPTION_HPP
17 
18 #include <string>
19 
20 #include "cli.hpp"
21 
22 namespace mlpack {
23 namespace util {
24 
33 template<typename N>
34 class Option
35 {
36  public:
52  Option(bool ignoreTemplate,
53  N defaultValue,
54  const std::string& identifier,
55  const std::string& description,
56  const std::string& parent = std::string(""),
57  bool required = false);
58 
69  Option(const std::string& identifier,
70  const std::string& description,
71  const std::string& parent = std::string(""));
72 };
73 
83 {
84  public:
94  ProgramDoc(const std::string& programName,
95  const std::string& documentation);
96 
98  std::string programName;
100  std::string documentation;
101 };
102 
103 } // namespace util
104 } // namespace mlpack
105 
106 // For implementations of templated functions
107 #include "option_impl.hpp"
108 
109 #endif
A static object whose constructor registers a parameter with the CLI class.
Definition: option.hpp:34
Linear algebra utility functions, generally performed on matrices or vectors.
std::string programName
The name of the program.
Definition: option.hpp:98
Option(bool ignoreTemplate, N defaultValue, const std::string &identifier, const std::string &description, const std::string &parent=std::string(""), bool required=false)
Construct an Option object.
A static object whose constructor registers program documentation with the CLI class.
Definition: option.hpp:82
std::string documentation
Documentation for what the program does.
Definition: option.hpp:100