Fn_stddev


Functions

template<typename T1 >
Mat< typename T1::pod_type > stddev (const Base< typename T1::elem_type, T1 > &X, const u32 norm_type=0, const u32 dim=0)
template<typename eT >
eT stddev (const Row< eT > &A, const u32 norm_type=0)
 Immediate 'find the standard deviation of a row vector' operation.
template<typename T >
stddev (const Row< std::complex< T > > &A, const u32 norm_type=0)
 Immediate 'find the standard deviation of a row vector' operation (version for complex numbers).
template<typename eT >
eT stddev (const Col< eT > &A, const u32 norm_type=0)
 Immediate 'find the standard deviation of a column vector' operation.
template<typename T >
stddev (const Col< std::complex< T > > &A, const u32 norm_type=0)
 Immediate 'find the standard deviation of a column vector' operation (version for complex numbers).
template<typename eT >
eT stddev (const subview_row< eT > &A, const u32 norm_type=0)
 find the standard deviation of a subview_row
template<typename T >
stddev (const subview_row< std::complex< T > > &A, const u32 norm_type=0)
 find the standard deviation of a subview_row (version for complex numbers)
template<typename eT >
eT stddev (const subview_col< eT > &A, const u32 norm_type=0)
 find the standard deviation of a subview_col
template<typename T >
stddev (const subview_col< std::complex< T > > &A, const u32 norm_type=0)
 find the standard deviation of a subview_col (version for complex numbers)
template<typename eT >
eT stddev (const diagview< eT > &A, const u32 norm_type=0)
 find the standard deviation of a diagview
template<typename T >
stddev (const diagview< std::complex< T > > &A, const u32 norm_type=0)
 find the standard deviation of a diagview (version for complex numbers)

Function Documentation

template<typename T1 >
Mat<typename T1::pod_type> stddev ( const Base< typename T1::elem_type, T1 > &  X,
const u32  norm_type = 0,
const u32  dim = 0 
) [inline]

Definition at line 24 of file fn_stddev.hpp.

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

00025   {
00026   arma_extra_debug_sigprint();
00027   
00028   const unwrap<T1> A_tmp(X.get_ref());
00029 
00030   // if T1 is a complex matrix,
00031   // pod_type is the underlying type used by std::complex;
00032   // otherwise pod_type is the same as elem_type
00033   
00034   typedef typename T1::elem_type  in_eT;
00035   typedef typename T1::pod_type  out_eT;
00036 
00037   const Mat<in_eT>& A = A_tmp.M;
00038   
00039   Mat<out_eT> out;
00040   
00041   op_stddev::apply(out, A, norm_type, dim);
00042   
00043   return out;
00044   }

template<typename eT >
eT stddev ( const Row< eT > &  A,
const u32  norm_type = 0 
) [inline]

Immediate 'find the standard deviation of a row vector' operation.

Definition at line 52 of file fn_stddev.hpp.

References op_var::direct_var(), Mat< eT >::mem, Mat< eT >::n_elem, and sqrt().

00053   {
00054   arma_extra_debug_sigprint();
00055   
00056   arma_debug_check( (A.n_elem == 0), "var(): given vector has no elements" );
00057   
00058   return std::sqrt( op_var::direct_var(A.mem, A.n_elem, norm_type) );
00059   }

template<typename T >
T stddev ( const Row< std::complex< T > > &  A,
const u32  norm_type = 0 
) [inline]

Immediate 'find the standard deviation of a row vector' operation (version for complex numbers).

Definition at line 67 of file fn_stddev.hpp.

References op_var::direct_var(), and sqrt().

00068   {
00069   arma_extra_debug_sigprint();
00070   
00071   arma_debug_check( (A.n_elem == 0), "var(): given vector has no elements" );
00072   
00073   return std::sqrt( op_var::direct_var(A.mem, A.n_elem, norm_type) );
00074   }

template<typename eT >
eT stddev ( const Col< eT > &  A,
const u32  norm_type = 0 
) [inline]

Immediate 'find the standard deviation of a column vector' operation.

Definition at line 82 of file fn_stddev.hpp.

References op_var::direct_var(), Mat< eT >::mem, Mat< eT >::n_elem, and sqrt().

