MLPACK  1.0.10
option.hpp
Go to the documentation of this file.
1 
23 #ifndef __MLPACK_CORE_UTIL_OPTION_HPP
24 #define __MLPACK_CORE_UTIL_OPTION_HPP
25 
26 #include <string>
27 
28 #include "cli.hpp"
29 
30 namespace mlpack {
31 namespace util {
32 
41 template<typename N>
42 class Option
43 {
44  public:
60  Option(bool ignoreTemplate,
61  N defaultValue,
62  const std::string& identifier,
63  const std::string& description,
64  const std::string& parent = std::string(""),
65  bool required = false);
66 
77  Option(const std::string& identifier,
78  const std::string& description,
79  const std::string& parent = std::string(""));
80 };
81 
91 {
92  public:
102  ProgramDoc(const std::string& programName,
103  const std::string& documentation);
104 
106  std::string programName;
108  std::string documentation;
109 };
110 
111 }; // namespace util
112 }; // namespace mlpack
113 
114 // For implementations of templated functions
115 #include "option_impl.hpp"
116 
117 #endif
A static object whose constructor registers a parameter with the CLI class.
Definition: option.hpp:42
Linear algebra utility functions, generally performed on matrices or vectors.
Definition: load.hpp:31
std::string programName
The name of the program.
Definition: option.hpp:106
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.
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:90
std::string documentation
Documentation for what the program does.
Definition: option.hpp:108