mlpack 3.4.2
binding_details.hpp
Go to the documentation of this file.
1
12#ifndef MLPACK_CORE_UTIL_BINDING_DETAILS_HPP
13#define MLPACK_CORE_UTIL_BINDING_DETAILS_HPP
14
15#include <mlpack/prereqs.hpp>
16#include "program_doc.hpp"
17
18namespace mlpack {
19namespace util {
20
25{
27 std::string programName;
30 std::string shortDescription;
33 std::function<std::string()> longDescription;
35 std::vector<std::function<std::string()>> example;
38 std::vector<std::pair<std::string, std::string>> seeAlso;
39};
40
41} // namespace util
42} // namespace mlpack
43
44#endif
Linear algebra utility functions, generally performed on matrices or vectors.
Definition: cv.hpp:1
The core includes that mlpack expects; standard C++ includes and Armadillo.
This structure holds all of the information about bindings documentation.
std::string programName
Name of the binding.
std::function< std::string()> longDescription
Long string containing documentation on what it is.
std::string shortDescription
A short two-sentence description of the binding, what it does, and what it is useful for.
std::vector< std::function< std::string()> > example
Documentation on how to use the binding.
std::vector< std::pair< std::string, std::string > > seeAlso
A set of pairs of strings with useful "see also" information; each pair is <description,...