Chris@49: // Copyright (C) 2008-2012 NICTA (www.nicta.com.au)
Chris@49: // Copyright (C) 2008-2012 Conrad Sanderson
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_zeros
Chris@49: //! @{
Chris@49: 
Chris@49: 
Chris@49: //! Generate a vector with all elements set to zero
Chris@49: arma_inline
Chris@49: const Gen<vec, gen_zeros>
Chris@49: zeros(const uword n_elem)
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   
Chris@49:   return Gen<vec, gen_zeros>(n_elem, 1);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename obj_type>
Chris@49: arma_inline
Chris@49: const Gen<obj_type, gen_zeros>
Chris@49: zeros(const uword n_elem, const arma_empty_class junk1 = arma_empty_class(), const typename arma_Mat_Col_Row_only<obj_type>::result* junk2 = 0)
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   arma_ignore(junk1);
Chris@49:   arma_ignore(junk2);
Chris@49:   
Chris@49:   if(is_Row<obj_type>::value == true)
Chris@49:     {
Chris@49:     return Gen<obj_type, gen_zeros>(1, n_elem);
Chris@49:     }
Chris@49:   else
Chris@49:     {
Chris@49:     return Gen<obj_type, gen_zeros>(n_elem, 1);
Chris@49:     }
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! Generate a dense matrix with all elements set to zero
Chris@49: arma_inline
Chris@49: const Gen<mat, gen_zeros>
Chris@49: zeros(const uword n_rows, const uword n_cols)
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   
Chris@49:   return Gen<mat, gen_zeros>(n_rows, n_cols);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename obj_type>
Chris@49: arma_inline
Chris@49: const Gen<obj_type, gen_zeros>
Chris@49: zeros(const uword n_rows, const uword n_cols, const typename arma_Mat_Col_Row_only<obj_type>::result* junk = 0)
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   arma_ignore(junk);
Chris@49:   
Chris@49:   if(is_Col<obj_type>::value == true)
Chris@49:     {
Chris@49:     arma_debug_check( (n_cols != 1), "zeros(): incompatible size" );
Chris@49:     }
Chris@49:   else
Chris@49:   if(is_Row<obj_type>::value == true)
Chris@49:     {
Chris@49:     arma_debug_check( (n_rows != 1), "zeros(): incompatible size" );
Chris@49:     }
Chris@49:   
Chris@49:   return Gen<obj_type, gen_zeros>(n_rows, n_cols);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: arma_inline
Chris@49: const GenCube<cube::elem_type, gen_zeros>
Chris@49: zeros(const uword n_rows, const uword n_cols, const uword n_slices)
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   
Chris@49:   return GenCube<cube::elem_type, gen_zeros>(n_rows, n_cols, n_slices);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename cube_type>
Chris@49: arma_inline
Chris@49: const GenCube<typename cube_type::elem_type, gen_zeros>
Chris@49: zeros(const uword n_rows, const uword n_cols, const uword n_slices, const typename arma_Cube_only<cube_type>::result* junk = 0)
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   arma_ignore(junk);
Chris@49:   
Chris@49:   return GenCube<typename cube_type::elem_type, gen_zeros>(n_rows, n_cols, n_slices);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! @}