SparseView.h
Go to the documentation of this file.
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2011-2014 Gael Guennebaud <gael.guennebaud@inria.fr>
5 // Copyright (C) 2010 Daniel Lowengrub <lowdanie@gmail.com>
6 //
7 // This Source Code Form is subject to the terms of the Mozilla
8 // Public License v. 2.0. If a copy of the MPL was not distributed
9 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
10 
11 #ifndef EIGEN_SPARSEVIEW_H
12 #define EIGEN_SPARSEVIEW_H
13 
14 namespace Eigen {
15 
16 namespace internal {
17 
18 template<typename MatrixType>
19 struct traits<SparseView<MatrixType> > : traits<MatrixType>
20 {
21  typedef typename MatrixType::StorageIndex StorageIndex;
23  enum {
25  };
26 };
27 
28 } // end namespace internal
29 
44 template<typename MatrixType>
45 class SparseView : public SparseMatrixBase<SparseView<MatrixType> >
46 {
47  typedef typename MatrixType::Nested MatrixTypeNested;
50 public:
52  typedef typename internal::remove_all<MatrixType>::type NestedExpression;
53 
54  explicit SparseView(const MatrixType& mat, const Scalar& reference = Scalar(0),
55  const RealScalar &epsilon = NumTraits<Scalar>::dummy_precision())
56  : m_matrix(mat), m_reference(reference), m_epsilon(epsilon) {}
57 
58  inline Index rows() const { return m_matrix.rows(); }
59  inline Index cols() const { return m_matrix.cols(); }
60 
61  inline Index innerSize() const { return m_matrix.innerSize(); }
62  inline Index outerSize() const { return m_matrix.outerSize(); }
63 
66  nestedExpression() const { return m_matrix; }
67 
68  Scalar reference() const { return m_reference; }
69  RealScalar epsilon() const { return m_epsilon; }
70 
71 protected:
72  MatrixTypeNested m_matrix;
75 };
76 
77 namespace internal {
78 
79 // TODO find a way to unify the two following variants
80 // This is tricky because implementing an inner iterator on top of an IndexBased evaluator is
81 // not easy because the evaluators do not expose the sizes of the underlying expression.
82 
83 template<typename ArgType>
85  : public evaluator_base<SparseView<ArgType> >
86 {
88  public:
90 
91  class InnerIterator : public EvalIterator
92  {
93  protected:
94  typedef typename XprType::Scalar Scalar;
95  public:
96 
98  : EvalIterator(sve.m_argImpl,outer), m_view(sve.m_view)
99  {
100  incrementToNonZero();
101  }
102 
104  {
106  incrementToNonZero();
107  return *this;
108  }
109 
110  using EvalIterator::value;
111 
112  protected:
113  const XprType &m_view;
114 
115  private:
117  {
118  while((bool(*this)) && internal::isMuchSmallerThan(value(), m_view.reference(), m_view.epsilon()))
119  {
121  }
122  }
123  };
124 
125  enum {
127  Flags = XprType::Flags
128  };
129 
130  explicit unary_evaluator(const XprType& xpr) : m_argImpl(xpr.nestedExpression()), m_view(xpr) {}
131 
132  protected:
134  const XprType &m_view;
135 };
136 
137 template<typename ArgType>
139  : public evaluator_base<SparseView<ArgType> >
140 {
141  public:
143  protected:
144  enum { IsRowMajor = (XprType::Flags&RowMajorBit)==RowMajorBit };
145  typedef typename XprType::Scalar Scalar;
147  public:
148 
150  {
151  public:
152 
154  : m_sve(sve), m_inner(0), m_outer(outer), m_end(sve.m_view.innerSize())
155  {
156  incrementToNonZero();
157  }
158 
160  {
161  m_inner++;
162  incrementToNonZero();
163  return *this;
164  }
165 
166  EIGEN_STRONG_INLINE Scalar value() const
167  {
168  return (IsRowMajor) ? m_sve.m_argImpl.coeff(m_outer, m_inner)
169  : m_sve.m_argImpl.coeff(m_inner, m_outer);
170  }
171 
172  EIGEN_STRONG_INLINE StorageIndex index() const { return m_inner; }
173  inline Index row() const { return IsRowMajor ? m_outer : index(); }
174  inline Index col() const { return IsRowMajor ? index() : m_outer; }
175 
176  EIGEN_STRONG_INLINE operator bool() const { return m_inner < m_end && m_inner>=0; }
177 
178  protected:
181  const Index m_outer;
182  const Index m_end;
183 
184  private:
186  {
187  while((bool(*this)) && internal::isMuchSmallerThan(value(), m_sve.m_view.reference(), m_sve.m_view.epsilon()))
188  {
189  m_inner++;
190  }
191  }
192  };
193 
194  enum {
196  Flags = XprType::Flags
197  };
198 
199  explicit unary_evaluator(const XprType& xpr) : m_argImpl(xpr.nestedExpression()), m_view(xpr) {}
200 
201  protected:
203  const XprType &m_view;
204 };
205 
206 } // end namespace internal
207 
225 template<typename Derived>
227  const typename NumTraits<Scalar>::Real& epsilon) const
228 {
229  return SparseView<Derived>(derived(), reference, epsilon);
230 }
231 
244 template<typename Derived>
247  const RealScalar& epsilon) const
248 {
249  return SparseView<Derived>(derived(), reference, epsilon);
250 }
251 
252 } // end namespace Eigen
253 
254 #endif
SparseMatrixBase< SparseView > Base
Definition: SparseView.h:49
EIGEN_STRONG_INLINE InnerIterator(const unary_evaluator &sve, Index outer)
Definition: SparseView.h:97
#define EIGEN_STRONG_INLINE
Definition: Macros.h:917
EIGEN_DEVICE_FUNC bool isMuchSmallerThan(const Scalar &x, const OtherScalar &y, const typename NumTraits< Scalar >::Real &precision=NumTraits< Scalar >::dummy_precision())
Index innerSize() const
Definition: SparseView.h:61
internal::traits< Derived >::Scalar Scalar
Definition: DenseBase.h:66
EIGEN_STRONG_INLINE InnerIterator(const unary_evaluator &sve, Index outer)
Definition: SparseView.h:153
Namespace containing all symbols from the Eigen library.
Definition: jet.h:637
MatrixXf MatrixType
Holds information about the various numeric (i.e. scalar) types allowed by Eigen. ...
Definition: NumTraits.h:232
Eigen::Index Index
The interface type of indices.
Definition: EigenBase.h:39
const unsigned int RowMajorBit
Definition: Constants.h:66
Scalar reference() const
Definition: SparseView.h:68
static double epsilon
Definition: testRot3.cpp:37
const SparseView< Derived > pruned(const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const
Definition: SparseView.h:246
internal::traits< SparseView< MatrixType > >::StorageIndex StorageIndex
#define EIGEN_SPARSE_PUBLIC_INTERFACE(Derived)
Definition: SparseUtil.h:43
Base class of any sparse matrices or sparse expressions.
MatrixType::Nested MatrixTypeNested
Definition: SparseView.h:47
internal::remove_all< MatrixTypeNested >::type _MatrixTypeNested
Definition: SparseView.h:48
MatrixTypeNested m_matrix
Definition: SparseView.h:72
internal::traits< SparseView< MatrixType > >::Scalar Scalar
RealScalar m_epsilon
Definition: SparseView.h:74
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:74
Expression of a dense or sparse matrix with zero or too small values removed.
Index rows() const
Definition: SparseView.h:58
Index cols() const
Definition: SparseView.h:59
const SparseView< Derived > sparseView(const Scalar &m_reference=Scalar(0), const typename NumTraits< Scalar >::Real &m_epsilon=NumTraits< Scalar >::dummy_precision()) const
Definition: SparseView.h:226
RealScalar epsilon() const
Definition: SparseView.h:69
Index outerSize() const
Definition: SparseView.h:62
const internal::remove_all< MatrixTypeNested >::type & nestedExpression() const
Definition: SparseView.h:66
Scalar m_reference
Definition: SparseView.h:73
Definition: pytypes.h:1370
EIGEN_STRONG_INLINE EIGEN_DEVICE_FUNC bfloat16 operator++(bfloat16 &a)
Definition: BFloat16.h:200
An InnerIterator allows to loop over the element of any matrix expression.
Definition: CoreIterators.h:33


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:36:18