max@0: // Copyright (C) 2008-2011 NICTA (www.nicta.com.au)
max@0: // Copyright (C) 2008-2011 Conrad Sanderson
max@0: // 
max@0: // This file is part of the Armadillo C++ library.
max@0: // It is provided without any warranty of fitness
max@0: // for any purpose. You can redistribute this file
max@0: // and/or modify it under the terms of the GNU
max@0: // Lesser General Public License (LGPL) as published
max@0: // by the Free Software Foundation, either version 3
max@0: // of the License or (at your option) any later version.
max@0: // (see http://www.opensource.org/licenses for more info)
max@0: 
max@0: 
max@0: //! \addtogroup fn_elem
max@0: //! @{
max@0: 
max@0: 
max@0: 
max@0: //
max@0: // find
max@0: 
max@0: template<typename eT, typename T1>
max@0: inline
max@0: const mtOp<uword, T1, op_find>
max@0: find(const Base<eT,T1>& X, const uword k = 0, const char* direction = "first")
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   const char sig = direction[0];
max@0:   
max@0:   arma_debug_check
max@0:     (
max@0:     (sig != 'f' && sig != 'F' && sig != 'l' && sig != 'L'),
max@0:     "find(): 3rd input argument must be \"first\" or \"last\""
max@0:     );
max@0:   
max@0:   const uword type = (sig == 'f' || sig == 'F') ? 0 : 1;
max@0:   
max@0:   return mtOp<uword, T1, op_find>(X.get_ref(), k, type);
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: //
max@0: // real
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const T1&
max@0: real(const Base<typename T1::pod_type, T1>& X)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return X.get_ref();
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const T1&
max@0: real(const BaseCube<typename T1::pod_type, T1>& X)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return X.get_ref();
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: inline
max@0: const mtOp<typename T1::pod_type, T1, op_real>
max@0: real(const Base<std::complex<typename T1::pod_type>, T1>& X)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return mtOp<typename T1::pod_type, T1, op_real>( X.get_ref() );
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: inline
max@0: const mtOpCube<typename T1::pod_type, T1, op_real>
max@0: real(const BaseCube<std::complex<typename T1::pod_type>, T1>& X)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return mtOpCube<typename T1::pod_type, T1, op_real>( X.get_ref() );
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: //
max@0: // imag
max@0: 
max@0: template<typename T1>
max@0: inline
max@0: const Gen<typename T1::pod_type, gen_zeros>
max@0: imag(const Base<typename T1::pod_type,T1>& X)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   const Proxy<T1> A(X.get_ref());
max@0:   
max@0:   return Gen<typename T1::pod_type, gen_zeros>(A.get_n_rows(), A.get_n_cols());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: inline
max@0: const GenCube<typename T1::pod_type, gen_zeros>
max@0: imag(const BaseCube<typename T1::pod_type,T1>& X)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   const ProxyCube<T1> A(X.get_ref());
max@0:   
max@0:   return GenCube<typename T1::pod_type, gen_zeros>(A.get_n_rows(), A.get_n_cols(), A.get_n_slices());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: inline
max@0: const mtOp<typename T1::pod_type, T1, op_imag>
max@0: imag(const Base<std::complex<typename T1::pod_type>, T1>& X)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return mtOp<typename T1::pod_type, T1, op_imag>( X.get_ref() );
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: inline
max@0: const mtOpCube<typename T1::pod_type, T1, op_imag>
max@0: imag(const BaseCube<std::complex<typename T1::pod_type>,T1>& X)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return mtOpCube<typename T1::pod_type, T1, op_imag>( X.get_ref() );
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: //
max@0: // log
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOp<T1, eop_log>
max@0: log(const Base<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOp<T1, eop_log>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOpCube<T1, eop_log>
max@0: log(const BaseCube<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOpCube<T1, eop_log>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: //
max@0: // log2
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOp<T1, eop_log2>
max@0: log2(const Base<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOp<T1, eop_log2>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOpCube<T1, eop_log2>
max@0: log2(const BaseCube<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOpCube<T1, eop_log2>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: //
max@0: // log10
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOp<T1, eop_log10>
max@0: log10(const Base<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOp<T1, eop_log10>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOpCube<T1, eop_log10>
max@0: log10(const BaseCube<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOpCube<T1, eop_log10>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: //
max@0: // exp
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOp<T1, eop_exp>
max@0: exp(const Base<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOp<T1, eop_exp>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOpCube<T1, eop_exp>
max@0: exp(const BaseCube<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOpCube<T1, eop_exp>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: // exp2
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOp<T1, eop_exp2>
max@0: exp2(const Base<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOp<T1, eop_exp2>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOpCube<T1, eop_exp2>
max@0: exp2(const BaseCube<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOpCube<T1, eop_exp2>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: // exp10
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOp<T1, eop_exp10>
max@0: exp10(const Base<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOp<T1, eop_exp10>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOpCube<T1, eop_exp10>
max@0: exp10(const BaseCube<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOpCube<T1, eop_exp10>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: //
max@0: // abs
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOp<T1, eop_abs>
max@0: abs(const Base<typename T1::elem_type,T1>& X, const typename arma_not_cx<typename T1::elem_type>::result* junk = 0)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   arma_ignore(junk);
max@0:   
max@0:   return eOp<T1, eop_abs>(X.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOpCube<T1, eop_abs>
max@0: abs(const BaseCube<typename T1::elem_type,T1>& X, const typename arma_not_cx<typename T1::elem_type>::result* junk = 0)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   arma_ignore(junk);
max@0:   
max@0:   return eOpCube<T1, eop_abs>(X.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: inline
max@0: const mtOp<typename T1::pod_type, T1, op_abs>
max@0: abs(const Base<std::complex<typename T1::pod_type>, T1>& X, const typename arma_cx_only<typename T1::elem_type>::result* junk = 0)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   arma_ignore(junk);
max@0:   
max@0:   return mtOp<typename T1::pod_type, T1, op_abs>( X.get_ref() );
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: inline
max@0: const mtOpCube<typename T1::pod_type, T1, op_abs>
max@0: abs(const BaseCube< std::complex<typename T1::pod_type>,T1>& X, const typename arma_cx_only<typename T1::elem_type>::result* junk = 0)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   arma_ignore(junk);
max@0:   
max@0:   return mtOpCube<typename T1::pod_type, T1, op_abs>( X.get_ref() );
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: //
max@0: // square
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOp<T1, eop_square>
max@0: square(const Base<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOp<T1, eop_square>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOpCube<T1, eop_square>
max@0: square(const BaseCube<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOpCube<T1, eop_square>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: //
max@0: // sqrt
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOp<T1, eop_sqrt>
max@0: sqrt(const Base<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOp<T1, eop_sqrt>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOpCube<T1, eop_sqrt>
max@0: sqrt(const BaseCube<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOpCube<T1, eop_sqrt>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: //
max@0: // conj
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const T1&
max@0: conj(const Base<typename T1::pod_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0: 
max@0:   return A.get_ref();
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const T1&
max@0: conj(const BaseCube<typename T1::pod_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0: 
max@0:   return A.get_ref();
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOp<T1, eop_conj>
max@0: conj(const Base<std::complex<typename T1::pod_type>,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0: 
max@0:   return eOp<T1, eop_conj>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOpCube<T1, eop_conj>
max@0: conj(const BaseCube<std::complex<typename T1::pod_type>,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0: 
max@0:   return eOpCube<T1, eop_conj>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const T1&
max@0: conj(const eOp<T1, eop_conj>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return A.m;
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const T1&
max@0: conj(const eOpCube<T1, eop_conj>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return A.m;
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: // TODO: this needs a more elaborate template restriction mechanism to work properly,
max@0: //       i.e. an overloaded version of thus function should do nothing if the input type is non-complex
max@0: // 
max@0: // //! the conjugate of the transpose of a complex matrix is the same as the hermitian transpose
max@0: // template<typename T1>
max@0: // arma_inline
max@0: // const Op<T1, op_htrans>
max@0: // conj(const Op<T1, op_strans>& A)
max@0: //   {
max@0: //   arma_extra_debug_sigprint();
max@0: //   
max@0: //   return Op<T1, op_htrans>(A.m);
max@0: //   }
max@0: 
max@0: 
max@0: 
max@0: // pow
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOp<T1, eop_pow>
max@0: pow(const Base<typename T1::elem_type,T1>& A, const typename T1::elem_type exponent)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOp<T1, eop_pow>(A.get_ref(), exponent);
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOpCube<T1, eop_pow>
max@0: pow(const BaseCube<typename T1::elem_type,T1>& A, const typename T1::elem_type exponent)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOpCube<T1, eop_pow>(A.get_ref(), exponent);
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: // pow, specialised handling (non-complex exponent for complex matrices)
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOp<T1, eop_pow>
max@0: pow(const Base<typename T1::elem_type,T1>& A, const typename T1::elem_type::value_type exponent)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   typedef typename T1::elem_type eT;
max@0:   
max@0:   return eOp<T1, eop_pow>(A.get_ref(), eT(exponent));
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOpCube<T1, eop_pow>
max@0: pow(const BaseCube<typename T1::elem_type,T1>& A, const typename T1::elem_type::value_type exponent)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   typedef typename T1::elem_type eT;
max@0:   
max@0:   return eOpCube<T1, eop_pow>(A.get_ref(), eT(exponent));
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: //
max@0: // floor
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOp<T1, eop_floor>
max@0: floor(const Base<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOp<T1, eop_floor>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOpCube<T1, eop_floor>
max@0: floor(const BaseCube<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOpCube<T1, eop_floor>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: //
max@0: // ceil
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOp<T1, eop_ceil>
max@0: ceil(const Base<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOp<T1, eop_ceil>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: template<typename T1>
max@0: arma_inline
max@0: const eOpCube<T1, eop_ceil>
max@0: ceil(const BaseCube<typename T1::elem_type,T1>& A)
max@0:   {
max@0:   arma_extra_debug_sigprint();
max@0:   
max@0:   return eOpCube<T1, eop_ceil>(A.get_ref());
max@0:   }
max@0: 
max@0: 
max@0: 
max@0: //! @}