program_doc.hpp
Go to the documentation of this file.
1 
14 #ifndef MLPACK_CORE_UTIL_PROGRAM_DOC_HPP
15 #define MLPACK_CORE_UTIL_PROGRAM_DOC_HPP
16 
17 namespace mlpack {
18 namespace util {
19 
21 {
22  public:
29  ProgramName(const std::string& programName);
30 };
31 
33 {
34  public:
43  ShortDescription(const std::string& shortDescription);
44 };
45 
47 {
48  public:
57  LongDescription(const std::function<std::string()>& longDescription);
58 };
59 
60 class Example
61 {
62  public:
69  Example(const std::function<std::string()>& example);
70 };
71 
72 class SeeAlso
73 {
74  public:
82  SeeAlso(const std::string& description, const std::string& link);
83 };
84 
85 } // namespace util
86 } // namespace mlpack
87 
88 #endif
Linear algebra utility functions, generally performed on matrices or vectors.
std::string programName
ProgramName(const std::string &programName)
Construct a ProgramName object.