Debug

Defines
#define	arma_debug_assert_cube_as_mat   arma_assert_cube_as_mat
#define	arma_debug_assert_mul_size   arma_assert_mul_size
#define	arma_debug_assert_same_size   arma_assert_same_size
#define	arma_debug_check   arma_check
#define	arma_debug_print   arma_print
#define	arma_debug_set_error   arma_set_error
#define	arma_debug_warn   arma_warn
#define	arma_extra_debug_check   true ? (void)0 : arma_check
#define	arma_extra_debug_print   true ? (void)0 : arma_print
#define	arma_extra_debug_sigprint   true ? (void)0 : arma_bktprint
#define	arma_extra_debug_sigprint_this   true ? (void)0 : arma_thisprint
#define	arma_extra_debug_warn   true ? (void)0 : arma_warn
#define	ARMA_FILELINE   __FILE__ ": " ARMA_STRING2(__LINE__)
#define	ARMA_FNSIG   "(unknown)"
#define	ARMA_STRING1(x)   #x
#define	ARMA_STRING2(x)   ARMA_STRING1(x)
Functions
template<typename eT , typename T1 >
void	arma_assert_cube_as_mat (const Mat< eT > &M, const T1 &Q, const char *x, const bool check_compat_size)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_mul_size (const subview< eT1 > &A, const subview< eT2 > &B, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_mul_size (const subview< eT1 > &A, const Mat< eT2 > &B, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_mul_size (const Mat< eT1 > &A, const subview< eT2 > &B, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_mul_size (const Mat< eT1 > &A, const Mat< eT2 > &B, const bool do_trans_A, const bool do_trans_B, const char *x)
	stop if given matrices are incompatible for multiplication
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_mul_size (const Mat< eT1 > &A, const Mat< eT2 > &B, const char *x)
	stop if given matrices are incompatible for multiplication
void arma_hot	arma_assert_mul_size (const uword A_n_rows, const uword A_n_cols, const uword B_n_rows, const uword B_n_cols, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const Mat< eT1 > &A, const subview_cube< eT2 > &B, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const subview_cube< eT1 > &A, const Mat< eT2 > &B, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const Mat< eT1 > &A, const Cube< eT2 > &B, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const Cube< eT1 > &A, const Mat< eT2 > &B, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const ProxyCube< eT1 > &A, const ProxyCube< eT2 > &B, const char *x)
	stop if given cube proxies have different sizes
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const subview_cube< eT1 > &A, const subview_cube< eT2 > &B, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const subview_cube< eT1 > &A, const Cube< eT2 > &B, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const Cube< eT1 > &A, const subview_cube< eT2 > &B, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const Cube< eT1 > &A, const Cube< eT2 > &B, const char *x)
	stop if given cubes have different sizes
void arma_hot	arma_assert_same_size (const uword A_n_rows, const uword A_n_cols, const uword A_n_slices, const uword B_n_rows, const uword B_n_cols, const uword B_n_slices, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const subview< eT1 > &A, const Proxy< eT2 > &B, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const Proxy< eT1 > &A, const subview< eT2 > &B, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const Proxy< eT1 > &A, const Mat< eT2 > &B, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const Mat< eT1 > &A, const Proxy< eT2 > &B, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const subview< eT1 > &A, const Mat< eT2 > &B, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const Mat< eT1 > &A, const subview< eT2 > &B, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const subview< eT1 > &A, const subview< eT2 > &B, const char *x)
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const Proxy< eT1 > &A, const Proxy< eT2 > &B, const char *x)
	stop if given proxies have different sizes
template<typename eT1 , typename eT2 >
void arma_hot	arma_assert_same_size (const Mat< eT1 > &A, const Mat< eT2 > &B, const char *x)
	stop if given matrices have different sizes
void arma_hot	arma_assert_same_size (const uword A_n_rows, const uword A_n_cols, const uword B_n_rows, const uword B_n_cols, const char *x)
template<typename T1 >
void arma_cold	arma_bad (const T1 &x, const bool hurl=true)
	print a message to get_stream_err2() and/or throw a run-time error exception
template<typename T1 , typename T2 >
void	arma_bktprint (const T1 &x, const T2 &y)
template<typename T1 >
void	arma_bktprint (const T1 &x)
void	arma_bktprint ()
template<typename T1 , typename T2 >
void arma_hot	arma_check (const bool state, const T1 &x, const T2 &y)
template<typename T1 >
void arma_hot	arma_check (const bool state, const T1 &x)
	if state is true, abort program
template<typename T1 >
void arma_hot	arma_check_bad_alloc (const bool state, const T1 &x)
template<typename eT >
arma_cold std::string	arma_incompat_size_string (const subview_cube< eT > &Q, const Mat< eT > &A, const char *x)
arma_cold std::string	arma_incompat_size_string (const uword A_n_rows, const uword A_n_cols, const uword A_n_slices, const uword B_n_rows, const uword B_n_cols, const uword B_n_slices, const char *x)
std::string arma_cold	arma_incompat_size_string (const uword A_n_rows, const uword A_n_cols, const uword B_n_rows, const uword B_n_cols, const char *x)
template<typename T1 , typename T2 , typename T3 >
void arma_cold	arma_print (const T1 &x, const T2 &y, const T3 &z)
template<typename T1 , typename T2 >
void arma_cold	arma_print (const T1 &x, const T2 &y)
template<typename T1 >
void arma_cold	arma_print (const T1 &x)
void arma_cold	arma_print ()
arma_inline void arma_hot	arma_set_error (bool &err_state, char *&err_msg, const bool expression, const char *message)
void	arma_sigprint (const char *x)
template<typename T1 >
void arma_cold	arma_stop (const T1 &x)
	print a message to get_stream_err1() and/or throw a logic_error exception
template<typename T1 >
void arma_cold	arma_stop_bad_alloc (const T1 &x)
template<typename T >
std::ostream &	arma_stream_err1 (std::ostream *user_stream)
template<typename T >
std::ostream &	arma_stream_err2 (std::ostream *user_stream)
void	arma_thisprint (const void *this_ptr)
template<typename T1 , typename T2 , typename T3 >
void arma_cold	arma_warn (const bool state, const T1 &x, const T2 &y, const T3 &z)
template<typename T1 , typename T2 >
void arma_cold	arma_warn (const bool state, const T1 &x, const T2 &y)
template<typename T1 >
void arma_cold	arma_warn (const bool state, const T1 &x)
	print a message to the warn stream
std::ostream &	get_stream_err1 ()
std::ostream &	get_stream_err2 ()
void	set_stream_err1 (std::ostream &user_stream)
void	set_stream_err2 (std::ostream &user_stream)

---

Define Documentation

#define arma_debug_assert_cube_as_mat   arma_assert_cube_as_mat

Definition at line 1088 of file debug.hpp.

#define arma_debug_assert_mul_size   arma_assert_mul_size

Definition at line 1087 of file debug.hpp.

#define arma_debug_assert_same_size   arma_assert_same_size

Definition at line 1086 of file debug.hpp.

#define arma_debug_check   arma_check

Definition at line 1084 of file debug.hpp.

#define arma_debug_print   arma_print

Definition at line 1082 of file debug.hpp.

#define arma_debug_set_error   arma_set_error

Definition at line 1085 of file debug.hpp.

#define arma_debug_warn   arma_warn

Definition at line 1083 of file debug.hpp.

#define arma_extra_debug_check   true ? (void)0 : arma_check

Definition at line 1120 of file debug.hpp.

#define arma_extra_debug_print   true ? (void)0 : arma_print

Definition at line 1118 of file debug.hpp.

#define arma_extra_debug_sigprint   true ? (void)0 : arma_bktprint

Definition at line 1116 of file debug.hpp.

#define arma_extra_debug_sigprint_this   true ? (void)0 : arma_thisprint

Definition at line 1117 of file debug.hpp.

#define arma_extra_debug_warn   true ? (void)0 : arma_warn

Definition at line 1119 of file debug.hpp.

#define ARMA_FILELINE   __FILE__ ": " ARMA_STRING2(__LINE__)

Definition at line 1065 of file debug.hpp.

#define ARMA_FNSIG   "(unknown)"

Definition at line 1075 of file debug.hpp.

#define ARMA_STRING1

(

x

)

#x

Definition at line 1063 of file debug.hpp.

#define ARMA_STRING2

(

x

)

ARMA_STRING1(x)

Definition at line 1064 of file debug.hpp.

---

Function Documentation

template<typename eT , typename T1 >

void arma_assert_cube_as_mat	(	const Mat< eT > &	M,
		const T1 &	Q,
		const char *	x,
		const bool	check_compat_size
	)			[inline]

Definition at line 813 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_mul_size	(	const subview< eT1 > &	A,
		const subview< eT2 > &	B,
		const char *	x
	)			[inline]

Definition at line 1049 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_mul_size	(	const subview< eT1 > &	A,
		const Mat< eT2 > &	B,
		const char *	x
	)			[inline]

Definition at line 1035 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_mul_size	(	const Mat< eT1 > &	A,
		const subview< eT2 > &	B,
		const char *	x
	)			[inline]

Definition at line 1021 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_mul_size	(	const Mat< eT1 > &	A,
		const Mat< eT2 > &	B,
		const bool	do_trans_A,
		const bool	do_trans_B,
		const char *	x
	)			[inline]

stop if given matrices are incompatible for multiplication

Definition at line 1001 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_mul_size	(	const Mat< eT1 > &	A,
		const Mat< eT2 > &	B,
		const char *	x
	)			[inline]

stop if given matrices are incompatible for multiplication

Definition at line 983 of file debug.hpp.

void arma_hot arma_assert_mul_size	(	const uword	A_n_rows,
		const uword	A_n_cols,
		const uword	B_n_rows,
		const uword	B_n_cols,
		const char *	x
	)			[inline]

Definition at line 968 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const Mat< eT1 > &	A,
		const subview_cube< eT2 > &	B,
		const char *	x
	)			[inline]

