Error and Warning Handling
[Base Module]


Defines
#define	it_assert(t, s)
	Abort if `t` is not true.
#define	it_assert_debug(t, s) it_assert(t,s)
	Abort if `t` is not true and NDEBUG is not defined.
#define	it_assert0(t, s) it_assert_debug(t,s)
	Deprecated macro. Please use `it_assert_debug()` instead.
#define	it_assert1(t, s) it_assert_debug(t,s)
	Deprecated macro. Please use `it_assert_debug()` instead.
#define	it_error_if(t, s)
	Abort if `t` is true.
#define	it_error(s)
	Abort unconditionally.
#define	it_info(s)
	Print information message.
#define	it_info_no_endl(s)
	Print information message withot `std::endl` at the end.
#define	it_info_debug(s) it_info(s)
	Print information message if NDEBUG is not defined.
#define	it_info_no_endl_debug(s) it_info_no_endl(s)
	Print information message withot `std::endl` at the end if NDEBUG is not defined.
#define	it_warning(s)
	Display a warning message.
Enumerations
enum	itpp::error_msg_style { Full, Minimum }
	Style of assert, error and warning messages.
Functions
void	itpp::it_assert_f (std::string ass, std::string msg, std::string file, int line)
	Helper function for the `it_assert` and `it_assert_debug` macros.
void	itpp::it_error_f (std::string msg, std::string file, int line)
	Helper function for the `it_error` and `it_error_if` macros.
void	itpp::it_info_f (std::string msg)
	Helper function for the `it_info` and `it_info_debug` macros.
void	itpp::it_warning_f (std::string msg, std::string file, int line)
	Helper function for the `it_warning` macro.
void	itpp::it_enable_exceptions (bool on)
	Enable/disable using exceptions for error handling.
void	itpp::it_enable_warnings ()
	Enable warnings.
void	itpp::it_disable_warnings ()
	Disable warnings.
void	itpp::it_redirect_warnings (std::ostream *warn_stream)
	Redirect warnings to the ostream warn_stream.
void	itpp::it_error_msg_style (error_msg_style style)
	Set preferred style of assert, error and warning messages.

Detailed Description

For the following macros, the argument s is a string that is displayed.

  it_assert(t,s);           // Abort if t is not true
  it_assert_debug(t,s);     // Abort if t is not true and NDEBUG is not defined
  it_error_if(t,s);         // Abort if t is true
  it_error(s);              // Abort
  it_info(s);               // Display a message
  it_info_debug(s);         // Display a message if NDEBUG is not defined
  it_info_no_endl(s);       // Display a message without appended "std::endl"
  it_info_no_endl_debug(s); // Display a message without appended "std::endl" if NDEBUG is not defined
  it_warning(s);            // Display a warning

it_assert(), it_error(), it_error_if(), it_info(), it_info_no_endl() and it_warning() are always active, whereas it_assert_debug(), it_info_debug() and it_info_no_endl_debug() depends on the NDEBUG compile time definition. If NDEBUG is defined, then none of these macros is executed.

Note:: it_assert0() and it_assert1() macros are still defined for backward compatibility, but it_assert_debug() should be used instead of them.

Define Documentation

#define it_assert	(	t,
		s		)

Value:

if (!(t)) {       \
    std::ostringstream m_sout;     \
    m_sout << s;      \
    itpp::it_assert_f(#t,m_sout.str(),__FILE__,__LINE__); \
  } else       \
    ((void) 0)

Abort if t is not true.

#define it_error ( s )

Value:

if (true) {      \
    std::ostringstream m_sout;    \
    m_sout << s;     \
    itpp::it_error_f(m_sout.str(),__FILE__,__LINE__); \
  } else      \
    ((void) 0)

Abort unconditionally.

#define it_error_if	(	t,
		s		)

Value:

if((t)) {      \
    std::ostringstream m_sout;    \
    m_sout << s;     \
    itpp::it_error_f(m_sout.str(),__FILE__,__LINE__); \
  } else      \
    ((void) 0)

Abort if t is true.

