Fn_sum


Functions

template<typename T1 >
const Op< T1, op_sumsum (const Base< typename T1::elem_type, T1 > &X, const u32 dim=0)
 Delayed sum of elements of a matrix along a specified dimension (either rows or columns). The result is stored in a dense matrix that has either one column or one row. For dim = 0, find the sum of each column. For dim = 1, find the sum of each row. The default is dim = 0. NOTE: this function works differently than in Matlab/Octave.
template<typename eT >
eT sum (const Row< eT > &X)
 Immediate 'sum all values' operation for a row vector.
template<typename eT >
eT sum (const Col< eT > &X)
 Immediate 'sum all values' operation for a column vector.
template<typename T1 >
T1::elem_type sum (const Op< T1, op_sum > &in)
 Immediate 'sum all values' operation, invoked, for example, by: sum(sum(A)).
template<typename T1 >
const Op< Op< T1, op_sum >
, op_sum
sum (const Op< T1, op_sum > &in, const u32 dim)
template<typename eT >
eT sum (const subview_row< eT > &X)
 sum all values of a subview_row
template<typename eT >
eT sum (const subview_col< eT > &X)
 sum all values of a subview_col
template<typename eT >
eT sum (const diagview< eT > &X)
 sum all values of a diagview

Function Documentation

template<typename T1 >
const Op<T1, op_sum> sum ( const Base< typename T1::elem_type, T1 > &  X,
const u32  dim = 0 
) [inline]

Delayed sum of elements of a matrix along a specified dimension (either rows or columns). The result is stored in a dense matrix that has either one column or one row. For dim = 0, find the sum of each column. For dim = 1, find the sum of each row. The default is dim = 0. NOTE: this function works differently than in Matlab/Octave.

Definition at line 31 of file fn_sum.hpp.

References Base< elem_type, derived >::get_ref().

Referenced by diskio::gen_tmp_name().

00032   {
00033   arma_extra_debug_sigprint();
00034   
00035   return Op<T1, op_sum>(X.get_ref(), dim, 0);
00036   }

template<typename eT >
eT sum ( const Row< eT > &  X  )  [inline]

Immediate 'sum all values' operation for a row vector.

Definition at line 44 of file fn_sum.hpp.

References accu().

00045   {
00046   arma_extra_debug_sigprint();
00047   
00048   return accu(X);
00049   }

template<typename eT >
eT sum ( const Col< eT > &  X  )  [inline]

Immediate 'sum all values' operation for a column vector.

Definition at line 58 of file fn_sum.hpp.

References accu().

00059   {
00060   arma_extra_debug_sigprint();
00061   
00062   return accu(X);
00063   }

template<typename T1 >
T1::elem_type sum ( const Op< T1, op_sum > &  in  )  [inline]

Immediate 'sum all values' operation, invoked, for example, by: sum(sum(A)).

Definition at line 74 of file fn_sum.hpp.

References accu(), and Op< T1, op_type >::m.

00075   {
00076   arma_extra_debug_sigprint();
00077   arma_extra_debug_print("sum(): two consecutive sum() calls detected");
00078   
00079   return accu(in.m);
00080   }

template<typename T1 >
const Op<Op<T1, op_sum>, op_sum> sum ( const Op< T1, op_sum > &  in,
const u32  dim 
) [inline]

Definition at line 87 of file fn_sum.hpp.

00088   {
00089   arma_extra_debug_sigprint();
00090   
00091   return Op<Op<T1, op_sum>, op_sum>(in, dim, 0);
00092   }

template<typename eT >
eT sum ( const subview_row< eT > &  X  )  [inline]

sum all values of a subview_row

Definition at line 100 of file fn_sum.hpp.

References accu().

00101   {
00102   arma_extra_debug_sigprint();
00103   
00104   return accu(X);
00105   }

template<typename eT >
eT sum ( const subview_col< eT > &  X  )  [inline]

sum all values of a subview_col

Definition at line 113 of file fn_sum.hpp.

References accu().

00114   {
00115   arma_extra_debug_sigprint();
00116   
00117   return accu(X);
00118   }

template<typename eT >
eT sum ( const diagview< eT > &  X  )  [inline]

sum all values of a diagview

Definition at line 126 of file fn_sum.hpp.

References accu().

00127   {
00128   arma_extra_debug_sigprint();
00129   
00130   return accu(X);
00131   }