00083   {
00084   arma_extra_debug_sigprint();
00085   
00086   arma_debug_check( (A.n_elem == 0), "var(): given vector has no elements" );
00087   
00088   return std::sqrt( op_var::direct_var(A.mem, A.n_elem, norm_type) );
00089   }

template<typename T >
T stddev ( const Col< std::complex< T > > &  A,
const u32  norm_type = 0 
) [inline]

Immediate 'find the standard deviation of a column vector' operation (version for complex numbers).

Definition at line 97 of file fn_stddev.hpp.

References op_var::direct_var(), and sqrt().

00098   {
00099   arma_extra_debug_sigprint();
00100   
00101   arma_debug_check( (A.n_elem == 0), "var(): given vector has no elements" );
00102   
00103   return std::sqrt( op_var::direct_var(A.mem, A.n_elem, norm_type) );
00104   }

template<typename eT >
eT stddev ( const subview_row< eT > &  A,
const u32  norm_type = 0 
) [inline]

find the standard deviation of a subview_row

Definition at line 112 of file fn_stddev.hpp.

References op_var::direct_var(), subview< eT >::n_elem, and sqrt().

00113   {
00114   arma_extra_debug_sigprint();
00115   
00116   arma_debug_check( (A.n_elem == 0), "var(): given vector has no elements" );
00117   
00118   return std::sqrt( op_var::direct_var(A, norm_type) );
00119   }

template<typename T >
T stddev ( const subview_row< std::complex< T > > &  A,
const u32  norm_type = 0 
) [inline]

find the standard deviation of a subview_row (version for complex numbers)

Definition at line 127 of file fn_stddev.hpp.

References op_var::direct_var(), and sqrt().

00128   {
00129   arma_extra_debug_sigprint();
00130   
00131   arma_debug_check( (A.n_elem == 0), "var(): given vector has no elements" );
00132   
00133   return std::sqrt( op_var::direct_var(A, norm_type) );
00134   }

template<typename eT >
eT stddev ( const subview_col< eT > &  A,
const u32  norm_type = 0 
) [inline]

find the standard deviation of a subview_col

Definition at line 142 of file fn_stddev.hpp.

References op_var::direct_var(), subview< eT >::n_elem, and sqrt().

00143   {
00144   arma_extra_debug_sigprint();
00145   
00146   arma_debug_check( (A.n_elem == 0), "var(): given vector has no elements" );
00147   
00148   return std::sqrt( op_var::direct_var(A, norm_type) );
00149   }

template<typename T >
T stddev ( const subview_col< std::complex< T > > &  A,
const u32  norm_type = 0 
) [inline]

find the standard deviation of a subview_col (version for complex numbers)

Definition at line 157 of file fn_stddev.hpp.

References op_var::direct_var(), and sqrt().

00158   {
00159   arma_extra_debug_sigprint();
00160   
00161   arma_debug_check( (A.n_elem == 0), "var(): given vector has no elements" );
00162   
00163   return std::sqrt( op_var::direct_var(A, norm_type) );
00164   }

template<typename eT >
eT stddev ( const diagview< eT > &  A,
const u32  norm_type = 0 
) [inline]

find the standard deviation of a diagview

Definition at line 172 of file fn_stddev.hpp.

References op_var::direct_var(), diagview< eT >::n_elem, and sqrt().

00173   {
00174   arma_extra_debug_sigprint();
00175   
00176   arma_debug_check( (A.n_elem == 0), "var(): given vector has no elements" );
00177   
00178   return std::sqrt( op_var::direct_var(A, norm_type) );
00179   }

template<typename T >
T stddev ( const diagview< std::complex< T > > &  A,
const u32  norm_type = 0 
) [inline]

find the standard deviation of a diagview (version for complex numbers)

Definition at line 187 of file fn_stddev.hpp.

References op_var::direct_var(), and sqrt().

00188   {
00189   arma_extra_debug_sigprint();
00190   
00191   arma_debug_check( (A.n_elem == 0), "var(): given vector has no elements" );
00192   
00193   return std::sqrt( op_var::direct_var(A, norm_type) );
00194   }