Files
armadillo-code/include/armadillo_bits/fn_mean.hpp
T
2025-06-23 12:59:12 +10:00

146 lines
2.8 KiB
C++

// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2008-2016 Conrad Sanderson (http://conradsanderson.id.au)
// Copyright 2008-2016 National ICT Australia (NICTA)
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ------------------------------------------------------------------------
//! \addtogroup fn_mean
//! @{
template<typename T1>
arma_warn_unused
inline
typename enable_if2< is_arma_type<T1>::value && resolves_to_vector<T1>::yes, typename T1::elem_type >::result
mean(const T1& X)
{
arma_debug_sigprint();
return op_mean::mean_all(X);
}
template<typename T1>
arma_warn_unused
arma_inline
typename enable_if2< is_arma_type<T1>::value && resolves_to_vector<T1>::no, const Op<T1, op_mean> >::result
mean(const T1& X)
{
arma_debug_sigprint();
return Op<T1, op_mean>(X, 0, 0);
}
template<typename T1>
arma_warn_unused
arma_inline
typename enable_if2< is_arma_type<T1>::value, const Op<T1, op_mean> >::result
mean(const T1& X, const uword dim)
{
arma_debug_sigprint();
return Op<T1, op_mean>(X, dim, 0);
}
template<typename T>
arma_warn_unused
arma_inline
typename arma_scalar_only<T>::result
mean(const T& x)
{
return x;
}
template<typename T1>
arma_warn_unused
arma_inline
const OpCube<T1, op_mean>
mean
(
const BaseCube<typename T1::elem_type,T1>& X,
const uword dim = 0
)
{
arma_debug_sigprint();
return OpCube<T1, op_mean>(X.get_ref(), dim, 0);
}
template<typename T1>
arma_warn_unused
inline
typename
enable_if2
<
is_arma_sparse_type<T1>::value && resolves_to_sparse_vector<T1>::yes,
typename T1::elem_type
>::result
mean(const T1& x)
{
arma_debug_sigprint();
return op_sp_mean::mean_all(x);
}
template<typename T1>
arma_warn_unused
inline
typename
enable_if2
<
is_arma_sparse_type<T1>::value && resolves_to_sparse_vector<T1>::no,
const mtSpReduceOp<typename T1::elem_type, T1, op_sp_mean>
>::result
mean(const T1& x)
{
arma_debug_sigprint();
return mtSpReduceOp<typename T1::elem_type, T1, op_sp_mean>(x, 0, 0);
}
template<typename T1>
arma_warn_unused
inline
typename
enable_if2
<
is_arma_sparse_type<T1>::value,
const mtSpReduceOp<typename T1::elem_type, T1, op_sp_mean>
>::result
mean(const T1& x, const uword dim)
{
arma_debug_sigprint();
return mtSpReduceOp<typename T1::elem_type, T1, op_sp_mean>(x, dim, 0);
}
//! @}