fn_diagmat.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_diagmat
00018 //! @{
00019 
00020 
00021 //! interpret a matrix or a vector as a diagonal matrix (i.e. off-diagonal entries are zero)
00022 // TODO: allow placement of vector onto a sub- or super- diagonal
00023 template<typename T1>
00024 arma_inline
00025 const Op<T1, op_diagmat>
00026 diagmat(const Base<typename T1::elem_type,T1>& X)
00027   {
00028   arma_extra_debug_sigprint();
00029   
00030   return Op<T1, op_diagmat>(X.get_ref());
00031   }
00032 
00033 
00034 
00035 //! @}