mlpack_main.hpp
Go to the documentation of this file.
1 
9 #ifndef MLPACK_BINDINGS_MARKDOWN_MLPACK_MAIN_HPP
10 #define MLPACK_BINDINGS_MARKDOWN_MLPACK_MAIN_HPP
11 
12 #ifndef BINDING_TYPE
13  #error "BINDING_TYPE not defined! Don't include this file directly!"
14 #endif
15 #if BINDING_TYPE != BINDING_TYPE_MARKDOWN
16  #error "BINDING_TYPE is not set to BINDING_TYPE_MARKDOWN!"
17 #endif
18 
19 // This value doesn't actually matter, but it needs to be defined as something.
20 #define BINDING_MATRIX_TRANSPOSED true
21 
24 
29 #define PRINT_PARAM_STRING(x) mlpack::bindings::markdown::ParamString( \
30  STRINGIFY(BINDING_NAME), x)
31 
36 #define PRINT_PARAM_VALUE mlpack::bindings::markdown::PrintValue
37 
42 #define PRINT_DATASET mlpack::bindings::markdown::PrintDataset
43 
48 #define PRINT_MODEL mlpack::bindings::markdown::PrintModel
49 
57 #define PRINT_CALL mlpack::bindings::markdown::ProgramCall
58 
63 #define BINDING_IGNORE_CHECK(x) mlpack::bindings::markdown::IgnoreCheck( \
64  STRINGIFY(BINDING_NAME), x)
65 
66 // This doesn't actually matter for this binding type.
67 #define BINDING_MATRIX_TRANSPOSED true
68 
69 // This doesn't actually matter for this binding type.
70 #define BINDING_MIN_LABEL 0
71 
72 namespace mlpack {
73 namespace util {
74 
75 template<typename T>
77 
78 }
79 }
80 
82 
83 // This parameter is available for all languages.
84 PARAM_GLOBAL(bool, "verbose", "Display informational messages and the full "
85  "list of parameters and timers at the end of execution.", "v", "bool",
86  false, true, false, false);
87 
88 // CLI-specific parameters.
89 PARAM_GLOBAL(bool, "help", "Default help info.", "h", "bool", false, true,
90  false, false);
91 PARAM_GLOBAL(std::string, "info", "Print help on a specific option.", "",
92  "std::string", false, true, false, "");
93 PARAM_GLOBAL(bool, "version", "Display the version of mlpack.", "V", "bool",
94  false, true, false, false);
95 
96 // Python-specific parameters.
97 PARAM_GLOBAL(bool, "copy_all_inputs", "If specified, all input parameters will "
98  "be deep copied before the method is run. This is useful for debugging "
99  "problems where the input parameters are being modified by the algorithm, "
100  "but can slow down the code.", "", "bool", false, true, false, false);
101 PARAM_GLOBAL(bool, "check_input_matrices", "If specified, the input matrix "
102  "is checked for NaN and inf values; an exception is thrown if any are "
103  "found.", "", "bool", false, true, false, false);
104 
105 #endif
Linear algebra utility functions, generally performed on matrices or vectors.
The Markdown option class.
Definition: md_option.hpp:33
mlpack::bindings::cli::CLIOption< T > Option
Definition: mlpack_main.hpp:77
PARAM_GLOBAL(bool, "help", "Default help info.", "h", "bool", false, true, false, false)