MLPACK
1.0.4
|
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. | |
Static Public Attributes | |
static std::ostream & | cout |
Reference to cout, if necessary. | |
static util::NullOutStream | Debug |
Dumps debug output into the bit nether regions. | |
static util::PrefixedOutStream | Fatal |
Prints fatal messages prefixed with [FATAL], then terminates the program. | |
static util::PrefixedOutStream | Info |
Prints informational messages if --verbose is specified, prefixed with [INFO ]. | |
static util::PrefixedOutStream | Warn |
Prints warning messages prefixed with [WARN ]. |
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).
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().
std::ostream& mlpack::Log::cout [static] |
util::NullOutStream mlpack::Log::Debug [static] |
Dumps debug output into the bit nether regions.
Definition at line 84 of file log.hpp.
Referenced by mlpack::gmm::GMM< FittingType >::GMM().
Prints fatal messages prefixed with [FATAL], then terminates the program.
Definition at line 95 of file log.hpp.
Referenced by mlpack::kernel::SphericalKernel::ConvolutionIntegral().
util::PrefixedOutStream mlpack::Log::Info [static] |
util::PrefixedOutStream mlpack::Log::Warn [static] |
Prints warning messages prefixed with [WARN ].
Definition at line 92 of file log.hpp.
Referenced by mlpack::nmf::RandomAcolInitialization< p >::Initialize(), and mlpack::kmeans::KMeans< DistanceMetric, InitialPartitionPolicy, EmptyClusterPolicy >::OverclusteringFactor().