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(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	CALL_METHOD(...)
	CALL_METHOD() returns a string that calls a method of an instance. More...

#define	CREATE_OBJECT(...)
	CREATE_OBJECT() returns a string that creates an instance of the class. More...

#define	GET_DATASET mlpack::bindings::markdown::GetDataset
	GET_DATASET() returns a string that reads data from a source and, stores in a variable. More...

#define	IMPORT_EXT_LIB mlpack::bindings::markdown::ImportExtLib
	IMPORT_EXT_LIB() returns a string that imports required external libraries for a particular language. More...

#define	IMPORT_SPLIT mlpack::bindings::markdown::ImportSplit
	IMPORT_SPLIT() returns a string that imports mlpack's preprocess_split. More...

#define	IMPORT_THIS mlpack::bindings::markdown::ImportThis
	IMPORT_THIS() returns a string that imports the current method. More...

#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...

#define	SPLIT_TRAIN_TEST mlpack::bindings::markdown::SplitTrainTest
	SPLIT_TRAIN_TEST() splits the dataset into train and test datasets. 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:

mlpack::bindings::markdown::IgnoreCheck( \

STRINGIFY(BINDING_NAME), x)

mlpack::bindings::markdown::IgnoreCheck

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 103 of file mlpack_main.hpp.

◆ BINDING_MATRIX_TRANSPOSED [1/2]

#define BINDING_MATRIX_TRANSPOSED true

Definition at line 107 of file mlpack_main.hpp.

◆ BINDING_MATRIX_TRANSPOSED [2/2]

#define BINDING_MATRIX_TRANSPOSED true

Definition at line 107 of file mlpack_main.hpp.

◆ CALL_METHOD

#define CALL_METHOD ( ... )

Value:

mlpack::bindings::markdown::CallMethod(\

STRINGIFY(BINDING_NAME), __VA_ARGS__)

mlpack::bindings::markdown::CallMethod

std::string CallMethod(const std::string &bindingName, const std::string &objectName, const std::string &methodName, Args... args)

Print the string that calls a method from the object created.

CALL_METHOD() returns a string that calls a method of an instance.

Definition at line 87 of file mlpack_main.hpp.

◆ CREATE_OBJECT

#define CREATE_OBJECT ( ... )

Value:

mlpack::bindings::markdown::CreateObject(\

STRINGIFY(BINDING_NAME), __VA_ARGS__)

mlpack::bindings::markdown::CreateObject

std::string CreateObject(const std::string &bindingName, const std::string &objectName, const std::string &groupName, Args... args)

Print the string that creates object of the given method with the given parameters.

CREATE_OBJECT() returns a string that creates an instance of the class.

Definition at line 81 of file mlpack_main.hpp.

◆ GET_DATASET

#define GET_DATASET mlpack::bindings::markdown::GetDataset

GET_DATASET() returns a string that reads data from a source and, stores in a variable.

Definition at line 70 of file mlpack_main.hpp.

◆ IMPORT_EXT_LIB

#define IMPORT_EXT_LIB mlpack::bindings::markdown::ImportExtLib

IMPORT_EXT_LIB() returns a string that imports required external libraries for a particular language.

Definition at line 54 of file mlpack_main.hpp.

◆ IMPORT_SPLIT

#define IMPORT_SPLIT mlpack::bindings::markdown::ImportSplit

IMPORT_SPLIT() returns a string that imports mlpack's preprocess_split.

Definition at line 59 of file mlpack_main.hpp.

◆ IMPORT_THIS

#define IMPORT_THIS mlpack::bindings::markdown::ImportThis

IMPORT_THIS() returns a string that imports the current method.

Definition at line 64 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 97 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:

mlpack::bindings::markdown::ParamString( \

STRINGIFY(BINDING_NAME), x)

mlpack::bindings::markdown::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::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.

◆ SPLIT_TRAIN_TEST

#define SPLIT_TRAIN_TEST mlpack::bindings::markdown::SplitTrainTest

SPLIT_TRAIN_TEST() splits the dataset into train and test datasets.

Definition at line 75 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
	)

Namespaces

Macros

Functions

Macro Definition Documentation

◆ BINDING_IGNORE_CHECK

◆ BINDING_MATRIX_TRANSPOSED [1/2]

◆ BINDING_MATRIX_TRANSPOSED [2/2]

◆ CALL_METHOD

◆ CREATE_OBJECT

◆ GET_DATASET

◆ IMPORT_EXT_LIB

◆ IMPORT_SPLIT

◆ IMPORT_THIS

◆ PRINT_CALL

◆ PRINT_DATASET

◆ PRINT_MODEL

◆ PRINT_PARAM_STRING

◆ PRINT_PARAM_VALUE

◆ SPLIT_TRAIN_TEST

Function Documentation

◆ PARAM_GLOBAL() [1/6]

◆ PARAM_GLOBAL() [2/6]

◆ PARAM_GLOBAL() [3/6]

◆ PARAM_GLOBAL() [4/6]

◆ PARAM_GLOBAL() [5/6]

◆ PARAM_GLOBAL() [6/6]