mlpack::Log Class Reference

Provides a convenient way to give formatted output. More...

Static Public Member Functions
static void	Assert (bool condition, const std::string &message="Assert Failed.")
	Checks if the specified condition is true. More...

Static Public Attributes
static std::ostream &	cout
	Reference to cout, if necessary. More...
static MLPACK_EXPORT util::NullOutStream	Debug
	MLPACK_EXPORT is required for global variables, so that they are properly exported by the Windows compiler. More...
static MLPACK_EXPORT util::PrefixedOutStream	Fatal
	Prints fatal messages prefixed with [FATAL], then terminates the program. More...
static MLPACK_EXPORT util::PrefixedOutStream	Info
	Prints informational messages if –verbose is specified, prefixed with [INFO ]. More...
static MLPACK_EXPORT util::PrefixedOutStream	Warn
	Prints warning messages prefixed with [WARN ]. More...

Detailed Description

Provides a convenient way to give formatted output.

The Log class has four members which can be used in the same way ostreams can be used:

• Log::Debug
• Log::Info
• Log::Warn
• Log::Fatal

Each of these will prefix a tag to the output (for easy filtering), and the fatal output will terminate the program when a newline is encountered. An example is given below.

Log::Info << "Checking a condition." << std::endl;
if (!someCondition())
  Log::Warn << "someCondition() is not satisfied!" << std::endl;
Log::Info << "Checking an important condition." << std::endl;
if (!someImportantCondition())
{
  Log::Fatal << "someImportantCondition() is not satisfied! Terminating.";
  Log::Fatal << std::endl;
}

Any messages sent to Log::Debug will not be shown when compiling in non-debug mode. Messages to Log::Info will only be shown when the –verbose flag is given to the program (or rather, the CLI class).

See also

PrefixedOutStream, NullOutStream, CLI

Definition at line 56 of file log.hpp.

Member Function Documentation

static void mlpack::Log::Assert ( bool  condition, const std::string &  message = "Assert Failed."  )

static

Checks if the specified condition is true.

If not, halts program execution and prints a custom error message. Does nothing in non-debug mode.

Referenced by mlpack::emst::EdgePair::EdgePair(), and mlpack::tree::split::PerformSplit().

Member Data Documentation

std::ostream& mlpack::Log::cout

static

Reference to cout, if necessary.

Definition at line 93 of file log.hpp.

MLPACK_EXPORT util::NullOutStream mlpack::Log::Debug

static

MLPACK_EXPORT is required for global variables, so that they are properly exported by the Windows compiler.

Dumps debug output into the bit nether regions.

Definition at line 79 of file log.hpp.

Referenced by mlpack::gmm::GMM::GMM(), and mlpack::distribution::DiscreteDistribution::Probability().

MLPACK_EXPORT util::PrefixedOutStream mlpack::Log::Fatal

static

Prints fatal messages prefixed with [FATAL], then terminates the program.

Definition at line 90 of file log.hpp.

Referenced by mlpack::kernel::SphericalKernel::ConvolutionIntegral(), mlpack::gmm::EigenvalueRatioConstraint::EigenvalueRatioConstraint(), and mlpack::data::MeanImputation< T >::Impute().

MLPACK_EXPORT util::PrefixedOutStream mlpack::Log::Info

static

Prints informational messages if –verbose is specified, prefixed with [INFO ].

Definition at line 84 of file log.hpp.

Referenced by mlpack::amf::SimpleResidueTermination::IsConverged(), and mlpack::amf::SimpleToleranceTermination< MatType >::IsConverged().

MLPACK_EXPORT util::PrefixedOutStream mlpack::Log::Warn

static

Prints warning messages prefixed with [WARN ].

Definition at line 87 of file log.hpp.

Referenced by mlpack::gmm::EigenvalueRatioConstraint::EigenvalueRatioConstraint(), mlpack::amf::RandomAcolInitialization< columnsToAverage >::Initialize(), mlpack::amf::MaxIterationTermination::MaxIterationTermination(), and mlpack::cf::CF::NumUsersForSimilarity().

---

The documentation for this class was generated from the following file:

• src/mlpack/core/util/log.hpp