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

// This file is part of Eigen, a lightweight C++ template library
// for linear algebra.
//
// Copyright (C) 2009 Benoit Jacob <[email protected]>
// Copyright (C) 2009 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_EIGENBASE_H
#define EIGEN_EIGENBASE_H

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

namespace Eigen {

/** \class EigenBase
 * \ingroup Core_Module
 *
 * Common base class for all classes T such that MatrixBase has an operator=(T) and a constructor MatrixBase(T).
 *
 * In other words, an EigenBase object is an object that can be copied into a MatrixBase.
 *
 * Besides MatrixBase-derived classes, this also includes special matrix classes such as diagonal matrices, etc.
 *
 * Notice that this class is trivial, it is only used to disambiguate overloaded functions.
 *
 * \sa \blank \ref TopicClassHierarchy
 */
template <typename Derived>
struct EigenBase { … };

/***************************************************************************
 * Implementation of matrix base methods
 ***************************************************************************/

/** \brief Copies the generic expression \a other into *this.
 *
 * \details The expression must provide a (templated) evalTo(Derived& dst) const
 * function which does the actual job. In practice, this allows any user to write
 * its own special matrix without having to modify MatrixBase
 *
 * \returns a reference to *this.
 */
template <typename Derived>
template <typename OtherDerived>
EIGEN_DEVICE_FUNC Derived& DenseBase<Derived>::operator=(const EigenBase<OtherDerived>& other) { … }

template <typename Derived>
template <typename OtherDerived>
EIGEN_DEVICE_FUNC Derived& DenseBase<Derived>::operator+=(const EigenBase<OtherDerived>& other) { … }

template <typename Derived>
template <typename OtherDerived>
EIGEN_DEVICE_FUNC Derived& DenseBase<Derived>::operator-=(const EigenBase<OtherDerived>& other) { … }

}  // end namespace Eigen

#endif  // EIGEN_EIGENBASE_H