fn_diagvec.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_diagvec
00018 //! @{
00019 
00020 
00021 //! extract a diagonal from a matrix
00022 template<typename T1>
00023 arma_inline
00024 const Op<T1, op_diagvec>
00025 diagvec(const Base<typename T1::elem_type,T1>& X, const s32 diag_id = 0)
00026   {
00027   arma_extra_debug_sigprint();
00028   
00029   return Op<T1, op_diagvec>(X.get_ref(), ((diag_id < 0) ? -diag_id : diag_id), ((diag_id < 0) ? 1 : 0) );
00030   }
00031 
00032 
00033 
00034 //! @}