mirror of
https://gitlab.com/libeigen/eigen.git
synced 2025-04-23 10:09:36 +08:00
4c92150676
part of a matrix. Triangular also provide an optimised method for forward and backward substitution. Further optimizations regarding assignments and products might come later. Updated determinant() to take into account triangular matrices. Started the QR module with a QR decompostion algorithm. Help needed to build a QR algorithm (eigen solver) based on it.
295 lines
10 KiB
C++
295 lines
10 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 ei_scalar_product_op, class ei_scalar_quotient_op
|
|
*/
|
|
template<typename BinaryOp, typename Lhs, typename Rhs>
|
|
struct ei_traits<CwiseBinaryOp<BinaryOp, Lhs, Rhs> >
|
|
{
|
|
typedef typename ei_result_of<
|
|
BinaryOp(
|
|
typename Lhs::Scalar,
|
|
typename Rhs::Scalar
|
|
)
|
|
>::type Scalar;
|
|
enum {
|
|
RowsAtCompileTime = Lhs::RowsAtCompileTime,
|
|
ColsAtCompileTime = Lhs::ColsAtCompileTime,
|
|
MaxRowsAtCompileTime = Lhs::MaxRowsAtCompileTime,
|
|
MaxColsAtCompileTime = Lhs::MaxColsAtCompileTime,
|
|
Flags = ((Lhs::Flags | Rhs::Flags) & (
|
|
DefaultLostFlagMask
|
|
| Like1DArrayBit
|
|
| (ei_functor_traits<BinaryOp>::IsVectorizable && ((Lhs::Flags & RowMajorBit)==(Rhs::Flags & RowMajorBit))
|
|
? VectorizableBit : 0))),
|
|
CoeffReadCost = Lhs::CoeffReadCost + Rhs::CoeffReadCost + ei_functor_traits<BinaryOp>::Cost
|
|
};
|
|
};
|
|
|
|
template<typename BinaryOp, typename Lhs, typename Rhs>
|
|
class CwiseBinaryOp : ei_no_assignment_operator,
|
|
public MatrixBase<CwiseBinaryOp<BinaryOp, Lhs, Rhs> >
|
|
{
|
|
public:
|
|
|
|
EIGEN_GENERIC_PUBLIC_INTERFACE(CwiseBinaryOp)
|
|
|
|
CwiseBinaryOp(const Lhs& lhs, const Rhs& rhs, const BinaryOp& func = BinaryOp())
|
|
: m_lhs(lhs), m_rhs(rhs), m_functor(func)
|
|
{
|
|
ei_assert(lhs.rows() == rhs.rows() && lhs.cols() == rhs.cols());
|
|
}
|
|
|
|
private:
|
|
|
|
int _rows() const { return m_lhs.rows(); }
|
|
int _cols() const { return m_lhs.cols(); }
|
|
|
|
const Scalar _coeff(int row, int col) const
|
|
{
|
|
return m_functor(m_lhs.coeff(row, col), m_rhs.coeff(row, col));
|
|
}
|
|
|
|
PacketScalar _packetCoeff(int row, int col) const
|
|
{
|
|
return m_functor.packetOp(m_lhs.packetCoeff(row, col), m_rhs.packetCoeff(row, col));
|
|
}
|
|
|
|
protected:
|
|
const typename Lhs::Nested m_lhs;
|
|
const typename Rhs::Nested m_rhs;
|
|
const BinaryOp m_functor;
|
|
};
|
|
|
|
/**\returns an expression of the difference of \c *this and \a other
|
|
*
|
|
* \sa class CwiseBinaryOp, MatrixBase::operator-=()
|
|
*/
|
|
template<typename Derived>
|
|
template<typename OtherDerived>
|
|
const CwiseBinaryOp<ei_scalar_difference_op<typename ei_traits<Derived>::Scalar>,
|
|
Derived, OtherDerived>
|
|
MatrixBase<Derived>::operator-(const MatrixBase<OtherDerived> &other) const
|
|
{
|
|
return CwiseBinaryOp<ei_scalar_difference_op<Scalar>,
|
|
Derived, OtherDerived>(derived(), other.derived());
|
|
}
|
|
|
|
/** replaces \c *this by \c *this - \a other.
|
|
*
|
|
* \returns a reference to \c *this
|
|
*/
|
|
template<typename Derived>
|
|
template<typename OtherDerived>
|
|
Derived &
|
|
MatrixBase<Derived>::operator-=(const MatrixBase<OtherDerived> &other)
|
|
{
|
|
return *this = *this - other;
|
|
}
|
|
|
|
/** \relates MatrixBase
|
|
*
|
|
* \returns an expression of the sum of \c *this and \a other
|
|
*
|
|
* \sa class CwiseBinaryOp, MatrixBase::operator+=()
|
|
*/
|
|
template<typename Derived>
|
|
template<typename OtherDerived>
|
|
const CwiseBinaryOp<ei_scalar_sum_op<typename ei_traits<Derived>::Scalar>, Derived, OtherDerived>
|
|
MatrixBase<Derived>::operator+(const MatrixBase<OtherDerived> &other) const
|
|
{
|
|
return CwiseBinaryOp<ei_scalar_sum_op<Scalar>, Derived, OtherDerived>(derived(), other.derived());
|
|
}
|
|
|
|
/** replaces \c *this by \c *this + \a other.
|
|
*
|
|
* \returns a reference to \c *this
|
|
*/
|
|
template<typename Derived>
|
|
template<typename OtherDerived>
|
|
Derived &
|
|
MatrixBase<Derived>::operator+=(const MatrixBase<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 Derived>
|
|
template<typename OtherDerived>
|
|
const CwiseBinaryOp<ei_scalar_product_op<typename ei_traits<Derived>::Scalar>, Derived, OtherDerived>
|
|
MatrixBase<Derived>::cwiseProduct(const MatrixBase<OtherDerived> &other) const
|
|
{
|
|
return CwiseBinaryOp<ei_scalar_product_op<Scalar>, Derived, OtherDerived>(derived(), other.derived());
|
|
}
|
|
|
|
/** \returns an expression of the coefficient-wise quotient of *this and \a other
|
|
*
|
|
* \sa class CwiseBinaryOp
|
|
*/
|
|
template<typename Derived>
|
|
template<typename OtherDerived>
|
|
const CwiseBinaryOp<ei_scalar_quotient_op<typename ei_traits<Derived>::Scalar>, Derived, OtherDerived>
|
|
MatrixBase<Derived>::cwiseQuotient(const MatrixBase<OtherDerived> &other) const
|
|
{
|
|
return CwiseBinaryOp<ei_scalar_quotient_op<Scalar>, Derived, OtherDerived>(derived(), other.derived());
|
|
}
|
|
|
|
/** \returns an expression of the coefficient-wise min of *this and \a other
|
|
*
|
|
* \sa class CwiseBinaryOp
|
|
*/
|
|
template<typename Derived>
|
|
template<typename OtherDerived>
|
|
const CwiseBinaryOp<ei_scalar_min_op<typename ei_traits<Derived>::Scalar>, Derived, OtherDerived>
|
|
MatrixBase<Derived>::cwiseMin(const MatrixBase<OtherDerived> &other) const
|
|
{
|
|
return CwiseBinaryOp<ei_scalar_min_op<Scalar>, Derived, OtherDerived>(derived(), other.derived());
|
|
}
|
|
|
|
/** \returns an expression of the coefficient-wise max of *this and \a other
|
|
*
|
|
* \sa class CwiseBinaryOp
|
|
*/
|
|
template<typename Derived>
|
|
template<typename OtherDerived>
|
|
const CwiseBinaryOp<ei_scalar_max_op<typename ei_traits<Derived>::Scalar>, Derived, OtherDerived>
|
|
MatrixBase<Derived>::cwiseMax(const MatrixBase<OtherDerived> &other) const
|
|
{
|
|
return CwiseBinaryOp<ei_scalar_max_op<Scalar>, Derived, OtherDerived>(derived(), other.derived());
|
|
}
|
|
|
|
/** \returns an expression of a custom coefficient-wise operator \a func of *this and \a other
|
|
*
|
|
* The template parameter \a CustomBinaryOp is the type of the functor
|
|
* of the custom operator (see class CwiseBinaryOp for an example)
|
|
*
|
|
* \sa class CwiseBinaryOp, MatrixBase::operator+, MatrixBase::operator-, MatrixBase::cwiseProduct, MatrixBase::cwiseQuotient
|
|
*/
|
|
template<typename Derived>
|
|
template<typename CustomBinaryOp, typename OtherDerived>
|
|
const CwiseBinaryOp<CustomBinaryOp, Derived, OtherDerived>
|
|
MatrixBase<Derived>::cwise(const MatrixBase<OtherDerived> &other, const CustomBinaryOp& func) const
|
|
{
|
|
return CwiseBinaryOp<CustomBinaryOp, Derived, OtherDerived>(derived(), other.derived(), func);
|
|
}
|
|
|
|
/** \returns an expression of the coefficient-wise \< operator of *this and \a other
|
|
*
|
|
* \sa class CwiseBinaryOp
|
|
*/
|
|
template<typename Derived>
|
|
template<typename OtherDerived>
|
|
const CwiseBinaryOp<std::less<typename ei_traits<Derived>::Scalar>, Derived, OtherDerived>
|
|
MatrixBase<Derived>::cwiseLessThan(const MatrixBase<OtherDerived> &other) const
|
|
{
|
|
return cwise(other, std::less<Scalar>());
|
|
}
|
|
|
|
/** \returns an expression of the coefficient-wise \<= operator of *this and \a other
|
|
*
|
|
* \sa class CwiseBinaryOp
|
|
*/
|
|
template<typename Derived>
|
|
template<typename OtherDerived>
|
|
const CwiseBinaryOp<std::less_equal<typename ei_traits<Derived>::Scalar>, Derived, OtherDerived>
|
|
MatrixBase<Derived>::cwiseLessEqual(const MatrixBase<OtherDerived> &other) const
|
|
{
|
|
return cwise(other, std::less_equal<Scalar>());
|
|
}
|
|
|
|
/** \returns an expression of the coefficient-wise \> operator of *this and \a other
|
|
*
|
|
* \sa class CwiseBinaryOp
|
|
*/
|
|
template<typename Derived>
|
|
template<typename OtherDerived>
|
|
const CwiseBinaryOp<std::greater<typename ei_traits<Derived>::Scalar>, Derived, OtherDerived>
|
|
MatrixBase<Derived>::cwiseGreaterThan(const MatrixBase<OtherDerived> &other) const
|
|
{
|
|
return cwise(other, std::greater<Scalar>());
|
|
}
|
|
|
|
/** \returns an expression of the coefficient-wise \>= operator of *this and \a other
|
|
*
|
|
* \sa class CwiseBinaryOp
|
|
*/
|
|
template<typename Derived>
|
|
template<typename OtherDerived>
|
|
const CwiseBinaryOp<std::greater_equal<typename ei_traits<Derived>::Scalar>, Derived, OtherDerived>
|
|
MatrixBase<Derived>::cwiseGreaterEqual(const MatrixBase<OtherDerived> &other) const
|
|
{
|
|
return cwise(other, std::greater_equal<Scalar>());
|
|
}
|
|
|
|
/** \returns an expression of the coefficient-wise == operator of *this and \a other
|
|
*
|
|
* \sa class CwiseBinaryOp
|
|
*/
|
|
template<typename Derived>
|
|
template<typename OtherDerived>
|
|
const CwiseBinaryOp<std::equal_to<typename ei_traits<Derived>::Scalar>, Derived, OtherDerived>
|
|
MatrixBase<Derived>::cwiseEqualTo(const MatrixBase<OtherDerived> &other) const
|
|
{
|
|
return cwise(other, std::equal_to<Scalar>());
|
|
}
|
|
|
|
/** \returns an expression of the coefficient-wise != operator of *this and \a other
|
|
*
|
|
* \sa class CwiseBinaryOp
|
|
*/
|
|
template<typename Derived>
|
|
template<typename OtherDerived>
|
|
const CwiseBinaryOp<std::not_equal_to<typename ei_traits<Derived>::Scalar>, Derived, OtherDerived>
|
|
MatrixBase<Derived>::cwiseNotEqualTo(const MatrixBase<OtherDerived> &other) const
|
|
{
|
|
return cwise(other, std::not_equal_to<Scalar>());
|
|
}
|
|
|
|
#endif // EIGEN_CWISE_BINARY_OP_H
|