mlpack: a scalable c++ machine learning library
mlpack  2.0.2

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:

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 58 of file log.hpp.

Member Function Documentation

◆ Assert()

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().

Member Data Documentation

◆ cout

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

Reference to cout, if necessary.

Definition at line 95 of file log.hpp.

◆ Debug

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 81 of file log.hpp.

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

◆ Fatal

mlpack_EXPORT util::PrefixedOutStream mlpack::Log::Fatal
static

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

Definition at line 92 of file log.hpp.

Referenced by mlpack::kernel::SphericalKernel::ConvolutionIntegral(), and mlpack::gmm::EigenvalueRatioConstraint::EigenvalueRatioConstraint().

◆ Info

mlpack_EXPORT util::PrefixedOutStream mlpack::Log::Info
static

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

Definition at line 86 of file log.hpp.

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

◆ Warn


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