mlpack_main.hpp File Reference
Include dependency graph for mlpack_main.hpp:

Go to the source code of this file.

Namespaces

 mlpack
 
Linear algebra utility functions, generally performed on matrices or vectors.
 
 mlpack::util
 

Macros

#define BINDING_IGNORE_CHECK(x)
 BINDING_IGNORE_CHECK() is an internally-used macro to determine whether or not a specific parameter check should be ignored. More...

 
#define BINDING_MATRIX_TRANSPOSED   true
 
#define BINDING_MATRIX_TRANSPOSED   true
 
#define PRINT_CALL   mlpack::bindings::markdown::ProgramCall
 PRINT_CALL() returns a string that contains the full language-specific representation of a call to an mlpack binding. More...

 
#define PRINT_DATASET   mlpack::bindings::markdown::PrintDataset
 PRINT_DATASET() returns a string that contains a correct language-specific representation of a dataset name. More...

 
#define PRINT_MODEL   mlpack::bindings::markdown::PrintModel
 PRINT_MODEL() returns a string that contains a correct language-specific representation of an mlpack model name. More...

 
#define PRINT_PARAM_STRING(x)
 PRINT_PARAM_STRING() returns a string that contains the correct language-specific representation of a parameter's name. More...

 
#define PRINT_PARAM_VALUE   mlpack::bindings::markdown::PrintValue
 PRINT_PARAM_VALUE() returns a string that contains a correct language-specific representation of a parameter's value. More...

 

Functions

 PARAM_GLOBAL (bool, "verbose", "Display informational messages and the full " "list of parameters and timers at the end of execution.", "v", "bool", false, true, false, false)
 
 PARAM_GLOBAL (bool, "help", "Default help info.", "h", "bool", false, true, false, false)
 
 PARAM_GLOBAL (std::string, "info", "Print help on a specific option.", "", "std::string", false, true, false, "")
 
 PARAM_GLOBAL (bool, "version", "Display the version of mlpack.", "V", "bool", false, true, false, false)
 
 PARAM_GLOBAL (bool, "copy_all_inputs", "If specified, all input parameters will " "be deep copied before the method is run. This is useful for debugging " "problems where the input parameters are being modified by the algorithm, " "but can slow down the code.", "", "bool", false, true, false, false)
 
 PARAM_GLOBAL (bool, "check_input_matrices", "If specified, the input matrix " "is checked for NaN and inf values; an exception is thrown if any are " "found.", "", "bool", false, true, false, false)
 

Macro Definition Documentation

◆ BINDING_IGNORE_CHECK

#define BINDING_IGNORE_CHECK (   x)
Value:
STRINGIFY(BINDING_NAME), x)
bool IgnoreCheck(const std::string &bindingName, const T &t)
Return whether or not a runtime check on parameters should be ignored.

BINDING_IGNORE_CHECK() is an internally-used macro to determine whether or not a specific parameter check should be ignored.

Definition at line 63 of file mlpack_main.hpp.

◆ BINDING_MATRIX_TRANSPOSED [1/2]

#define BINDING_MATRIX_TRANSPOSED   true

Definition at line 67 of file mlpack_main.hpp.

◆ BINDING_MATRIX_TRANSPOSED [2/2]

#define BINDING_MATRIX_TRANSPOSED   true

Definition at line 67 of file mlpack_main.hpp.

◆ PRINT_CALL

#define PRINT_CALL   mlpack::bindings::markdown::ProgramCall

PRINT_CALL() returns a string that contains the full language-specific representation of a call to an mlpack binding.

The first argument should be the name of the binding, and all other arguments should be names of parameters followed by values (in the case where the preceding parameter is not a flag).

Definition at line 57 of file mlpack_main.hpp.

◆ PRINT_DATASET

#define PRINT_DATASET   mlpack::bindings::markdown::PrintDataset

PRINT_DATASET() returns a string that contains a correct language-specific representation of a dataset name.

Definition at line 42 of file mlpack_main.hpp.

◆ PRINT_MODEL

#define PRINT_MODEL   mlpack::bindings::markdown::PrintModel

PRINT_MODEL() returns a string that contains a correct language-specific representation of an mlpack model name.

Definition at line 48 of file mlpack_main.hpp.

◆ PRINT_PARAM_STRING

#define PRINT_PARAM_STRING (   x)
Value:
STRINGIFY(BINDING_NAME), x)
std::string ParamString(const std::string &bindingName, const std::string &paramName)
Print what a user would type to invoke the given option name.

PRINT_PARAM_STRING() returns a string that contains the correct language-specific representation of a parameter's name.

Definition at line 29 of file mlpack_main.hpp.

◆ PRINT_PARAM_VALUE

#define PRINT_PARAM_VALUE   mlpack::bindings::markdown::PrintValue

PRINT_PARAM_VALUE() returns a string that contains a correct language-specific representation of a parameter's value.

Definition at line 36 of file mlpack_main.hpp.

Function Documentation

◆ PARAM_GLOBAL() [1/6]

PARAM_GLOBAL ( bool  ,
"verbose"  ,
"Display informational messages and the full " "list of parameters and timers at the end of execution."  ,
"v"  ,
"bool"  ,
false  ,
true  ,
false  ,
false   
)

◆ PARAM_GLOBAL() [2/6]

PARAM_GLOBAL ( bool  ,
"help"  ,
"Default help info."  ,
"h"  ,
"bool"  ,
false  ,
true  ,
false  ,
false   
)

◆ PARAM_GLOBAL() [3/6]

PARAM_GLOBAL ( std::string  ,
"info"  ,
"Print help on a specific option."  ,
""  ,
"std::string"  ,
false  ,
true  ,
false  ,
""   
)

◆ PARAM_GLOBAL() [4/6]

PARAM_GLOBAL ( bool  ,
"version"  ,
"Display the version of mlpack."  ,
"V"  ,
"bool"  ,
false  ,
true  ,
false  ,
false   
)

◆ PARAM_GLOBAL() [5/6]

PARAM_GLOBAL ( bool  ,
"copy_all_inputs"  ,
"If  specified,
all input parameters will " "be deep copied before the method is run. This is useful for debugging " "problems where the input parameters are being modified by the  algorithm,
" "but can slow down the code."  ,
""  ,
"bool"  ,
false  ,
true  ,
false  ,
false   
)

◆ PARAM_GLOBAL() [6/6]

PARAM_GLOBAL ( bool  ,
"check_input_matrices"  ,
"If  specified,
the input matrix " "is checked for NaN and inf values;an exception is thrown if any are " "found."  ,
""  ,
"bool"  ,
false  ,
true  ,
false  ,
false   
)