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_sum
Chris@49: //! @{
Chris@49: 
Chris@49: 
Chris@49: //! \brief
Chris@49: //! Delayed sum of elements of a matrix along a specified dimension (either rows or columns).
Chris@49: //! The result is stored in a dense matrix that has either one column or one row.
Chris@49: //! For dim = 0, find the sum of each column (traverse across rows)
Chris@49: //! For dim = 1, find the sum of each row (traverse across columns)
Chris@49: //! The default is dim = 0.
Chris@49: //! NOTE: the dim argument is different than in Matlab/Octave.
Chris@49: 
Chris@49: template<typename T1>
Chris@49: arma_inline
Chris@49: const Op<T1, op_sum>
Chris@49: sum
Chris@49:   (
Chris@49:   const T1& X,
Chris@49:   const uword dim = 0,
Chris@49:   const typename enable_if< is_arma_type<T1>::value       == true  >::result* junk1 = 0,
Chris@49:   const typename enable_if< resolves_to_vector<T1>::value == false >::result* junk2 = 0
Chris@49:   )
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   arma_ignore(junk1);
Chris@49:   arma_ignore(junk2);
Chris@49:   
Chris@49:   return Op<T1, op_sum>(X, dim, 0);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename T1>
Chris@49: arma_inline
Chris@49: const Op<T1, op_sum>
Chris@49: sum
Chris@49:   (
Chris@49:   const T1& X,
Chris@49:   const uword dim,
Chris@49:   const typename enable_if< resolves_to_vector<T1>::value == true >::result* junk = 0
Chris@49:   )
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   arma_ignore(junk);
Chris@49:   
Chris@49:   return Op<T1, op_sum>(X, dim, 0);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! \brief
Chris@49: //! Immediate 'sum all values' operation for expressions which resolve to a vector 
Chris@49: template<typename T1>
Chris@49: inline
Chris@49: arma_warn_unused
Chris@49: typename T1::elem_type
Chris@49: sum
Chris@49:   (
Chris@49:   const T1& X,
Chris@49:   const arma_empty_class junk1 = arma_empty_class(),
Chris@49:   const typename enable_if< resolves_to_vector<T1>::value == true >::result* junk2 = 0
Chris@49:   )
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   arma_ignore(junk1);
Chris@49:   arma_ignore(junk2);
Chris@49:   
Chris@49:   return accu(X);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! \brief
Chris@49: //! Immediate 'sum all values' operation,
Chris@49: //! invoked, for example, by: sum(sum(A))
Chris@49: 
Chris@49: template<typename T1>
Chris@49: inline
Chris@49: arma_warn_unused
Chris@49: typename T1::elem_type
Chris@49: sum(const Op<T1, op_sum>& in)
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   arma_extra_debug_print("sum(): two consecutive sum() calls detected");
Chris@49:   
Chris@49:   return accu(in.m);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename T1>
Chris@49: arma_inline
Chris@49: const Op<Op<T1, op_sum>, op_sum>
Chris@49: sum(const Op<T1, op_sum>& in, const uword dim)
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   
Chris@49:   return Op<Op<T1, op_sum>, op_sum>(in, dim, 0);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename T>
Chris@49: arma_inline
Chris@49: arma_warn_unused
Chris@49: const typename arma_scalar_only<T>::result &
Chris@49: sum(const T& x)
Chris@49:   {
Chris@49:   return x;
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! sum of sparse object
Chris@49: template<typename T1>
Chris@49: inline
Chris@49: typename
Chris@49: enable_if2
Chris@49:   <
Chris@49:   (is_arma_sparse_type<T1>::value == true) && (resolves_to_sparse_vector<T1>::value == true),
Chris@49:   typename T1::elem_type
Chris@49:   >::result
Chris@49: sum(const T1& x)
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   
Chris@49:   // sum elements
Chris@49:   return accu(x);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename T1>
Chris@49: inline
Chris@49: typename
Chris@49: enable_if2
Chris@49:   <
Chris@49:   (is_arma_sparse_type<T1>::value == true) && (resolves_to_sparse_vector<T1>::value == false),
Chris@49:   const SpOp<T1,spop_sum>
Chris@49:   >::result
Chris@49: sum(const T1& x, const uword dim = 0)
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   
Chris@49:   return SpOp<T1,spop_sum>(x, dim, 0);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename T1>
Chris@49: inline
Chris@49: arma_warn_unused
Chris@49: typename T1::elem_type
Chris@49: sum(const SpOp<T1, spop_sum>& in)
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   arma_extra_debug_print("sum(): two consecutive sum() calls detected");
Chris@49:   
Chris@49:   return accu(in.m);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename T1>
Chris@49: arma_inline
Chris@49: const SpOp<SpOp<T1, spop_sum>, spop_sum>
Chris@49: sum(const SpOp<T1, spop_sum>& in, const uword dim)
Chris@49:   {
Chris@49:   arma_extra_debug_sigprint();
Chris@49:   
Chris@49:   return SpOp<SpOp<T1, spop_sum>, spop_sum>(in, dim, 0);
Chris@49:   }
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! @}