Visitor.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) 2008 Gael Guennebaud <gael.guennebaud@inria.fr>
5 //
6 // This Source Code Form is subject to the terms of the Mozilla
7 // Public License v. 2.0. If a copy of the MPL was not distributed
8 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 
10 #ifndef EIGEN_VISITOR_H
11 #define EIGEN_VISITOR_H
12 
13 namespace Eigen {
14 
15 namespace internal {
16 
17 template<typename Visitor, typename Derived, int UnrollCount>
19 {
20  enum {
21  col = (UnrollCount-1) / Derived::RowsAtCompileTime,
22  row = (UnrollCount-1) % Derived::RowsAtCompileTime
23  };
24 
26  static inline void run(const Derived &mat, Visitor& visitor)
27  {
29  visitor(mat.coeff(row, col), row, col);
30  }
31 };
32 
33 template<typename Visitor, typename Derived>
34 struct visitor_impl<Visitor, Derived, 1>
35 {
37  static inline void run(const Derived &mat, Visitor& visitor)
38  {
39  return visitor.init(mat.coeff(0, 0), 0, 0);
40  }
41 };
42 
43 // This specialization enables visitors on empty matrices at compile-time
44 template<typename Visitor, typename Derived>
45 struct visitor_impl<Visitor, Derived, 0> {
47  static inline void run(const Derived &/*mat*/, Visitor& /*visitor*/)
48  {}
49 };
50 
51 template<typename Visitor, typename Derived>
52 struct visitor_impl<Visitor, Derived, Dynamic>
53 {
55  static inline void run(const Derived& mat, Visitor& visitor)
56  {
57  visitor.init(mat.coeff(0,0), 0, 0);
58  for(Index i = 1; i < mat.rows(); ++i)
59  visitor(mat.coeff(i, 0), i, 0);
60  for(Index j = 1; j < mat.cols(); ++j)
61  for(Index i = 0; i < mat.rows(); ++i)
62  visitor(mat.coeff(i, j), i, j);
63  }
64 };
65 
66 // evaluator adaptor
67 template<typename XprType>
69 {
70 public:
72  explicit visitor_evaluator(const XprType &xpr) : m_evaluator(xpr), m_xpr(xpr) {}
73 
74  typedef typename XprType::Scalar Scalar;
75  typedef typename XprType::CoeffReturnType CoeffReturnType;
76 
77  enum {
78  RowsAtCompileTime = XprType::RowsAtCompileTime,
80  };
81 
85 
87  { return m_evaluator.coeff(row, col); }
88 
89 protected:
91  const XprType &m_xpr;
92 };
93 } // end namespace internal
94 
114 template<typename Derived>
115 template<typename Visitor>
117 void DenseBase<Derived>::visit(Visitor& visitor) const
118 {
119  if(size()==0)
120  return;
121 
122  typedef typename internal::visitor_evaluator<Derived> ThisEvaluator;
123  ThisEvaluator thisEval(derived());
124 
125  enum {
126  unroll = SizeAtCompileTime != Dynamic
127  && SizeAtCompileTime * int(ThisEvaluator::CoeffReadCost) + (SizeAtCompileTime-1) * int(internal::functor_traits<Visitor>::Cost) <= EIGEN_UNROLLING_LIMIT
128  };
129  return internal::visitor_impl<Visitor, ThisEvaluator, unroll ? int(SizeAtCompileTime) : Dynamic>::run(thisEval, visitor);
130 }
131 
132 namespace internal {
133 
137 template <typename Derived>
139 {
140  // default initialization to avoid countless invalid maybe-uninitialized warnings by gcc
142  coeff_visitor() : row(-1), col(-1), res(0) {}
143  typedef typename Derived::Scalar Scalar;
147  inline void init(const Scalar& value, Index i, Index j)
148  {
149  res = value;
150  row = i;
151  col = j;
152  }
153 };
154 
160 template <typename Derived, int NaNPropagation>
162 {
163  typedef typename Derived::Scalar Scalar;
166  {
167  if(value < this->res)
168  {
169  this->res = value;
170  this->row = i;
171  this->col = j;
172  }
173  }
174 };
175 
176 template <typename Derived>
178 {
179  typedef typename Derived::Scalar Scalar;
182  {
183  if((numext::isnan)(this->res) || (!(numext::isnan)(value) && value < this->res))
184  {
185  this->res = value;
186  this->row = i;
187  this->col = j;
188  }
189  }
190 };
191 
192 template <typename Derived>
193 struct min_coeff_visitor<Derived, PropagateNaN> : coeff_visitor<Derived>
194 {
195  typedef typename Derived::Scalar Scalar;
198  {
199  if((numext::isnan)(value) || value < this->res)
200  {
201  this->res = value;
202  this->row = i;
203  this->col = j;
204  }
205  }
206 };
207 
208 template<typename Scalar, int NaNPropagation>
209  struct functor_traits<min_coeff_visitor<Scalar, NaNPropagation> > {
210  enum {
212  };
213 };
214 
220 template <typename Derived, int NaNPropagation>
222 {
223  typedef typename Derived::Scalar Scalar;
226  {
227  if(value > this->res)
228  {
229  this->res = value;
230  this->row = i;
231  this->col = j;
232  }
233  }
234 };
235 
236 template <typename Derived>
238 {
239  typedef typename Derived::Scalar Scalar;
242  {
243  if((numext::isnan)(this->res) || (!(numext::isnan)(value) && value > this->res))
244  {
245  this->res = value;
246  this->row = i;
247  this->col = j;
248  }
249  }
250 };
251 
252 template <typename Derived>
253 struct max_coeff_visitor<Derived, PropagateNaN> : coeff_visitor<Derived>
254 {
255  typedef typename Derived::Scalar Scalar;
258  {
259  if((numext::isnan)(value) || value > this->res)
260  {
261  this->res = value;
262  this->row = i;
263  this->col = j;
264  }
265  }
266 };
267 
268 template<typename Scalar, int NaNPropagation>
269 struct functor_traits<max_coeff_visitor<Scalar, NaNPropagation> > {
270  enum {
272  };
273 };
274 
275 } // end namespace internal
276 
288 template<typename Derived>
289 template<int NaNPropagation, typename IndexType>
292 DenseBase<Derived>::minCoeff(IndexType* rowId, IndexType* colId) const
293 {
294  eigen_assert(this->rows()>0 && this->cols()>0 && "you are using an empty matrix");
295 
297  this->visit(minVisitor);
298  *rowId = minVisitor.row;
299  if (colId) *colId = minVisitor.col;
300  return minVisitor.res;
301 }
302 
313 template<typename Derived>
314 template<int NaNPropagation, typename IndexType>
317 DenseBase<Derived>::minCoeff(IndexType* index) const
318 {
319  eigen_assert(this->rows()>0 && this->cols()>0 && "you are using an empty matrix");
320 
323  this->visit(minVisitor);
324  *index = IndexType((RowsAtCompileTime==1) ? minVisitor.col : minVisitor.row);
325  return minVisitor.res;
326 }
327 
339 template<typename Derived>
340 template<int NaNPropagation, typename IndexType>
343 DenseBase<Derived>::maxCoeff(IndexType* rowPtr, IndexType* colPtr) const
344 {
345  eigen_assert(this->rows()>0 && this->cols()>0 && "you are using an empty matrix");
346 
348  this->visit(maxVisitor);
349  *rowPtr = maxVisitor.row;
350  if (colPtr) *colPtr = maxVisitor.col;
351  return maxVisitor.res;
352 }
353 
364 template<typename Derived>
365 template<int NaNPropagation, typename IndexType>
368 DenseBase<Derived>::maxCoeff(IndexType* index) const
369 {
370  eigen_assert(this->rows()>0 && this->cols()>0 && "you are using an empty matrix");
371 
374  this->visit(maxVisitor);
375  *index = (RowsAtCompileTime==1) ? maxVisitor.col : maxVisitor.row;
376  return maxVisitor.res;
377 }
378 
379 } // end namespace Eigen
380 
381 #endif // EIGEN_VISITOR_H
gtsam.examples.DogLegOptimizerExample.int
int
Definition: DogLegOptimizerExample.py:111
Eigen::internal::visitor_evaluator::cols
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols() const EIGEN_NOEXCEPT
Definition: Visitor.h:83
EIGEN_DEVICE_FUNC
#define EIGEN_DEVICE_FUNC
Definition: Macros.h:976
Eigen
Namespace containing all symbols from the Eigen library.
Definition: jet.h:637
Eigen::internal::max_coeff_visitor< Derived, PropagateNumbers >::Scalar
Derived::Scalar Scalar
Definition: Visitor.h:239
EIGEN_UNROLLING_LIMIT
#define EIGEN_UNROLLING_LIMIT
Definition: Settings.h:24
col
m col(1)
Eigen::internal::coeff_visitor::init
EIGEN_DEVICE_FUNC void init(const Scalar &value, Index i, Index j)
Definition: Visitor.h:147
Eigen::DenseBase::maxCoeff
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar maxCoeff() const
Eigen::CwiseBinaryOp
Generic expression where a coefficient-wise binary operator is applied to two expressions.
Definition: CwiseBinaryOp.h:77
Eigen::internal::visitor_evaluator::rows
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows() const EIGEN_NOEXCEPT
Definition: Visitor.h:82
Eigen::internal::min_coeff_visitor
Definition: Visitor.h:161
eigen_assert
#define eigen_assert(x)
Definition: Macros.h:1037
Eigen::internal::visitor_impl::row
@ row
Definition: Visitor.h:22
Eigen::internal::visitor_evaluator::CoeffReturnType
XprType::CoeffReturnType CoeffReturnType
Definition: Visitor.h:75
Eigen::internal::visitor_evaluator
Definition: Visitor.h:68
EIGEN_CONSTEXPR
#define EIGEN_CONSTEXPR
Definition: Macros.h:787
EIGEN_STATIC_ASSERT_VECTOR_ONLY
#define EIGEN_STATIC_ASSERT_VECTOR_ONLY(TYPE)
Definition: StaticAssert.h:142
mat
MatrixXf mat
Definition: Tutorial_AdvancedInitialization_CommaTemporary.cpp:1
Eigen::internal::min_coeff_visitor::Scalar
Derived::Scalar Scalar
Definition: Visitor.h:163
Eigen::DenseBase::minCoeff
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar minCoeff() const
rows
int rows
Definition: Tutorial_commainit_02.cpp:1
Eigen::internal::visitor_impl< Visitor, Derived, 0 >::run
static EIGEN_DEVICE_FUNC void run(const Derived &, Visitor &)
Definition: Visitor.h:47
size
Scalar Scalar int size
Definition: benchVecAdd.cpp:17
Eigen::internal::visitor_evaluator::RowsAtCompileTime
@ RowsAtCompileTime
Definition: Visitor.h:78
Eigen::internal::visitor_impl< Visitor, Derived, Dynamic >::run
static EIGEN_DEVICE_FUNC void run(const Derived &mat, Visitor &visitor)
Definition: Visitor.h:55
Eigen::internal::visitor_evaluator::coeff
EIGEN_DEVICE_FUNC CoeffReturnType coeff(Index row, Index col) const
Definition: Visitor.h:86
Eigen::internal::coeff_visitor
Definition: Visitor.h:138
Eigen::internal::coeff_visitor::row
Index row
Definition: Visitor.h:144
Eigen::PropagateNaN
@ PropagateNaN
Definition: Constants.h:343
Eigen::internal::max_coeff_visitor::operator()
EIGEN_DEVICE_FUNC void operator()(const Scalar &value, Index i, Index j)
Definition: Visitor.h:225
Eigen::internal::coeff_visitor::Scalar
Derived::Scalar Scalar
Definition: Visitor.h:143
j
std::ptrdiff_t j
Definition: tut_arithmetic_redux_minmax.cpp:2
Eigen::Dynamic
const int Dynamic
Definition: Constants.h:22
Eigen::internal::visitor_impl::col
@ col
Definition: Visitor.h:21
Eigen::internal::visitor_evaluator::visitor_evaluator
EIGEN_DEVICE_FUNC visitor_evaluator(const XprType &xpr)
Definition: Visitor.h:72
Eigen::internal::visitor_evaluator::CoeffReadCost
@ CoeffReadCost
Definition: Visitor.h:79
Eigen::numext::isnan
EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE bool() isnan(const Eigen::bfloat16 &h)
Definition: BFloat16.h:659
Eigen::internal::min_coeff_visitor::operator()
EIGEN_DEVICE_FUNC void operator()(const Scalar &value, Index i, Index j)
Definition: Visitor.h:165
gtsam.examples.DogLegOptimizerExample.run
def run(args)
Definition: DogLegOptimizerExample.py:21
Eigen::internal::coeff_visitor::col
Index col
Definition: Visitor.h:144
Eigen::internal::visitor_impl::run
static EIGEN_DEVICE_FUNC void run(const Derived &mat, Visitor &visitor)
Definition: Visitor.h:26
Eigen::internal::coeff_visitor::res
Scalar res
Definition: Visitor.h:145
Eigen::internal::visitor_impl
Definition: Visitor.h:18
Eigen::internal::evaluator
Definition: CoreEvaluators.h:90
Eigen::internal::min_coeff_visitor< Derived, PropagateNaN >::Scalar
Derived::Scalar Scalar
Definition: Visitor.h:195
Eigen::internal::min_coeff_visitor< Derived, PropagateNumbers >::Scalar
Derived::Scalar Scalar
Definition: Visitor.h:179
Eigen::internal::visitor_impl< Visitor, Derived, 1 >::run
static EIGEN_DEVICE_FUNC void run(const Derived &mat, Visitor &visitor)
Definition: Visitor.h:37
Eigen::internal::visitor_evaluator::m_evaluator
internal::evaluator< XprType > m_evaluator
Definition: Visitor.h:90
Eigen::DenseBase::visit
EIGEN_DEVICE_FUNC void visit(Visitor &func) const
Definition: Visitor.h:117
Eigen::CwiseBinaryOp::cols
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index cols() const EIGEN_NOEXCEPT
Definition: CwiseBinaryOp.h:125
Eigen::internal::functor_traits::Cost
@ Cost
Definition: XprHelper.h:179
Eigen::internal::traits
Definition: ForwardDeclarations.h:17
row
m row(1)
Eigen::internal::coeff_visitor::coeff_visitor
EIGEN_DEVICE_FUNC coeff_visitor()
Definition: Visitor.h:142
Eigen::internal::max_coeff_visitor< Derived, PropagateNaN >::Scalar
Derived::Scalar Scalar
Definition: Visitor.h:255
Eigen::internal::functor_traits
Definition: XprHelper.h:175
EIGEN_NOEXCEPT
#define EIGEN_NOEXCEPT
Definition: Macros.h:1418
internal
Definition: BandTriangularSolver.h:13
Eigen::internal::max_coeff_visitor::Scalar
Derived::Scalar Scalar
Definition: Visitor.h:223
cols
int cols
Definition: Tutorial_commainit_02.cpp:1
Eigen::internal::max_coeff_visitor
Definition: Visitor.h:221
Eigen::internal::visitor_evaluator::Scalar
XprType::Scalar Scalar
Definition: Visitor.h:74
Eigen::internal::visitor_evaluator::m_xpr
const XprType & m_xpr
Definition: Visitor.h:91
Eigen::NumTraits
Holds information about the various numeric (i.e. scalar) types allowed by Eigen.
Definition: NumTraits.h:232
test_callbacks.value
value
Definition: test_callbacks.py:160
Eigen::internal::visitor_evaluator::size
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index size() const EIGEN_NOEXCEPT
Definition: Visitor.h:84
i
int i
Definition: BiCGSTAB_step_by_step.cpp:9
Eigen::CwiseBinaryOp::rows
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index rows() const EIGEN_NOEXCEPT
Definition: CwiseBinaryOp.h:120
Eigen::PropagateNumbers
@ PropagateNumbers
Definition: Constants.h:345
Scalar
SCALAR Scalar
Definition: bench_gemm.cpp:46
Eigen::Index
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:74


gtsam
Author(s):
autogenerated on Fri Nov 1 2024 03:43:12