Definition at line 800 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const subview_cube< eT1 > &	A,
		const Mat< eT2 > &	B,
		const char *	x
	)			[inline]

Definition at line 786 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const Mat< eT1 > &	A,
		const Cube< eT2 > &	B,
		const char *	x
	)			[inline]

Definition at line 772 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const Cube< eT1 > &	A,
		const Mat< eT2 > &	B,
		const char *	x
	)			[inline]

Definition at line 758 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const ProxyCube< eT1 > &	A,
		const ProxyCube< eT2 > &	B,
		const char *	x
	)			[inline]

stop if given cube proxies have different sizes

Definition at line 731 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const subview_cube< eT1 > &	A,
		const subview_cube< eT2 > &	B,
		const char *	x
	)			[inline]

Definition at line 716 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const subview_cube< eT1 > &	A,
		const Cube< eT2 > &	B,
		const char *	x
	)			[inline]

Definition at line 702 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const Cube< eT1 > &	A,
		const subview_cube< eT2 > &	B,
		const char *	x
	)			[inline]

Definition at line 688 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const Cube< eT1 > &	A,
		const Cube< eT2 > &	B,
		const char *	x
	)			[inline]

stop if given cubes have different sizes

Definition at line 674 of file debug.hpp.

void arma_hot arma_assert_same_size	(	const uword	A_n_rows,
		const uword	A_n_cols,
		const uword	A_n_slices,
		const uword	B_n_rows,
		const uword	B_n_cols,
		const uword	B_n_slices,
		const char *	x
	)			[inline]

