chromium/third_party/eigen3/src/Eigen/src/Core/CoreIterators.h

// This file is part of Eigen, a lightweight C++ template library
// for linear algebra.
//
// Copyright (C) 2008-2014 Gael Guennebaud <[email protected]>
//
// This Source Code Form is subject to the terms of the Mozilla
// Public License v. 2.0. If a copy of the MPL was not distributed
// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

#ifndef EIGEN_COREITERATORS_H
#define EIGEN_COREITERATORS_H

// IWYU pragma: private
#include "./InternalHeaderCheck.h"

namespace Eigen {

/* This file contains the respective InnerIterator definition of the expressions defined in Eigen/Core
 */

namespace internal {

template <typename XprType, typename EvaluatorKind>
class inner_iterator_selector;

}

/** \class InnerIterator
 * \brief An InnerIterator allows to loop over the element of any matrix expression.
 *
 * \warning To be used with care because an evaluator is constructed every time an InnerIterator iterator is
 * constructed.
 *
 * TODO: add a usage example
 */
template <typename XprType>
class InnerIterator {};

namespace internal {

// Generic inner iterator implementation for dense objects
inner_iterator_selector<XprType, IndexBased>;

// For iterator-based evaluator, inner-iterator is already implemented as
// evaluator<>::InnerIterator
inner_iterator_selector<XprType, IteratorBased>;

}  // end namespace internal

}  // end namespace Eigen

#endif  // EIGEN_COREITERATORS_H