Include dependency graph for mlpack_main.hpp:

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

	mlpack::util

Macros
#define	BINDING_IGNORE_CHECK mlpack::bindings::cli::IgnoreCheck
	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	PRINT_CALL mlpack::bindings::cli::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::cli::PrintDataset
	PRINT_DATASET() returns a string that contains a correct language-specific representation of a dataset name. More...

#define	PRINT_MODEL mlpack::bindings::cli::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::cli::PrintValue
	PRINT_PARAM_VALUE() returns a string that contains a correct language-specific representation of a parameter's value. More...

Typedefs
template < typename T >
using	Option = mlpack::bindings::cli::CLIOption< T >

Functions
void	BINDING_FUNCTION (mlpack::util::Params &, mlpack::util::Timers &)

int	main (int argc, char **argv)

	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, "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, "version", "Display the version of mlpack.", "V", "bool", false, true, false, false)

Macro Definition Documentation

◆ BINDING_IGNORE_CHECK

#define BINDING_IGNORE_CHECK mlpack::bindings::cli::IgnoreCheck

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

#define BINDING_MATRIX_TRANSPOSED true

Definition at line 20 of file mlpack_main.hpp.

◆ PRINT_CALL

#define PRINT_CALL mlpack::bindings::cli::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::cli::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::cli::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:

mlpack::bindings::cli::ParamString( \

STRINGIFY(BINDING_NAME), x)

mlpack::bindings::cli::ParamString

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::cli::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

◆ BINDING_FUNCTION()

void BINDING_FUNCTION	(	mlpack::util::Params &	,
		mlpack::util::Timers &
	)

Referenced by main().

◆ main()

int main	(	int	argc,
		char **	argv
	)

Definition at line 84 of file mlpack_main.hpp.

References BINDING_FUNCTION(), Timers::Enabled(), Timer::EnableTiming(), mlpack::bindings::cli::EndProgram(), PARAM_GLOBAL(), mlpack::bindings::cli::ParseCommandLine(), Timers::Start(), and Timers::Stop().

Referenced by set().

◆ PARAM_GLOBAL() [1/4]

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

Referenced by main().

◆ PARAM_GLOBAL() [2/4]

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

◆ PARAM_GLOBAL() [3/4]

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() [4/4]

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

Namespaces

Macros

Typedefs

Functions