Definition at line 659 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const subview< eT1 > &	A,
		const Proxy< eT2 > &	B,
		const char *	x
	)			[inline]

Definition at line 635 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const Proxy< eT1 > &	A,
		const subview< eT2 > &	B,
		const char *	x
	)			[inline]

Definition at line 615 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const Proxy< eT1 > &	A,
		const Mat< eT2 > &	B,
		const char *	x
	)			[inline]

Definition at line 595 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const Mat< eT1 > &	A,
		const Proxy< eT2 > &	B,
		const char *	x
	)			[inline]

Definition at line 575 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const subview< eT1 > &	A,
		const Mat< eT2 > &	B,
		const char *	x
	)			[inline]

Definition at line 555 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const Mat< eT1 > &	A,
		const subview< eT2 > &	B,
		const char *	x
	)			[inline]

Definition at line 535 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const subview< eT1 > &	A,
		const subview< eT2 > &	B,
		const char *	x
	)			[inline]

Definition at line 515 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const Proxy< eT1 > &	A,
		const Proxy< eT2 > &	B,
		const char *	x
	)			[inline]

stop if given proxies have different sizes

Definition at line 495 of file debug.hpp.

template<typename eT1 , typename eT2 >

void arma_hot arma_assert_same_size	(	const Mat< eT1 > &	A,
		const Mat< eT2 > &	B,
		const char *	x
	)			[inline]

stop if given matrices have different sizes

Definition at line 474 of file debug.hpp.

void arma_hot arma_assert_same_size	(	const uword	A_n_rows,
		const uword	A_n_cols,
		const uword	B_n_rows,
		const uword	B_n_cols,
		const char *	x
	)			[inline]

Definition at line 459 of file debug.hpp.

template<typename T1 >

void arma_cold arma_bad	(	const T1 &	x,
		const bool	hurl = true
	)			[inline]

print a message to get_stream_err2() and/or throw a run-time error exception

Definition at line 150 of file debug.hpp.

template<typename T1 , typename T2 >

void arma_bktprint	(	const T1 &	x,
		const T2 &	y
	)			[inline]

