1 // SPDX-License-Identifier: Apache-2.0
2 //
3 // Copyright 2008-2016 Conrad Sanderson (http://conradsanderson.id.au)
4 // Copyright 2008-2016 National ICT Australia (NICTA)
5 //
6 // Licensed under the Apache License, Version 2.0 (the "License");
7 // you may not use this file except in compliance with the License.
8 // You may obtain a copy of the License at
9 // http://www.apache.org/licenses/LICENSE-2.0
10 //
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
16 // ------------------------------------------------------------------------
17
18
19 //! \addtogroup fn_sum
20 //! @{
21
22
23 template<typename T1>
24 arma_warn_unused
25 inline
26 typename enable_if2< is_arma_type<T1>::value && resolves_to_vector<T1>::yes, typename T1::elem_type >::result
sum(const T1 & X)27 sum(const T1& X)
28 {
29 arma_extra_debug_sigprint();
30
31 return accu(X);
32 }
33
34
35
36 template<typename T1>
37 arma_warn_unused
38 arma_inline
39 typename enable_if2< is_arma_type<T1>::value && resolves_to_vector<T1>::no, const Op<T1, op_sum> >::result
sum(const T1 & X)40 sum(const T1& X)
41 {
42 arma_extra_debug_sigprint();
43
44 return Op<T1, op_sum>(X, 0, 0);
45 }
46
47
48
49 template<typename T1>
50 arma_warn_unused
51 arma_inline
52 typename enable_if2< is_arma_type<T1>::value, const Op<T1, op_sum> >::result
sum(const T1 & X,const uword dim)53 sum(const T1& X, const uword dim)
54 {
55 arma_extra_debug_sigprint();
56
57 return Op<T1, op_sum>(X, dim, 0);
58 }
59
60
61
62 template<typename T>
63 arma_warn_unused
64 arma_inline
65 typename arma_scalar_only<T>::result
sum(const T & x)66 sum(const T& x)
67 {
68 return x;
69 }
70
71
72
73 //! sum of cube
74 template<typename T1>
75 arma_warn_unused
76 arma_inline
77 const OpCube<T1, op_sum>
sum(const BaseCube<typename T1::elem_type,T1> & X,const uword dim=0)78 sum
79 (
80 const BaseCube<typename T1::elem_type,T1>& X,
81 const uword dim = 0
82 )
83 {
84 arma_extra_debug_sigprint();
85
86 return OpCube<T1, op_sum>(X.get_ref(), dim, 0);
87 }
88
89
90
91 //! sum of sparse object
92 template<typename T1>
93 arma_warn_unused
94 inline
95 typename
96 enable_if2
97 <
98 is_arma_sparse_type<T1>::value && resolves_to_sparse_vector<T1>::yes,
99 typename T1::elem_type
100 >::result
sum(const T1 & x)101 sum(const T1& x)
102 {
103 arma_extra_debug_sigprint();
104
105 // sum elements
106 return accu(x);
107 }
108
109
110
111 template<typename T1>
112 arma_warn_unused
113 inline
114 typename
115 enable_if2
116 <
117 is_arma_sparse_type<T1>::value && resolves_to_sparse_vector<T1>::no,
118 const SpOp<T1,spop_sum>
119 >::result
sum(const T1 & x)120 sum(const T1& x)
121 {
122 arma_extra_debug_sigprint();
123
124 return SpOp<T1,spop_sum>(x, 0, 0);
125 }
126
127
128
129 template<typename T1>
130 arma_warn_unused
131 inline
132 typename
133 enable_if2
134 <
135 is_arma_sparse_type<T1>::value,
136 const SpOp<T1,spop_sum>
137 >::result
sum(const T1 & x,const uword dim)138 sum(const T1& x, const uword dim)
139 {
140 arma_extra_debug_sigprint();
141
142 return SpOp<T1,spop_sum>(x, dim, 0);
143 }
144
145
146
147 //! @}
148