fn_htrans.hpp

Go to the documentation of this file.
00001 // Copyright (C) 2010 NICTA and the authors listed below
00002 // http://nicta.com.au
00003 // 
00004 // Authors:
00005 // - Conrad Sanderson (conradsand at ieee dot org)
00006 // 
00007 // This file is part of the Armadillo C++ library.
00008 // It is provided without any warranty of fitness
00009 // for any purpose. You can redistribute this file
00010 // and/or modify it under the terms of the GNU
00011 // Lesser General Public License (LGPL) as published
00012 // by the Free Software Foundation, either version 3
00013 // of the License or (at your option) any later version.
00014 // (see http://www.opensource.org/licenses for more info)
00015 
00016 
00017 //! \addtogroup fn_htrans
00018 //! @{
00019 
00020 
00021 
00022 template<typename T1>
00023 arma_inline
00024 const Op<T1, op_htrans>
00025 htrans(const Base<std::complex<typename T1::pod_type>,T1>& X)
00026   {
00027   arma_extra_debug_sigprint();
00028   
00029   return Op<T1, op_htrans>(X.get_ref());
00030   }
00031 
00032 
00033 
00034 template<typename T1>
00035 arma_inline
00036 const Op<T1, op_trans>
00037 htrans(const Base<typename T1::pod_type,T1>& X)
00038   {
00039   arma_extra_debug_sigprint();
00040   arma_extra_debug_print("htrans(): non-complex object given -- using regular transpose");
00041   
00042   return Op<T1, op_trans>(X.get_ref());
00043   }
00044 
00045 
00046 
00047 //! two consecutive hermitian transpose operations cancel each other
00048 template<typename T1>
00049 arma_inline
00050 const T1&
00051 htrans(const Op<T1, op_htrans>& X)
00052   {
00053   arma_extra_debug_sigprint();
00054   arma_extra_debug_print("htrans(): removing op_htrans");
00055   
00056   return X.m;
00057   }
00058 
00059 
00060 
00061 //! @}