Definition at line 267 of file debug.hpp.

template<typename T1 >

void arma_bktprint

(

const T1 &

x

)

[inline]

Definition at line 257 of file debug.hpp.

void arma_bktprint

(

)

[inline]

Definition at line 248 of file debug.hpp.

template<typename T1 , typename T2 >

void arma_hot arma_check	(	const bool	state,
		const T1 &	x,
		const T2 &	y
	)			[inline]

Definition at line 355 of file debug.hpp.

template<typename T1 >

void arma_hot arma_check	(	const bool	state,
		const T1 &	x
	)			[inline]

if state is true, abort program

Definition at line 342 of file debug.hpp.

template<typename T1 >

void arma_hot arma_check_bad_alloc	(	const bool	state,
		const T1 &	x
	)			[inline]

Definition at line 368 of file debug.hpp.

template<typename eT >

arma_cold std::string arma_incompat_size_string	(	const subview_cube< eT > &	Q,
		const Mat< eT > &	A,
		const char *	x
	)			[inline]

Definition at line 432 of file debug.hpp.

arma_cold std::string arma_incompat_size_string	(	const uword	A_n_rows,
		const uword	A_n_cols,
		const uword	A_n_slices,
		const uword	B_n_rows,
		const uword	B_n_cols,
		const uword	B_n_slices,
		const char *	x
	)			[inline]

Definition at line 417 of file debug.hpp.

std::string arma_cold arma_incompat_size_string	(	const uword	A_n_rows,
		const uword	A_n_cols,
		const uword	B_n_rows,
		const uword	B_n_cols,
		const char *	x
	)			[inline]

Definition at line 403 of file debug.hpp.

template<typename T1 , typename T2 , typename T3 >

void arma_cold arma_print	(	const T1 &	x,
		const T2 &	y,
		const T3 &	z
	)			[inline]

Definition at line 216 of file debug.hpp.

template<typename T1 , typename T2 >

void arma_cold arma_print	(	const T1 &	x,
		const T2 &	y
	)			[inline]

Definition at line 205 of file debug.hpp.

template<typename T1 >

void arma_cold arma_print

(

const T1 &

x

)

[inline]

Definition at line 194 of file debug.hpp.

void arma_cold arma_print

(

)

[inline]

Definition at line 184 of file debug.hpp.

arma_inline void arma_hot arma_set_error	(	bool &	err_state,
		char *&	err_msg,
		const bool	expression,
		const char *	message
	)

Definition at line 385 of file debug.hpp.

void arma_sigprint

(

const char *

x

)

[inline]

print a message the the log stream with a preceding @ character. by default the log stream is cout. used for printing the signature of a function (see the arma_extra_debug_sigprint macro)

Definition at line 235 of file debug.hpp.

template<typename T1 >

void arma_cold arma_stop

(

const T1 &

x

)

[inline]

print a message to get_stream_err1() and/or throw a logic_error exception

Definition at line 98 of file debug.hpp.

template<typename T1 >

void arma_cold arma_stop_bad_alloc

(

const T1 &

x

)

[inline]

Definition at line 126 of file debug.hpp.

template<typename T >

std::ostream& arma_stream_err1

(

std::ostream *

user_stream

)

[inline]

Definition at line 23 of file debug.hpp.

template<typename T >

std::ostream& arma_stream_err2

(

std::ostream *

user_stream

)

[inline]

Definition at line 40 of file debug.hpp.

void arma_thisprint

(

const void *

this_ptr

)

[inline]

Definition at line 282 of file debug.hpp.

template<typename T1 , typename T2 , typename T3 >

void arma_cold arma_warn	(	const bool	state,
		const T1 &	x,
		const T2 &	y,
		const T3 &	z
	)			[inline]

Definition at line 324 of file debug.hpp.

template<typename T1 , typename T2 >

void arma_cold arma_warn	(	const bool	state,
		const T1 &	x,
		const T2 &	y
	)			[inline]

Definition at line 311 of file debug.hpp.

template<typename T1 >

void arma_cold arma_warn	(	const bool	state,
		const T1 &	x
	)			[inline]

print a message to the warn stream

Definition at line 298 of file debug.hpp.

std::ostream& get_stream_err1

(

)

[inline]

Definition at line 74 of file debug.hpp.

std::ostream& get_stream_err2

(

)

[inline]

Definition at line 83 of file debug.hpp.

void set_stream_err1

(

std::ostream &

user_stream

)

[inline]

Definition at line 56 of file debug.hpp.

void set_stream_err2

(

std::ostream &

user_stream

)

[inline]

Definition at line 65 of file debug.hpp.