SparseRedux.h
Go to the documentation of this file.
00001 // This file is part of Eigen, a lightweight C++ template library
00002 // for linear algebra.
00003 //
00004 // Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr>
00005 //
00006 // Eigen is free software; you can redistribute it and/or
00007 // modify it under the terms of the GNU Lesser General Public
00008 // License as published by the Free Software Foundation; either
00009 // version 3 of the License, or (at your option) any later version.
00010 //
00011 // Alternatively, you can redistribute it and/or
00012 // modify it under the terms of the GNU General Public License as
00013 // published by the Free Software Foundation; either version 2 of
00014 // the License, or (at your option) any later version.
00015 //
00016 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
00017 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00018 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
00019 // GNU General Public License for more details.
00020 //
00021 // You should have received a copy of the GNU Lesser General Public
00022 // License and a copy of the GNU General Public License along with
00023 // Eigen. If not, see <http://www.gnu.org/licenses/>.
00024 
00025 #ifndef EIGEN_SPARSEREDUX_H
00026 #define EIGEN_SPARSEREDUX_H
00027 
00028 namespace Eigen { 
00029 
00030 template<typename Derived>
00031 typename internal::traits<Derived>::Scalar
00032 SparseMatrixBase<Derived>::sum() const
00033 {
00034   eigen_assert(rows()>0 && cols()>0 && "you are using a non initialized matrix");
00035   Scalar res(0);
00036   for (Index j=0; j<outerSize(); ++j)
00037     for (typename Derived::InnerIterator iter(derived(),j); iter; ++iter)
00038       res += iter.value();
00039   return res;
00040 }
00041 
00042 template<typename _Scalar, int _Options, typename _Index>
00043 typename internal::traits<SparseMatrix<_Scalar,_Options,_Index> >::Scalar
00044 SparseMatrix<_Scalar,_Options,_Index>::sum() const
00045 {
00046   eigen_assert(rows()>0 && cols()>0 && "you are using a non initialized matrix");
00047   return Matrix<Scalar,1,Dynamic>::Map(&m_data.value(0), m_data.size()).sum();
00048 }
00049 
00050 template<typename _Scalar, int _Options, typename _Index>
00051 typename internal::traits<SparseVector<_Scalar,_Options, _Index> >::Scalar
00052 SparseVector<_Scalar,_Options,_Index>::sum() const
00053 {
00054   eigen_assert(rows()>0 && cols()>0 && "you are using a non initialized matrix");
00055   return Matrix<Scalar,1,Dynamic>::Map(&m_data.value(0), m_data.size()).sum();
00056 }
00057 
00058 } // end namespace Eigen
00059 
00060 #endif // EIGEN_SPARSEREDUX_H