82 lines
2.1 KiB
C++
82 lines
2.1 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_prod
|
|
//! @{
|
|
|
|
|
|
//! \brief
|
|
//! Delayed product of elements of a matrix along a specified dimension (either rows or columns).
|
|
//! The result is stored in a dense matrix that has either one column or one row.
|
|
//! For dim = 0, find the sum of each column (ie. traverse across rows)
|
|
//! For dim = 1, find the sum of each row (ie. traverse across columns)
|
|
//! The default is dim = 0.
|
|
//! NOTE: this function works differently than in Matlab/Octave.
|
|
|
|
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
|
|
prod(const T1& X)
|
|
{
|
|
arma_debug_sigprint();
|
|
|
|
return op_prod::prod(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_prod> >::result
|
|
prod(const T1& X)
|
|
{
|
|
arma_debug_sigprint();
|
|
|
|
return Op<T1, op_prod>(X, 0, 0);
|
|
}
|
|
|
|
|
|
|
|
template<typename T1>
|
|
arma_warn_unused
|
|
arma_inline
|
|
typename enable_if2< is_arma_type<T1>::value, const Op<T1, op_prod> >::result
|
|
prod(const T1& X, const uword dim)
|
|
{
|
|
arma_debug_sigprint();
|
|
|
|
return Op<T1, op_prod>(X, dim, 0);
|
|
}
|
|
|
|
|
|
|
|
template<typename T>
|
|
arma_warn_unused
|
|
arma_inline
|
|
typename arma_scalar_only<T>::result
|
|
prod(const T& x)
|
|
{
|
|
return x;
|
|
}
|
|
|
|
|
|
|
|
//! @}
|