Chris@49: // Copyright (C) 2009-2010 NICTA (www.nicta.com.au)
Chris@49: // Copyright (C) 2009-2010 Conrad Sanderson
Chris@49: // Copyright (C) 2009-2010 Dimitrios Bouzas
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: 
Chris@49: //! \addtogroup fn_shuffle
Chris@49: //! @{
Chris@49: 
Chris@49: //! \brief
Chris@49: //! Shuffle the rows or the columns of a matrix or vector in random fashion.
Chris@49: //! If dim = 0, shuffle the columns (default operation).
Chris@49: //! If dim = 1, shuffle the rows.
Chris@49: 
Chris@49: template<typename T1>
Chris@49: inline
Chris@49: const Op<T1, op_shuffle>
Chris@49: shuffle(const Base<typename T1::elem_type,T1>& X, const uword dim = 0)
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   
Chris@49:   arma_debug_check( (dim > 1), "shuffle(): dim must be 0 or 1");
Chris@49:   
Chris@49:   return Op<T1, op_shuffle>(X.get_ref(), dim, 0);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! @}