mirror of
https://gitlab.com/libeigen/eigen.git
synced 2026-04-10 11:34:33 +08:00
239 lines
8.3 KiB
C++
239 lines
8.3 KiB
C++
// This file is part of Eigen, a lightweight C++ template library
|
|
// for linear algebra. Eigen itself is part of the KDE project.
|
|
//
|
|
// Copyright (C) 2008 Gael Guennebaud <g.gael@free.fr>
|
|
// Copyright (C) 2006-2008 Benoit Jacob <jacob@math.jussieu.fr>
|
|
//
|
|
// Eigen is free software; you can redistribute it and/or
|
|
// modify it under the terms of the GNU Lesser General Public
|
|
// License as published by the Free Software Foundation; either
|
|
// version 3 of the License, or (at your option) any later version.
|
|
//
|
|
// Alternatively, you can redistribute it and/or
|
|
// modify it under the terms of the GNU General Public License as
|
|
// published by the Free Software Foundation; either version 2 of
|
|
// the License, or (at your option) any later version.
|
|
//
|
|
// Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
// FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public
|
|
// License and a copy of the GNU General Public License along with
|
|
// Eigen. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
#ifndef EIGEN_CWISE_BINARY_OP_H
|
|
#define EIGEN_CWISE_BINARY_OP_H
|
|
|
|
/** \class CwiseBinaryOp
|
|
*
|
|
* \brief Generic expression of a coefficient-wise operator between two matrices or vectors
|
|
*
|
|
* \param BinaryOp template functor implementing the operator
|
|
* \param Lhs the type of the left-hand side
|
|
* \param Rhs the type of the right-hand side
|
|
*
|
|
* This class represents an expression of a generic binary operator of two matrices or vectors.
|
|
* It is the return type of the operator+, operator-, cwiseProduct, cwiseQuotient between matrices or vectors, and most
|
|
* of the time this is the only way it is used.
|
|
*
|
|
* However, if you want to write a function returning such an expression, you
|
|
* will need to use this class.
|
|
*
|
|
* Here is an example illustrating this:
|
|
* \include class_CwiseBinaryOp.cpp
|
|
*
|
|
* \sa class CwiseProductOp, class CwiseQuotientOp
|
|
*/
|
|
template<typename BinaryOp, typename Lhs, typename Rhs>
|
|
class CwiseBinaryOp : NoOperatorEquals,
|
|
public MatrixBase<typename Lhs::Scalar, CwiseBinaryOp<BinaryOp, Lhs, Rhs> >
|
|
{
|
|
public:
|
|
typedef typename Lhs::Scalar Scalar;
|
|
typedef typename Lhs::Ref LhsRef;
|
|
typedef typename Rhs::Ref RhsRef;
|
|
friend class MatrixBase<Scalar, CwiseBinaryOp>;
|
|
typedef MatrixBase<Scalar, CwiseBinaryOp> Base;
|
|
|
|
CwiseBinaryOp(const LhsRef& lhs, const RhsRef& rhs)
|
|
: m_lhs(lhs), m_rhs(rhs)
|
|
{
|
|
assert(lhs.rows() == rhs.rows() && lhs.cols() == rhs.cols());
|
|
}
|
|
|
|
private:
|
|
enum {
|
|
RowsAtCompileTime = Lhs::Traits::RowsAtCompileTime,
|
|
ColsAtCompileTime = Lhs::Traits::ColsAtCompileTime,
|
|
MaxRowsAtCompileTime = Lhs::Traits::MaxRowsAtCompileTime,
|
|
MaxColsAtCompileTime = Lhs::Traits::MaxColsAtCompileTime
|
|
};
|
|
|
|
const CwiseBinaryOp& _ref() const { return *this; }
|
|
int _rows() const { return m_lhs.rows(); }
|
|
int _cols() const { return m_lhs.cols(); }
|
|
|
|
Scalar _coeff(int row, int col) const
|
|
{
|
|
return BinaryOp::template op<Scalar>(m_lhs.coeff(row, col), m_rhs.coeff(row, col));
|
|
}
|
|
|
|
protected:
|
|
const LhsRef m_lhs;
|
|
const RhsRef m_rhs;
|
|
};
|
|
|
|
/** \brief Template functor to compute the sum of two scalars
|
|
*
|
|
* \sa class CwiseBinaryOp, MatrixBase::operator+
|
|
*/
|
|
struct CwiseSumOp {
|
|
template<typename Scalar> static Scalar op(const Scalar& a, const Scalar& b) { return a + b; }
|
|
};
|
|
|
|
/** \brief Template functor to compute the difference of two scalars
|
|
*
|
|
* \sa class CwiseBinaryOp, MatrixBase::operator-
|
|
*/
|
|
struct CwiseDifferenceOp {
|
|
template<typename Scalar> static Scalar op(const Scalar& a, const Scalar& b) { return a - b; }
|
|
};
|
|
|
|
/** \brief Template functor to compute the product of two scalars
|
|
*
|
|
* \sa class CwiseBinaryOp, MatrixBase::cwiseProduct()
|
|
*/
|
|
struct CwiseProductOp {
|
|
template<typename Scalar> static Scalar op(const Scalar& a, const Scalar& b) { return a * b; }
|
|
};
|
|
|
|
/** \brief Template functor to compute the quotient of two scalars
|
|
*
|
|
* \sa class CwiseBinaryOp, MatrixBase::cwiseQuotient()
|
|
*/
|
|
struct CwiseQuotientOp {
|
|
template<typename Scalar> static Scalar op(const Scalar& a, const Scalar& b) { return a / b; }
|
|
};
|
|
|
|
/** \relates MatrixBase
|
|
*
|
|
* \returns an expression of the difference of \a mat1 and \a mat2
|
|
*
|
|
* \sa class CwiseBinaryOp, MatrixBase::operator-=()
|
|
*/
|
|
template<typename Scalar, typename Derived1, typename Derived2>
|
|
const CwiseBinaryOp<CwiseDifferenceOp, Derived1, Derived2>
|
|
operator-(const MatrixBase<Scalar, Derived1> &mat1, const MatrixBase<Scalar, Derived2> &mat2)
|
|
{
|
|
return CwiseBinaryOp<CwiseDifferenceOp, Derived1, Derived2>(mat1.ref(), mat2.ref());
|
|
}
|
|
|
|
/** replaces \c *this by \c *this - \a other.
|
|
*
|
|
* \returns a reference to \c *this
|
|
*/
|
|
template<typename Scalar, typename Derived>
|
|
template<typename OtherDerived>
|
|
Derived &
|
|
MatrixBase<Scalar, Derived>::operator-=(const MatrixBase<Scalar, OtherDerived> &other)
|
|
{
|
|
return *this = *this - other;
|
|
}
|
|
|
|
|
|
/** \relates MatrixBase
|
|
*
|
|
* \returns an expression of the sum of \a mat1 and \a mat2
|
|
*
|
|
* \sa class CwiseBinaryOp, MatrixBase::operator+=()
|
|
*/
|
|
template<typename Scalar, typename Derived1, typename Derived2>
|
|
const CwiseBinaryOp<CwiseSumOp, Derived1, Derived2>
|
|
operator+(const MatrixBase<Scalar, Derived1> &mat1, const MatrixBase<Scalar, Derived2> &mat2)
|
|
{
|
|
return CwiseBinaryOp<CwiseSumOp, Derived1, Derived2>(mat1.ref(), mat2.ref());
|
|
}
|
|
|
|
/** replaces \c *this by \c *this + \a other.
|
|
*
|
|
* \returns a reference to \c *this
|
|
*/
|
|
template<typename Scalar, typename Derived>
|
|
template<typename OtherDerived>
|
|
Derived &
|
|
MatrixBase<Scalar, Derived>::operator+=(const MatrixBase<Scalar, OtherDerived>& other)
|
|
{
|
|
return *this = *this + other;
|
|
}
|
|
|
|
|
|
/** \returns an expression of the Schur product (coefficient wise product) of *this and \a other
|
|
*
|
|
* \sa class CwiseBinaryOp
|
|
*/
|
|
template<typename Scalar, typename Derived>
|
|
template<typename OtherDerived>
|
|
const CwiseBinaryOp<CwiseProductOp, Derived, OtherDerived>
|
|
MatrixBase<Scalar, Derived>::cwiseProduct(const MatrixBase<Scalar, OtherDerived> &other) const
|
|
{
|
|
return CwiseBinaryOp<CwiseProductOp, Derived, OtherDerived>(ref(), other.ref());
|
|
}
|
|
|
|
|
|
/** \returns an expression of the coefficient-wise quotient of *this and \a other
|
|
*
|
|
* \sa class CwiseBinaryOp
|
|
*/
|
|
template<typename Scalar, typename Derived>
|
|
template<typename OtherDerived>
|
|
const CwiseBinaryOp<CwiseQuotientOp, Derived, OtherDerived>
|
|
MatrixBase<Scalar, Derived>::cwiseQuotient(const MatrixBase<Scalar, OtherDerived> &other) const
|
|
{
|
|
return CwiseBinaryOp<CwiseQuotientOp, Derived, OtherDerived>(ref(), other.ref());
|
|
}
|
|
|
|
|
|
/** \relates MatrixBase
|
|
*
|
|
* \returns an expression of a custom coefficient-wise operator of \a mat1 and \a mat2
|
|
*
|
|
* The template parameter \a CustomBinaryOp is the template functor
|
|
* of the custom operator (see class CwiseBinaryOp for an example)
|
|
*
|
|
* \sa class CwiseBinaryOp, MatrixBase::operator+, MatrixBase::operator-, MatrixBase::cwiseProduct, MatrixBase::cwiseQuotient
|
|
*/
|
|
template<typename CustomBinaryOp, typename Scalar, typename Derived1, typename Derived2>
|
|
const CwiseBinaryOp<CustomBinaryOp, Derived1, Derived2>
|
|
cwise(const MatrixBase<Scalar, Derived1> &mat1, const MatrixBase<Scalar, Derived2> &mat2)
|
|
{
|
|
return CwiseBinaryOp<CustomBinaryOp, Derived1, Derived2>(mat1.ref(), mat2.ref());
|
|
}
|
|
|
|
/** \returns an expression of a custom coefficient-wise operator of *this and \a other
|
|
*
|
|
* The template parameter \a CustomBinaryOp is the template functor
|
|
* of the custom operator (see class CwiseBinaryOp for an example)
|
|
*
|
|
* \note since cwise is a templated member with a mandatory template parameter,
|
|
* the keyword template as to be used if the matrix type is also a template parameter:
|
|
* \code
|
|
* template <typename MatrixType> void foo(const MatrixType& m1, const MatrixType& m2) {
|
|
* m1.template cwise<CwiseProductOp>(m2);
|
|
* }
|
|
* \endcode
|
|
*
|
|
* \sa class CwiseBinaryOp, MatrixBase::operator+, MatrixBase::operator-, MatrixBase::cwiseProduct, MatrixBase::cwiseQuotient
|
|
*/
|
|
template<typename Scalar, typename Derived>
|
|
template<typename CustomBinaryOp, typename OtherDerived>
|
|
const CwiseBinaryOp<CustomBinaryOp, Derived, OtherDerived>
|
|
MatrixBase<Scalar, Derived>::cwise(const MatrixBase<Scalar, OtherDerived> &other) const
|
|
{
|
|
return CwiseBinaryOp<CustomBinaryOp, Derived, OtherDerived>(ref(), other.ref());
|
|
}
|
|
|
|
|
|
#endif // EIGEN_CWISE_BINARY_OP_H
|