Chris@49: // Copyright (C) 2012 Conrad Sanderson
Chris@49: // Copyright (C) 2012 Ryan Curtin
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 fn_speye
Chris@49: //! @{
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! Generate a sparse matrix with the values along the main diagonal set to one
Chris@49: template<typename obj_type>
Chris@49: inline
Chris@49: obj_type
Chris@49: speye(const uword n_rows, const uword n_cols, const typename arma_SpMat_SpCol_SpRow_only<obj_type>::result* junk = NULL)
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   arma_ignore(junk);
Chris@49:   
Chris@49:   obj_type out;
Chris@49:   
Chris@49:   out.eye(n_rows, n_cols);
Chris@49:   
Chris@49:   return out;
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: // Convenience shortcut method (no template parameter necessary)
Chris@49: inline
Chris@49: sp_mat
Chris@49: speye(const uword n_rows, const uword n_cols)
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   
Chris@49:   sp_mat out;
Chris@49:   
Chris@49:   out.eye(n_rows, n_cols);
Chris@49:   
Chris@49:   return out;
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! @}