Fn_var


Functions

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

Function Documentation

template<typename T1 >
Mat<typename T1::pod_type> var ( 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_var.hpp.

References op_var::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_var::apply(out, A, norm_type, dim);
00042   
00043   return out;
00044   }

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

Immediate 'find the variance of a row vector' operation.

Definition at line 52 of file fn_var.hpp.

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

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

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

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

Definition at line 67 of file fn_var.hpp.

References op_var::direct_var().

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

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

Immediate 'find the variance of a column vector' operation.

Definition at line 82 of file fn_var.hpp.

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

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

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

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

Definition at line 97 of file fn_var.hpp.

References op_var::direct_var().

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

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

Definition at line 111 of file fn_var.hpp.

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

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

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

Definition at line 125 of file fn_var.hpp.

References op_var::direct_var().

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

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

Definition at line 139 of file fn_var.hpp.

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

00140   {
00141   arma_extra_debug_sigprint();
00142   
00143   arma_debug_check( (A.n_elem == 0), "var(): given vector has no elements" );
00144   
00145   return op_var::direct_var(A, norm_type);
00146   }

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

Definition at line 153 of file fn_var.hpp.

References op_var::direct_var().

00154   {
00155   arma_extra_debug_sigprint();
00156   
00157   arma_debug_check( (A.n_elem == 0), "var(): given vector has no elements" );
00158   
00159   return op_var::direct_var(A, norm_type);
00160   }

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

Definition at line 167 of file fn_var.hpp.

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

00168   {
00169   arma_extra_debug_sigprint();
00170   
00171   arma_debug_check( (A.n_elem == 0), "var(): given vector has no elements" );
00172   
00173   return op_var::direct_var(A, norm_type);
00174   }

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

Definition at line 181 of file fn_var.hpp.

References op_var::direct_var().

00182   {
00183   arma_extra_debug_sigprint();
00184   
00185   arma_debug_check( (A.n_elem == 0), "var(): given vector has no elements" );
00186   
00187   return op_var::direct_var(A, norm_type);
00188   }