Referenced by itpp::assert_shifts(), itpp::LDPC_Generator_Systematic::construct(), itpp::Convolutional_Code::decode_tail(), itpp::Convolutional_Code::decode_tailbite(), itpp::Convolutional_Code::decode_trunc(), itpp::erfinv(), itpp::fact(), itpp::Punctured_Convolutional_Code::inverse_tail(), itpp::Convolutional_Code::inverse_tail(), itpp::it_file_old::open(), itpp::Stack< T >::peek(), itpp::polyval(), itpp::Stack< T >::pop(), itpp::Stack< T >::push(), itpp::Gamma_RNG::sample(), itpp::Convolutional_Code::set_generator_polynomials(), itpp::Root_Raised_Cosine< T1 >::set_pulse_shape(), itpp::Raised_Cosine< T1 >::set_pulse_shape(), itpp::Pulse_Shape< T1, T2, T3 >::set_pulse_shape(), itpp::Punctured_Convolutional_Code::set_puncture_matrix(), itpp::Convolutional_Code::set_start_state(), itpp::Convolutional_Code::set_truncation_length(), itpp::Pulse_Shape< T1, T2, T3 >::shape_samples(), itpp::Pulse_Shape< T1, T2, T3 >::shape_symbols(), itpp::it_file_old::write_data_header(), and itpp::it_file::write_data_header().

#define it_info ( s )

Value:

if (true) {     \
    std::ostringstream m_sout;   \
    m_sout << s << std::endl;   \
    itpp::it_info_f(m_sout.str());  \
  } else     \
    ((void) 0)

Print information message.

Referenced by itpp::LDPC_Parity::display_stats().

#define it_info_no_endl ( s )

Value:

if (true) {     \
    std::ostringstream m_sout;   \
    m_sout << s;    \
    itpp::it_info_f(m_sout.str());  \
  } else     \
    ((void) 0)

Print information message withot std::endl at the end.

#define it_warning ( s )

Value:

if (true) {      \
    std::ostringstream m_sout;    \
    m_sout << s;     \
    itpp::it_warning_f(m_sout.str(),__FILE__,__LINE__); \
  } else      \
    ((void) 0)

Display a warning message.

Referenced by bdm::EKFCh::bayes(), bdm::KalmanCh::bayes(), itpp::chol(), bdm::epdf::condition(), itpp::Punctured_Convolutional_Code::decode_tail(), itpp::Punctured_Convolutional_Code::decode_tailbite(), itpp::Punctured_Convolutional_Code::decode_trunc(), itpp::MOG_diag_kmeans_sup::dezombify_means(), itpp::TDL_Channel::discretize(), dydr(), itpp::Line_Search::get_alpha(), itpp::Fading_Generator::get_doppler_spectrum(), itpp::Fading_Generator::get_filter_length(), itpp::Newton_Search::get_function_value(), itpp::Fast_ICA::get_independent_components(), itpp::Fading_Generator::get_LOS_doppler(), itpp::Fast_ICA::get_mixing_matrix(), itpp::Fading_Generator::get_no_frequencies(), itpp::Line_Search::get_no_function_evaluations(), itpp::Newton_Search::get_no_function_evaluations(), itpp::Newton_Search::get_no_iterations(), itpp::Fading_Generator::get_norm_doppler(), itpp::Fading_Generator::get_rice_method(), itpp::Fast_ICA::get_separating_matrix(), itpp::Line_Search::get_slope_ratio(), itpp::Newton_Search::get_stop_1(), itpp::Newton_Search::get_stop_2(), itpp::Fading_Generator::get_time_offset(), itpp::Line_Search::get_trace(), itpp::Newton_Search::get_trace(), lgam(), itpp::BLDPC_Parity::load_base_matrix(), bdm::epdf::marginal(), itpp::MOG_diag_EM_sup::ml(), itpp::Modulator< T >::modulate_bits(), itpp::it_file_old::pack(), itpp::MOG_diag_kmeans_sup::run(), bdm::egiw::sample(), itpp::Fading_Generator::set_doppler_spectrum(), itpp::Fading_Generator::set_filter_length(), itpp::Fading_Generator::set_LOS_doppler(), itpp::Fading_Generator::set_no_frequencies(), itpp::Fading_Generator::set_norm_doppler(), itpp::Fading_Generator::set_rice_method(), itpp::Mat< Num_T >::set_submatrix(), itpp::Vec< Num_T >::set_subvector(), itpp::Fading_Generator::set_time_offset(), itpp::Fading_Generator::shift_time_offset(), and itpp::xcorr().

Error and Warning Handling [Base Module]

Defines

Enumerations

Functions

Detailed Description

Define Documentation

Error and Warning Handling
[Base Module]