annotate armadillo-2.4.4/include/armadillo_bits/fn_stddev.hpp @ 18:8d046a9d36aa slimline

Back out rev 13:ac07c60aa798. Like an idiot, I committed a whole pile of unrelated changes in the guise of a single typo fix. Will re-commit in stages
author Chris Cannam
date Thu, 10 May 2012 10:45:44 +0100
parents 8b6102e2a9b0
children
rev   line source
max@0 1 // Copyright (C) 2009-2011 NICTA (www.nicta.com.au)
max@0 2 // Copyright (C) 2009-2011 Conrad Sanderson
max@0 3 //
max@0 4 // This file is part of the Armadillo C++ library.
max@0 5 // It is provided without any warranty of fitness
max@0 6 // for any purpose. You can redistribute this file
max@0 7 // and/or modify it under the terms of the GNU
max@0 8 // Lesser General Public License (LGPL) as published
max@0 9 // by the Free Software Foundation, either version 3
max@0 10 // of the License or (at your option) any later version.
max@0 11 // (see http://www.opensource.org/licenses for more info)
max@0 12
max@0 13
max@0 14 //! \addtogroup fn_stddev
max@0 15 //! @{
max@0 16
max@0 17
max@0 18
max@0 19 template<typename T1>
max@0 20 inline
max@0 21 const mtOp<typename T1::pod_type, T1, op_stddev>
max@0 22 stddev(const Base<typename T1::elem_type,T1>& X, const uword norm_type = 0, const uword dim = 0)
max@0 23 {
max@0 24 arma_extra_debug_sigprint();
max@0 25
max@0 26 return mtOp<typename T1::pod_type, T1, op_stddev>(X.get_ref(), norm_type, dim);
max@0 27 }
max@0 28
max@0 29
max@0 30
max@0 31 //! Immediate 'find the standard deviation of a row vector' operation
max@0 32 template<typename eT>
max@0 33 inline
max@0 34 arma_warn_unused
max@0 35 typename get_pod_type<eT>::result
max@0 36 stddev(const Row<eT>& A, const uword norm_type = 0)
max@0 37 {
max@0 38 arma_extra_debug_sigprint();
max@0 39
max@0 40 const uword A_n_elem = A.n_elem;
max@0 41
max@0 42 arma_debug_check( (A_n_elem == 0), "stddev(): given object has no elements" );
max@0 43
max@0 44 return std::sqrt( op_var::direct_var(A.mem, A_n_elem, norm_type) );
max@0 45 }
max@0 46
max@0 47
max@0 48
max@0 49 //! Immediate 'find the standard deviation of a column vector' operation
max@0 50 template<typename eT>
max@0 51 inline
max@0 52 arma_warn_unused
max@0 53 typename get_pod_type<eT>::result
max@0 54 stddev(const Col<eT>& A, const uword norm_type = 0)
max@0 55 {
max@0 56 arma_extra_debug_sigprint();
max@0 57
max@0 58 const uword A_n_elem = A.n_elem;
max@0 59
max@0 60 arma_debug_check( (A_n_elem == 0), "stddev(): given object has no elements" );
max@0 61
max@0 62 return std::sqrt( op_var::direct_var(A.mem, A_n_elem, norm_type) );
max@0 63 }
max@0 64
max@0 65
max@0 66
max@0 67 //! find the standard deviation of a subview_row
max@0 68 template<typename eT>
max@0 69 inline
max@0 70 arma_warn_unused
max@0 71 typename get_pod_type<eT>::result
max@0 72 stddev(const subview_row<eT>& A, const uword norm_type = 0)
max@0 73 {
max@0 74 arma_extra_debug_sigprint();
max@0 75
max@0 76 arma_debug_check( (A.n_elem == 0), "stddev(): given object has no elements" );
max@0 77
max@0 78 return std::sqrt( op_var::direct_var(A, norm_type) );
max@0 79 }
max@0 80
max@0 81
max@0 82
max@0 83 //! find the standard deviation of a subview_col
max@0 84 template<typename eT>
max@0 85 inline
max@0 86 arma_warn_unused
max@0 87 typename get_pod_type<eT>::result
max@0 88 stddev(const subview_col<eT>& A, const uword norm_type = 0)
max@0 89 {
max@0 90 arma_extra_debug_sigprint();
max@0 91
max@0 92 arma_debug_check( (A.n_elem == 0), "stddev(): given object has no elements" );
max@0 93
max@0 94 return std::sqrt( op_var::direct_var(A.colptr(0), A.n_rows, norm_type) );
max@0 95 }
max@0 96
max@0 97
max@0 98
max@0 99 //! find the standard deviation of a diagview
max@0 100 template<typename eT>
max@0 101 inline
max@0 102 arma_warn_unused
max@0 103 typename get_pod_type<eT>::result
max@0 104 stddev(const diagview<eT>& A, const uword norm_type = 0)
max@0 105 {
max@0 106 arma_extra_debug_sigprint();
max@0 107
max@0 108 arma_debug_check( (A.n_elem == 0), "stddev(): given object has no elements" );
max@0 109
max@0 110 return std::sqrt( op_var::direct_var(A, norm_type) );
max@0 111 }
max@0 112
max@0 113
max@0 114
max@0 115 template<typename eT, typename T1>
max@0 116 inline
max@0 117 arma_warn_unused
max@0 118 typename get_pod_type<eT>::result
max@0 119 stddev(const subview_elem1<eT,T1>& A, const uword norm_type = 0)
max@0 120 {
max@0 121 arma_extra_debug_sigprint();
max@0 122
max@0 123 const Col<eT> X(A);
max@0 124
max@0 125 return stddev(X, norm_type);
max@0 126 }
max@0 127
max@0 128
max@0 129
max@0 130 //! @}