Chris@49: // Copyright (C) 2008-2013 NICTA (www.nicta.com.au) Chris@49: // Copyright (C) 2008-2013 Conrad Sanderson Chris@49: // Copyright (C) 2011 Stanislav Funiak Chris@49: // Chris@49: // This Source Code Form is subject to the terms of the Mozilla Public Chris@49: // License, v. 2.0. If a copy of the MPL was not distributed with this Chris@49: // file, You can obtain one at http://mozilla.org/MPL/2.0/. Chris@49: Chris@49: Chris@49: //! \addtogroup debug Chris@49: //! @{ Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: inline Chris@49: std::ostream& Chris@49: arma_stream_err1(std::ostream* user_stream) Chris@49: { Chris@49: static std::ostream* stream_err1 = &(ARMA_DEFAULT_OSTREAM); Chris@49: Chris@49: if(user_stream != NULL) Chris@49: { Chris@49: stream_err1 = user_stream; Chris@49: } Chris@49: Chris@49: return *stream_err1; Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: inline Chris@49: std::ostream& Chris@49: arma_stream_err2(std::ostream* user_stream) Chris@49: { Chris@49: static std::ostream* stream_err2 = &(ARMA_DEFAULT_OSTREAM); Chris@49: Chris@49: if(user_stream != NULL) Chris@49: { Chris@49: stream_err2 = user_stream; Chris@49: } Chris@49: Chris@49: return *stream_err2; Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: inline Chris@49: void Chris@49: set_stream_err1(std::ostream& user_stream) Chris@49: { Chris@49: arma_stream_err1(&user_stream); Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: inline Chris@49: void Chris@49: set_stream_err2(std::ostream& user_stream) Chris@49: { Chris@49: arma_stream_err2(&user_stream); Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: inline Chris@49: std::ostream& Chris@49: get_stream_err1() Chris@49: { Chris@49: return arma_stream_err1(NULL); Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: inline Chris@49: std::ostream& Chris@49: get_stream_err2() Chris@49: { Chris@49: return arma_stream_err2(NULL); Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: // Chris@49: // arma_stop Chris@49: Chris@49: //! print a message to get_stream_err1() and/or throw a logic_error exception Chris@49: template Chris@49: arma_cold Chris@49: arma_noinline Chris@49: static Chris@49: void Chris@49: arma_stop(const T1& x) Chris@49: { Chris@49: #if defined(ARMA_PRINT_LOGIC_ERRORS) Chris@49: { Chris@49: std::ostream& out = get_stream_err1(); Chris@49: Chris@49: out.flush(); Chris@49: Chris@49: out << '\n'; Chris@49: out << "error: " << x << '\n'; Chris@49: out << '\n'; Chris@49: out.flush(); Chris@49: } Chris@49: #else Chris@49: { Chris@49: arma_ignore(x); Chris@49: } Chris@49: #endif Chris@49: Chris@49: throw std::logic_error(""); Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_cold Chris@49: arma_noinline Chris@49: static Chris@49: void Chris@49: arma_stop_bad_alloc(const T1& x) Chris@49: { Chris@49: std::ostream& out = get_stream_err1(); Chris@49: Chris@49: out.flush(); Chris@49: Chris@49: out << '\n'; Chris@49: out << "error: " << x << '\n'; Chris@49: out << '\n'; Chris@49: out.flush(); Chris@49: Chris@49: throw std::bad_alloc(); Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: // Chris@49: // arma_bad Chris@49: Chris@49: //! print a message to get_stream_err2() and/or throw a run-time error exception Chris@49: template Chris@49: arma_cold Chris@49: arma_noinline Chris@49: static Chris@49: void Chris@49: arma_bad(const T1& x, const bool hurl = true) Chris@49: { Chris@49: #if defined(ARMA_PRINT_RUNTIME_ERRORS) Chris@49: { Chris@49: std::ostream& out = get_stream_err2(); Chris@49: Chris@49: out.flush(); Chris@49: Chris@49: out << '\n'; Chris@49: out << "error: " << x << '\n'; Chris@49: out << '\n'; Chris@49: out.flush(); Chris@49: } Chris@49: #else Chris@49: { Chris@49: arma_ignore(x); Chris@49: } Chris@49: #endif Chris@49: Chris@49: if(hurl == true) Chris@49: { Chris@49: throw std::runtime_error(""); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: // Chris@49: // arma_print Chris@49: Chris@49: Chris@49: arma_cold Chris@49: inline Chris@49: void Chris@49: arma_print() Chris@49: { Chris@49: get_stream_err1() << std::endl; Chris@49: } Chris@49: Chris@49: Chris@49: template Chris@49: arma_cold Chris@49: arma_noinline Chris@49: static Chris@49: void Chris@49: arma_print(const T1& x) Chris@49: { Chris@49: get_stream_err1() << x << std::endl; Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_cold Chris@49: arma_noinline Chris@49: static Chris@49: void Chris@49: arma_print(const T1& x, const T2& y) Chris@49: { Chris@49: get_stream_err1() << x << y << std::endl; Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_cold Chris@49: arma_noinline Chris@49: static Chris@49: void Chris@49: arma_print(const T1& x, const T2& y, const T3& z) Chris@49: { Chris@49: get_stream_err1() << x << y << z << std::endl; Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: Chris@49: Chris@49: Chris@49: // Chris@49: // arma_sigprint Chris@49: Chris@49: //! print a message the the log stream with a preceding @ character. Chris@49: //! by default the log stream is cout. Chris@49: //! used for printing the signature of a function Chris@49: //! (see the arma_extra_debug_sigprint macro) Chris@49: inline Chris@49: void Chris@49: arma_sigprint(const char* x) Chris@49: { Chris@49: get_stream_err1() << "@ " << x; Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: // Chris@49: // arma_bktprint Chris@49: Chris@49: Chris@49: inline Chris@49: void Chris@49: arma_bktprint() Chris@49: { Chris@49: get_stream_err1() << std::endl; Chris@49: } Chris@49: Chris@49: Chris@49: template Chris@49: inline Chris@49: void Chris@49: arma_bktprint(const T1& x) Chris@49: { Chris@49: get_stream_err1() << " [" << x << ']' << std::endl; Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: inline Chris@49: void Chris@49: arma_bktprint(const T1& x, const T2& y) Chris@49: { Chris@49: get_stream_err1() << " [" << x << y << ']' << std::endl; Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: Chris@49: Chris@49: Chris@49: // Chris@49: // arma_thisprint Chris@49: Chris@49: inline Chris@49: void Chris@49: arma_thisprint(const void* this_ptr) Chris@49: { Chris@49: get_stream_err1() << " [this = " << this_ptr << ']' << std::endl; Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: // Chris@49: // arma_warn Chris@49: Chris@49: Chris@49: //! print a message to the warn stream Chris@49: template Chris@49: arma_cold Chris@49: arma_noinline Chris@49: static Chris@49: void Chris@49: arma_warn(const bool state, const T1& x) Chris@49: { Chris@49: if(state==true) Chris@49: { Chris@49: get_stream_err2() << x << std::endl; Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: template Chris@49: arma_cold Chris@49: arma_noinline Chris@49: static Chris@49: void Chris@49: arma_warn(const bool state, const T1& x, const T2& y) Chris@49: { Chris@49: if(state==true) Chris@49: { Chris@49: get_stream_err2() << x << y << std::endl; Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: template Chris@49: arma_cold Chris@49: arma_noinline Chris@49: static Chris@49: void Chris@49: arma_warn(const bool state, const T1& x, const T2& y, const T3& z) Chris@49: { Chris@49: if(state==true) Chris@49: { Chris@49: get_stream_err2() << x << y << z << std::endl; Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: // Chris@49: // arma_check Chris@49: Chris@49: //! if state is true, abort program Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_check(const bool state, const T1& x) Chris@49: { Chris@49: if(state==true) Chris@49: { Chris@49: arma_stop(arma_boost::str_wrapper(x)); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_check(const bool state, const T1& x, const T2& y) Chris@49: { Chris@49: if(state==true) Chris@49: { Chris@49: arma_stop( std::string(x) + std::string(y) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_check_bad_alloc(const bool state, const T1& x) Chris@49: { Chris@49: if(state==true) Chris@49: { Chris@49: arma_stop_bad_alloc(x); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: // Chris@49: // arma_set_error Chris@49: Chris@49: Chris@49: arma_hot Chris@49: arma_inline Chris@49: void Chris@49: arma_set_error(bool& err_state, char*& err_msg, const bool expression, const char* message) Chris@49: { Chris@49: if(expression == true) Chris@49: { Chris@49: err_state = true; Chris@49: err_msg = const_cast(message); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: Chris@49: // Chris@49: // functions for generating strings indicating size errors Chris@49: Chris@49: arma_cold Chris@49: arma_noinline Chris@49: static Chris@49: std::string Chris@49: 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) Chris@49: { Chris@49: std::stringstream tmp; Chris@49: Chris@49: tmp << x << ": incompatible matrix dimensions: " << A_n_rows << 'x' << A_n_cols << " and " << B_n_rows << 'x' << B_n_cols; Chris@49: Chris@49: return tmp.str(); Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: arma_cold Chris@49: arma_noinline Chris@49: static Chris@49: std::string Chris@49: 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) Chris@49: { Chris@49: std::stringstream tmp; Chris@49: Chris@49: tmp << x << ": incompatible cube dimensions: " << A_n_rows << 'x' << A_n_cols << 'x' << A_n_slices << " and " << B_n_rows << 'x' << B_n_cols << 'x' << B_n_slices; Chris@49: Chris@49: return tmp.str(); Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_cold Chris@49: arma_noinline Chris@49: static Chris@49: std::string Chris@49: arma_incompat_size_string(const subview_cube& Q, const Mat& A, const char* x) Chris@49: { Chris@49: std::stringstream tmp; Chris@49: Chris@49: tmp << x Chris@49: << ": interpreting matrix as cube with dimenensions: " Chris@49: << A.n_rows << 'x' << A.n_cols << 'x' << 1 Chris@49: << " or " Chris@49: << A.n_rows << 'x' << 1 << 'x' << A.n_cols Chris@49: << " or " Chris@49: << 1 << 'x' << A.n_rows << 'x' << A.n_cols Chris@49: << " is incompatible with cube dimensions: " Chris@49: << Q.n_rows << 'x' << Q.n_cols << 'x' << Q.n_slices; Chris@49: Chris@49: return tmp.str(); Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: // Chris@49: // functions for checking whether two matrices have the same dimensions Chris@49: Chris@49: Chris@49: Chris@49: arma_inline Chris@49: arma_hot Chris@49: void Chris@49: 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) Chris@49: { Chris@49: if( (A_n_rows != B_n_rows) || (A_n_cols != B_n_cols) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A_n_rows, A_n_cols, B_n_rows, B_n_cols, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: //! stop if given matrices have different sizes Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const Mat& A, const Mat& B, const char* x) Chris@49: { Chris@49: const uword A_n_rows = A.n_rows; Chris@49: const uword A_n_cols = A.n_cols; Chris@49: Chris@49: const uword B_n_rows = B.n_rows; Chris@49: const uword B_n_cols = B.n_cols; Chris@49: Chris@49: if( (A_n_rows != B_n_rows) || (A_n_cols != B_n_cols) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A_n_rows, A_n_cols, B_n_rows, B_n_cols, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: //! stop if given proxies have different sizes Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const Proxy& A, const Proxy& B, const char* x) Chris@49: { Chris@49: const uword A_n_rows = A.get_n_rows(); Chris@49: const uword A_n_cols = A.get_n_cols(); Chris@49: Chris@49: const uword B_n_rows = B.get_n_rows(); Chris@49: const uword B_n_cols = B.get_n_cols(); Chris@49: Chris@49: if( (A_n_rows != B_n_rows) || (A_n_cols != B_n_cols) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A_n_rows, A_n_cols, B_n_rows, B_n_cols, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const subview& A, const subview& B, const char* x) Chris@49: { Chris@49: const uword A_n_rows = A.n_rows; Chris@49: const uword A_n_cols = A.n_cols; Chris@49: Chris@49: const uword B_n_rows = B.n_rows; Chris@49: const uword B_n_cols = B.n_cols; Chris@49: Chris@49: if( (A_n_rows != B_n_rows) || (A_n_cols != B_n_cols) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A_n_rows, A_n_cols, B_n_rows, B_n_cols, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const Mat& A, const subview& B, const char* x) Chris@49: { Chris@49: const uword A_n_rows = A.n_rows; Chris@49: const uword A_n_cols = A.n_cols; Chris@49: Chris@49: const uword B_n_rows = B.n_rows; Chris@49: const uword B_n_cols = B.n_cols; Chris@49: Chris@49: if( (A_n_rows != B_n_rows) || (A_n_cols != B_n_cols) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A_n_rows, A_n_cols, B_n_rows, B_n_cols, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const subview& A, const Mat& B, const char* x) Chris@49: { Chris@49: const uword A_n_rows = A.n_rows; Chris@49: const uword A_n_cols = A.n_cols; Chris@49: Chris@49: const uword B_n_rows = B.n_rows; Chris@49: const uword B_n_cols = B.n_cols; Chris@49: Chris@49: if( (A_n_rows != B_n_rows) || (A_n_cols != B_n_cols) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A_n_rows, A_n_cols, B_n_rows, B_n_cols, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const Mat& A, const Proxy& B, const char* x) Chris@49: { Chris@49: const uword A_n_rows = A.n_rows; Chris@49: const uword A_n_cols = A.n_cols; Chris@49: Chris@49: const uword B_n_rows = B.get_n_rows(); Chris@49: const uword B_n_cols = B.get_n_cols(); Chris@49: Chris@49: if( (A_n_rows != B_n_rows) || (A_n_cols != B_n_cols) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A_n_rows, A_n_cols, B_n_rows, B_n_cols, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const Proxy& A, const Mat& B, const char* x) Chris@49: { Chris@49: const uword A_n_rows = A.get_n_rows(); Chris@49: const uword A_n_cols = A.get_n_cols(); Chris@49: Chris@49: const uword B_n_rows = B.n_rows; Chris@49: const uword B_n_cols = B.n_cols; Chris@49: Chris@49: if( (A_n_rows != B_n_rows) || (A_n_cols != B_n_cols) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A_n_rows, A_n_cols, B_n_rows, B_n_cols, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const Proxy& A, const subview& B, const char* x) Chris@49: { Chris@49: const uword A_n_rows = A.get_n_rows(); Chris@49: const uword A_n_cols = A.get_n_cols(); Chris@49: Chris@49: const uword B_n_rows = B.n_rows; Chris@49: const uword B_n_cols = B.n_cols; Chris@49: Chris@49: if( (A_n_rows != B_n_rows) || (A_n_cols != B_n_cols) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A_n_rows, A_n_cols, B_n_rows, B_n_cols, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const subview& A, const Proxy& B, const char* x) Chris@49: { Chris@49: const uword A_n_rows = A.n_rows; Chris@49: const uword A_n_cols = A.n_cols; Chris@49: Chris@49: const uword B_n_rows = B.get_n_rows(); Chris@49: const uword B_n_cols = B.get_n_cols(); Chris@49: Chris@49: if( (A_n_rows != B_n_rows) || (A_n_cols != B_n_cols) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A_n_rows, A_n_cols, B_n_rows, B_n_cols, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: // Chris@49: // functions for checking whether two cubes have the same dimensions Chris@49: Chris@49: Chris@49: Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: 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) Chris@49: { Chris@49: if( (A_n_rows != B_n_rows) || (A_n_cols != B_n_cols) || (A_n_slices != B_n_slices) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A_n_rows, A_n_cols, A_n_slices, B_n_rows, B_n_cols, B_n_slices, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: //! stop if given cubes have different sizes Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const Cube& A, const Cube& B, const char* x) Chris@49: { Chris@49: if( (A.n_rows != B.n_rows) || (A.n_cols != B.n_cols) || (A.n_slices != B.n_slices) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A.n_rows, A.n_cols, A.n_slices, B.n_rows, B.n_cols, B.n_slices, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const Cube& A, const subview_cube& B, const char* x) Chris@49: { Chris@49: if( (A.n_rows != B.n_rows) || (A.n_cols != B.n_cols) || (A.n_slices != B.n_slices) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A.n_rows, A.n_cols, A.n_slices, B.n_rows, B.n_cols, B.n_slices, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const subview_cube& A, const Cube& B, const char* x) Chris@49: { Chris@49: if( (A.n_rows != B.n_rows) || (A.n_cols != B.n_cols) || (A.n_slices != B.n_slices) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A.n_rows, A.n_cols, A.n_slices, B.n_rows, B.n_cols, B.n_slices, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const subview_cube& A, const subview_cube& B, const char* x) Chris@49: { Chris@49: if( (A.n_rows != B.n_rows) || (A.n_cols != B.n_cols) || (A.n_slices != B.n_slices)) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A.n_rows, A.n_cols, A.n_slices, B.n_rows, B.n_cols, B.n_slices, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: //! stop if given cube proxies have different sizes Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const ProxyCube& A, const ProxyCube& B, const char* x) Chris@49: { Chris@49: const uword A_n_rows = A.get_n_rows(); Chris@49: const uword A_n_cols = A.get_n_cols(); Chris@49: const uword A_n_slices = A.get_n_slices(); Chris@49: Chris@49: const uword B_n_rows = B.get_n_rows(); Chris@49: const uword B_n_cols = B.get_n_cols(); Chris@49: const uword B_n_slices = B.get_n_slices(); Chris@49: Chris@49: if( (A_n_rows != B_n_rows) || (A_n_cols != B_n_cols) || (A_n_slices != B_n_slices)) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A_n_rows, A_n_cols, A_n_slices, B_n_rows, B_n_cols, B_n_slices, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: // Chris@49: // functions for checking whether a cube or subcube can be interpreted as a matrix (i.e. single slice) Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const Cube& A, const Mat& B, const char* x) Chris@49: { Chris@49: if( (A.n_rows != B.n_rows) || (A.n_cols != B.n_cols) || (A.n_slices != 1) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A.n_rows, A.n_cols, A.n_slices, B.n_rows, B.n_cols, 1, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const Mat& A, const Cube& B, const char* x) Chris@49: { Chris@49: if( (A.n_rows != B.n_rows) || (A.n_cols != B.n_cols) || (1 != B.n_slices) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A.n_rows, A.n_cols, 1, B.n_rows, B.n_cols, B.n_slices, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const subview_cube& A, const Mat& B, const char* x) Chris@49: { Chris@49: if( (A.n_rows != B.n_rows) || (A.n_cols != B.n_cols) || (A.n_slices != 1) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A.n_rows, A.n_cols, A.n_slices, B.n_rows, B.n_cols, 1, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_same_size(const Mat& A, const subview_cube& B, const char* x) Chris@49: { Chris@49: if( (A.n_rows != B.n_rows) || (A.n_cols != B.n_cols) || (1 != B.n_slices) ) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A.n_rows, A.n_cols, 1, B.n_rows, B.n_cols, B.n_slices, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: inline Chris@49: void Chris@49: arma_assert_cube_as_mat(const Mat& M, const T1& Q, const char* x, const bool check_compat_size) Chris@49: { Chris@49: const uword Q_n_rows = Q.n_rows; Chris@49: const uword Q_n_cols = Q.n_cols; Chris@49: const uword Q_n_slices = Q.n_slices; Chris@49: Chris@49: const uword M_vec_state = M.vec_state; Chris@49: Chris@49: if(M_vec_state == 0) Chris@49: { Chris@49: if( ( (Q_n_rows == 1) || (Q_n_cols == 1) || (Q_n_slices == 1) ) == false ) Chris@49: { Chris@49: std::stringstream tmp; Chris@49: Chris@49: tmp << x Chris@49: << ": can't interpret cube with dimensions " Chris@49: << Q_n_rows << 'x' << Q_n_cols << 'x' << Q_n_slices Chris@49: << " as a matrix; one of the dimensions must be 1"; Chris@49: Chris@49: arma_stop( tmp.str() ); Chris@49: } Chris@49: } Chris@49: else Chris@49: { Chris@49: if(Q_n_slices == 1) Chris@49: { Chris@49: if( (M_vec_state == 1) && (Q_n_cols != 1) ) Chris@49: { Chris@49: std::stringstream tmp; Chris@49: Chris@49: tmp << x Chris@49: << ": can't interpret cube with dimensions " Chris@49: << Q_n_rows << 'x' << Q_n_cols << 'x' << Q_n_slices Chris@49: << " as a column vector"; Chris@49: Chris@49: arma_stop( tmp.str() ); Chris@49: } Chris@49: Chris@49: if( (M_vec_state == 2) && (Q_n_rows != 1) ) Chris@49: { Chris@49: std::stringstream tmp; Chris@49: Chris@49: tmp << x Chris@49: << ": can't interpret cube with dimensions " Chris@49: << Q_n_rows << 'x' << Q_n_cols << 'x' << Q_n_slices Chris@49: << " as a row vector"; Chris@49: Chris@49: arma_stop( tmp.str() ); Chris@49: } Chris@49: } Chris@49: else Chris@49: { Chris@49: if( (Q_n_cols != 1) && (Q_n_rows != 1) ) Chris@49: { Chris@49: std::stringstream tmp; Chris@49: Chris@49: tmp << x Chris@49: << ": can't interpret cube with dimensions " Chris@49: << Q_n_rows << 'x' << Q_n_cols << 'x' << Q_n_slices Chris@49: << " as a vector"; Chris@49: Chris@49: arma_stop( tmp.str() ); Chris@49: } Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: if(check_compat_size == true) Chris@49: { Chris@49: const uword M_n_rows = M.n_rows; Chris@49: const uword M_n_cols = M.n_cols; Chris@49: Chris@49: if(M_vec_state == 0) Chris@49: { Chris@49: if( Chris@49: ( Chris@49: ( (Q_n_rows == M_n_rows) && (Q_n_cols == M_n_cols) ) Chris@49: || Chris@49: ( (Q_n_rows == M_n_rows) && (Q_n_slices == M_n_cols) ) Chris@49: || Chris@49: ( (Q_n_cols == M_n_rows) && (Q_n_slices == M_n_cols) ) Chris@49: ) Chris@49: == false Chris@49: ) Chris@49: { Chris@49: std::stringstream tmp; Chris@49: Chris@49: tmp << x Chris@49: << ": can't interpret cube with dimenensions " Chris@49: << Q_n_rows << 'x' << Q_n_cols << 'x' << Q_n_slices Chris@49: << " as a matrix with dimensions " Chris@49: << M_n_rows << 'x' << M_n_cols; Chris@49: Chris@49: arma_stop( tmp.str() ); Chris@49: } Chris@49: } Chris@49: else Chris@49: { Chris@49: if(Q_n_slices == 1) Chris@49: { Chris@49: if( (M_vec_state == 1) && (Q_n_rows != M_n_rows) ) Chris@49: { Chris@49: std::stringstream tmp; Chris@49: Chris@49: tmp << x Chris@49: << ": can't interpret cube with dimensions " Chris@49: << Q_n_rows << 'x' << Q_n_cols << 'x' << Q_n_slices Chris@49: << " as a column vector with dimensions " Chris@49: << M_n_rows << 'x' << M_n_cols; Chris@49: Chris@49: arma_stop( tmp.str() ); Chris@49: } Chris@49: Chris@49: if( (M_vec_state == 2) && (Q_n_cols != M_n_cols) ) Chris@49: { Chris@49: std::stringstream tmp; Chris@49: Chris@49: tmp << x Chris@49: << ": can't interpret cube with dimensions " Chris@49: << Q_n_rows << 'x' << Q_n_cols << 'x' << Q_n_slices Chris@49: << " as a row vector with dimensions " Chris@49: << M_n_rows << 'x' << M_n_cols; Chris@49: Chris@49: arma_stop( tmp.str() ); Chris@49: } Chris@49: } Chris@49: else Chris@49: { Chris@49: if( ( (M_n_cols == Q_n_slices) || (M_n_rows == Q_n_slices) ) == false ) Chris@49: { Chris@49: std::stringstream tmp; Chris@49: Chris@49: tmp << x Chris@49: << ": can't interpret cube with dimensions " Chris@49: << Q_n_rows << 'x' << Q_n_cols << 'x' << Q_n_slices Chris@49: << " as a vector with dimensions " Chris@49: << M_n_rows << 'x' << M_n_cols; Chris@49: Chris@49: arma_stop( tmp.str() ); Chris@49: } Chris@49: } Chris@49: } Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: // Chris@49: // functions for checking whether two matrices have dimensions that are compatible with the matrix multiply operation Chris@49: Chris@49: Chris@49: Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: 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) Chris@49: { Chris@49: if(A_n_cols != B_n_rows) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A_n_rows, A_n_cols, B_n_rows, B_n_cols, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: //! stop if given matrices are incompatible for multiplication Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_mul_size(const Mat& A, const Mat& B, const char* x) Chris@49: { Chris@49: const uword A_n_cols = A.n_cols; Chris@49: const uword B_n_rows = B.n_rows; Chris@49: Chris@49: if(A_n_cols != B_n_rows) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A.n_rows, A_n_cols, B_n_rows, B.n_cols, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: //! stop if given matrices are incompatible for multiplication Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_mul_size(const Mat& A, const Mat& B, const bool do_trans_A, const bool do_trans_B, const char* x) Chris@49: { Chris@49: const uword final_A_n_cols = (do_trans_A == false) ? A.n_cols : A.n_rows; Chris@49: const uword final_B_n_rows = (do_trans_B == false) ? B.n_rows : B.n_cols; Chris@49: Chris@49: if(final_A_n_cols != final_B_n_rows) Chris@49: { Chris@49: const uword final_A_n_rows = (do_trans_A == false) ? A.n_rows : A.n_cols; Chris@49: const uword final_B_n_cols = (do_trans_B == false) ? B.n_cols : B.n_rows; Chris@49: Chris@49: arma_stop( arma_incompat_size_string(final_A_n_rows, final_A_n_cols, final_B_n_rows, final_B_n_cols, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_trans_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) Chris@49: { Chris@49: const uword final_A_n_cols = (do_trans_A == false) ? A_n_cols : A_n_rows; Chris@49: const uword final_B_n_rows = (do_trans_B == false) ? B_n_rows : B_n_cols; Chris@49: Chris@49: if(final_A_n_cols != final_B_n_rows) Chris@49: { Chris@49: const uword final_A_n_rows = (do_trans_A == false) ? A_n_rows : A_n_cols; Chris@49: const uword final_B_n_cols = (do_trans_B == false) ? B_n_cols : B_n_rows; Chris@49: Chris@49: arma_stop( arma_incompat_size_string(final_A_n_rows, final_A_n_cols, final_B_n_rows, final_B_n_cols, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_mul_size(const Mat& A, const subview& B, const char* x) Chris@49: { Chris@49: if(A.n_cols != B.n_rows) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A.n_rows, A.n_cols, B.n_rows, B.n_cols, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_mul_size(const subview& A, const Mat& B, const char* x) Chris@49: { Chris@49: if(A.n_cols != B.n_rows) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A.n_rows, A.n_cols, B.n_rows, B.n_cols, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: template Chris@49: arma_hot Chris@49: inline Chris@49: void Chris@49: arma_assert_mul_size(const subview& A, const subview& B, const char* x) Chris@49: { Chris@49: if(A.n_cols != B.n_rows) Chris@49: { Chris@49: arma_stop( arma_incompat_size_string(A.n_rows, A.n_cols, B.n_rows, B.n_cols, x) ); Chris@49: } Chris@49: } Chris@49: Chris@49: Chris@49: Chris@49: // Chris@49: // macros Chris@49: Chris@49: Chris@49: #define ARMA_STRING1(x) #x Chris@49: #define ARMA_STRING2(x) ARMA_STRING1(x) Chris@49: #define ARMA_FILELINE __FILE__ ": " ARMA_STRING2(__LINE__) Chris@49: Chris@49: Chris@49: #if defined (__GNUG__) Chris@49: #define ARMA_FNSIG __PRETTY_FUNCTION__ Chris@49: #elif defined (_MSC_VER) Chris@49: #define ARMA_FNSIG __FUNCSIG__ Chris@49: #elif defined (ARMA_USE_BOOST) Chris@49: #define ARMA_FNSIG BOOST_CURRENT_FUNCTION Chris@49: #elif defined (ARMA_USE_CXX11) Chris@49: #define ARMA_FNSIG __func__ Chris@49: #else Chris@49: #define ARMA_FNSIG "(unknown)" Chris@49: #endif Chris@49: Chris@49: Chris@49: Chris@49: #if !defined(ARMA_NO_DEBUG) && !defined(NDEBUG) Chris@49: Chris@49: #define arma_debug_print arma_print Chris@49: #define arma_debug_warn arma_warn Chris@49: #define arma_debug_check arma_check Chris@49: #define arma_debug_set_error arma_set_error Chris@49: #define arma_debug_assert_same_size arma_assert_same_size Chris@49: #define arma_debug_assert_mul_size arma_assert_mul_size Chris@49: #define arma_debug_assert_trans_mul_size arma_assert_trans_mul_size Chris@49: #define arma_debug_assert_cube_as_mat arma_assert_cube_as_mat Chris@49: Chris@49: #else Chris@49: Chris@49: #undef ARMA_EXTRA_DEBUG Chris@49: Chris@49: #define arma_debug_print true ? (void)0 : arma_print Chris@49: #define arma_debug_warn true ? (void)0 : arma_warn Chris@49: #define arma_debug_check true ? (void)0 : arma_check Chris@49: #define arma_debug_set_error true ? (void)0 : arma_set_error Chris@49: #define arma_debug_assert_same_size true ? (void)0 : arma_assert_same_size Chris@49: #define arma_debug_assert_mul_size true ? (void)0 : arma_assert_mul_size Chris@49: #define arma_debug_assert_trans_mul_size true ? (void)0 : arma_assert_trans_mul_size Chris@49: #define arma_debug_assert_cube_as_mat true ? (void)0 : arma_assert_cube_as_mat Chris@49: Chris@49: #endif Chris@49: Chris@49: Chris@49: Chris@49: #if defined(ARMA_EXTRA_DEBUG) Chris@49: Chris@49: #define arma_extra_debug_sigprint arma_sigprint(ARMA_FNSIG); arma_bktprint Chris@49: #define arma_extra_debug_sigprint_this arma_sigprint(ARMA_FNSIG); arma_thisprint Chris@49: #define arma_extra_debug_print arma_print Chris@49: #define arma_extra_debug_warn arma_warn Chris@49: #define arma_extra_debug_check arma_check Chris@49: Chris@49: #else Chris@49: Chris@49: #define arma_extra_debug_sigprint true ? (void)0 : arma_bktprint Chris@49: #define arma_extra_debug_sigprint_this true ? (void)0 : arma_thisprint Chris@49: #define arma_extra_debug_print true ? (void)0 : arma_print Chris@49: #define arma_extra_debug_warn true ? (void)0 : arma_warn Chris@49: #define arma_extra_debug_check true ? (void)0 : arma_check Chris@49: Chris@49: #endif Chris@49: Chris@49: Chris@49: Chris@49: Chris@49: #if defined(ARMA_EXTRA_DEBUG) Chris@49: Chris@49: namespace junk Chris@49: { Chris@49: class arma_first_extra_debug_message Chris@49: { Chris@49: public: Chris@49: Chris@49: inline Chris@49: arma_first_extra_debug_message() Chris@49: { Chris@49: union Chris@49: { Chris@49: unsigned short a; Chris@49: unsigned char b[sizeof(unsigned short)]; Chris@49: } endian_test; Chris@49: Chris@49: endian_test.a = 1; Chris@49: Chris@49: const bool little_endian = (endian_test.b[0] == 1); Chris@49: const char* nickname = ARMA_VERSION_NAME; Chris@49: Chris@49: std::ostream& out = get_stream_err1(); Chris@49: Chris@49: out << "@ ---" << '\n'; Chris@49: out << "@ Armadillo " Chris@49: << arma_version::major << '.' << arma_version::minor << '.' << arma_version::patch Chris@49: << " (" << nickname << ")\n"; Chris@49: Chris@49: out << "@ arma_config::mat_prealloc = " << arma_config::mat_prealloc << " element(s)\n"; Chris@49: out << "@ arma_config::atlas = " << arma_config::atlas << '\n'; Chris@49: out << "@ arma_config::lapack = " << arma_config::lapack << '\n'; Chris@49: out << "@ arma_config::blas = " << arma_config::blas << '\n'; Chris@49: out << "@ arma_config::boost = " << arma_config::boost << '\n'; Chris@49: out << "@ arma_config::boost_date = " << arma_config::boost_date << '\n'; Chris@49: out << "@ arma_config::good_comp = " << arma_config::good_comp << '\n'; Chris@49: out << "@ arma_config::extra_code = " << arma_config::extra_code << '\n'; Chris@49: out << "@ sizeof(void*) = " << sizeof(void*) << '\n'; Chris@49: out << "@ sizeof(uword) = " << sizeof(uword) << '\n'; Chris@49: out << "@ sizeof(int) = " << sizeof(int) << '\n'; Chris@49: out << "@ sizeof(long) = " << sizeof(long) << '\n'; Chris@49: out << "@ sizeof(blas_int) = " << sizeof(blas_int) << '\n'; Chris@49: out << "@ little_endian = " << little_endian << '\n'; Chris@49: out << "@ ---" << std::endl; Chris@49: } Chris@49: Chris@49: }; Chris@49: Chris@49: static arma_first_extra_debug_message arma_first_extra_debug_message_run; Chris@49: } Chris@49: Chris@49: #endif Chris@49: Chris@49: Chris@49: Chris@49: //! @}