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_mean
|
max@0
|
15 //! @{
|
max@0
|
16
|
max@0
|
17
|
max@0
|
18
|
max@0
|
19 template<typename T1>
|
max@0
|
20 arma_inline
|
max@0
|
21 const Op<T1, op_mean>
|
max@0
|
22 mean(const Base<typename T1::elem_type,T1>& X, const uword dim = 0)
|
max@0
|
23 {
|
max@0
|
24 arma_extra_debug_sigprint();
|
max@0
|
25
|
max@0
|
26 return Op<T1, op_mean>(X.get_ref(), dim, 0);
|
max@0
|
27 }
|
max@0
|
28
|
max@0
|
29
|
max@0
|
30
|
max@0
|
31 //! Immediate 'find the mean value of a row vector' operation
|
max@0
|
32 template<typename eT>
|
max@0
|
33 inline
|
max@0
|
34 arma_warn_unused
|
max@0
|
35 eT
|
max@0
|
36 mean(const Row<eT>& A)
|
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), "mean(): given object has no elements" );
|
max@0
|
43
|
max@0
|
44 return op_mean::direct_mean(A.mem, A_n_elem);
|
max@0
|
45 }
|
max@0
|
46
|
max@0
|
47
|
max@0
|
48
|
max@0
|
49 //! Immediate 'find the mean value of a column vector' operation
|
max@0
|
50 template<typename eT>
|
max@0
|
51 inline
|
max@0
|
52 arma_warn_unused
|
max@0
|
53 eT
|
max@0
|
54 mean(const Col<eT>& A)
|
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), "mean(): given object has no elements" );
|
max@0
|
61
|
max@0
|
62 return op_mean::direct_mean(A.mem, A_n_elem);
|
max@0
|
63 }
|
max@0
|
64
|
max@0
|
65
|
max@0
|
66
|
max@0
|
67 //! \brief
|
max@0
|
68 //! Immediate 'find mean value' operation,
|
max@0
|
69 //! invoked, for example, by: mean(mean(A))
|
max@0
|
70 template<typename T1>
|
max@0
|
71 inline
|
max@0
|
72 arma_warn_unused
|
max@0
|
73 typename T1::elem_type
|
max@0
|
74 mean(const Op<T1, op_mean>& in)
|
max@0
|
75 {
|
max@0
|
76 arma_extra_debug_sigprint();
|
max@0
|
77 arma_extra_debug_print("mean(): two consecutive mean() calls detected");
|
max@0
|
78
|
max@0
|
79 typedef typename T1::elem_type eT;
|
max@0
|
80
|
max@0
|
81 const unwrap<T1> tmp1(in.m);
|
max@0
|
82 const Mat<eT>& X = tmp1.M;
|
max@0
|
83
|
max@0
|
84 const uword X_n_elem = X.n_elem;
|
max@0
|
85
|
max@0
|
86 arma_debug_check( (X_n_elem == 0), "mean(): given object has no elements" );
|
max@0
|
87
|
max@0
|
88 return op_mean::direct_mean(X.mem, X_n_elem);
|
max@0
|
89 }
|
max@0
|
90
|
max@0
|
91
|
max@0
|
92
|
max@0
|
93 template<typename T1>
|
max@0
|
94 arma_inline
|
max@0
|
95 const Op< Op<T1, op_mean>, op_mean>
|
max@0
|
96 mean(const Op<T1, op_mean>& in, const uword dim)
|
max@0
|
97 {
|
max@0
|
98 arma_extra_debug_sigprint();
|
max@0
|
99
|
max@0
|
100 return Op< Op<T1, op_mean>, op_mean>(in, dim, 0);
|
max@0
|
101 }
|
max@0
|
102
|
max@0
|
103
|
max@0
|
104
|
max@0
|
105 template<typename eT>
|
max@0
|
106 inline
|
max@0
|
107 arma_warn_unused
|
max@0
|
108 eT
|
max@0
|
109 mean(const subview_row<eT>& A)
|
max@0
|
110 {
|
max@0
|
111 arma_extra_debug_sigprint();
|
max@0
|
112
|
max@0
|
113 arma_debug_check( (A.n_elem == 0), "mean(): given object has no elements" );
|
max@0
|
114
|
max@0
|
115 const eT mu = accu(A) / eT(A.n_cols);
|
max@0
|
116
|
max@0
|
117 return is_finite(mu) ? mu : op_mean::direct_mean_robust(A);
|
max@0
|
118 }
|
max@0
|
119
|
max@0
|
120
|
max@0
|
121
|
max@0
|
122 template<typename eT>
|
max@0
|
123 inline
|
max@0
|
124 arma_warn_unused
|
max@0
|
125 eT
|
max@0
|
126 mean(const subview_col<eT>& A)
|
max@0
|
127 {
|
max@0
|
128 arma_extra_debug_sigprint();
|
max@0
|
129
|
max@0
|
130 arma_debug_check( (A.n_elem == 0), "mean(): given object has no elements" );
|
max@0
|
131
|
max@0
|
132 return op_mean::direct_mean(A.colptr(0), A.n_rows);
|
max@0
|
133 }
|
max@0
|
134
|
max@0
|
135
|
max@0
|
136
|
max@0
|
137 template<typename eT>
|
max@0
|
138 inline
|
max@0
|
139 arma_warn_unused
|
max@0
|
140 eT
|
max@0
|
141 mean(const Op<subview<eT>, op_mean>& in)
|
max@0
|
142 {
|
max@0
|
143 arma_extra_debug_sigprint();
|
max@0
|
144 arma_extra_debug_print("mean(): two consecutive mean() calls detected");
|
max@0
|
145
|
max@0
|
146 const subview<eT>& X = in.m;
|
max@0
|
147
|
max@0
|
148 arma_debug_check( (X.n_elem == 0), "mean(): given object has no elements" );
|
max@0
|
149
|
max@0
|
150 return op_mean::direct_mean(X);
|
max@0
|
151 }
|
max@0
|
152
|
max@0
|
153
|
max@0
|
154
|
max@0
|
155 template<typename eT>
|
max@0
|
156 inline
|
max@0
|
157 arma_warn_unused
|
max@0
|
158 eT
|
max@0
|
159 mean(const diagview<eT>& A)
|
max@0
|
160 {
|
max@0
|
161 arma_extra_debug_sigprint();
|
max@0
|
162
|
max@0
|
163 arma_debug_check( (A.n_elem == 0), "mean(): given object has no elements" );
|
max@0
|
164
|
max@0
|
165 return op_mean::direct_mean(A);
|
max@0
|
166 }
|
max@0
|
167
|
max@0
|
168
|
max@0
|
169
|
max@0
|
170 template<typename eT, typename T1>
|
max@0
|
171 inline
|
max@0
|
172 arma_warn_unused
|
max@0
|
173 eT
|
max@0
|
174 mean(const subview_elem1<eT,T1>& A)
|
max@0
|
175 {
|
max@0
|
176 arma_extra_debug_sigprint();
|
max@0
|
177
|
max@0
|
178 const Mat<eT> X(A);
|
max@0
|
179
|
max@0
|
180 const uword X_n_elem = X.n_elem;
|
max@0
|
181
|
max@0
|
182 arma_debug_check( (X_n_elem == 0), "mean(): given object has no elements" );
|
max@0
|
183
|
max@0
|
184 return op_mean::direct_mean(X.mem, X_n_elem);
|
max@0
|
185 }
|
max@0
|
186
|
max@0
|
187
|
max@0
|
188
|
max@0
|
189 //! @}
|