| // This file is part of Eigen, a lightweight C++ template library |
| // for linear algebra. |
| // |
| // Copyright (C) 2008-2009 Gael Guennebaud <gael.guennebaud@inria.fr> |
| // Copyright (C) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com> |
| // |
| // 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/. |
| |
| // This file is a base class plugin containing matrix specifics coefficient wise functions. |
| |
| /** \returns an expression of the Schur product (coefficient wise product) of *this and \a other |
| * |
| * Example: \include MatrixBase_cwiseProduct.cpp |
| * Output: \verbinclude MatrixBase_cwiseProduct.out |
| * |
| * \sa class CwiseBinaryOp, cwiseAbs2 |
| */ |
| template <typename OtherDerived> |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const EIGEN_CWISE_BINARY_RETURN_TYPE(Derived, OtherDerived, product) |
| cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived>& other) const { |
| return EIGEN_CWISE_BINARY_RETURN_TYPE(Derived, OtherDerived, product)(derived(), other.derived()); |
| } |
| |
| template <typename OtherDerived> |
| using CwiseBinaryEqualReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_EQ>, const Derived, const OtherDerived>; |
| template <typename OtherDerived> |
| using CwiseBinaryNotEqualReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_NEQ>, const Derived, const OtherDerived>; |
| template <typename OtherDerived> |
| using CwiseBinaryLessReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_LT>, const Derived, const OtherDerived>; |
| template <typename OtherDerived> |
| using CwiseBinaryGreaterReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_GT>, const Derived, const OtherDerived>; |
| template <typename OtherDerived> |
| using CwiseBinaryLessOrEqualReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_LE>, const Derived, const OtherDerived>; |
| template <typename OtherDerived> |
| using CwiseBinaryGreaterOrEqualReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_GE>, const Derived, const OtherDerived>; |
| |
| /** \returns an expression of the coefficient-wise == operator of *this and \a other |
| * |
| * \warning this performs an exact comparison, which is generally a bad idea with floating-point types. |
| * In order to check for equality between two vectors or matrices with floating-point coefficients, it is |
| * generally a far better idea to use a fuzzy comparison as provided by isApprox() and |
| * isMuchSmallerThan(). |
| * |
| * Example: \include MatrixBase_cwiseEqual.cpp |
| * Output: \verbinclude MatrixBase_cwiseEqual.out |
| * |
| * \sa cwiseNotEqual(), isApprox(), isMuchSmallerThan() |
| */ |
| template <typename OtherDerived> |
| EIGEN_DEVICE_FUNC inline const CwiseBinaryEqualReturnType<OtherDerived> cwiseEqual( |
| const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived>& other) const { |
| return CwiseBinaryEqualReturnType<OtherDerived>(derived(), other.derived()); |
| } |
| |
| /** \returns an expression of the coefficient-wise != operator of *this and \a other |
| * |
| * \warning this performs an exact comparison, which is generally a bad idea with floating-point types. |
| * In order to check for equality between two vectors or matrices with floating-point coefficients, it is |
| * generally a far better idea to use a fuzzy comparison as provided by isApprox() and |
| * isMuchSmallerThan(). |
| * |
| * Example: \include MatrixBase_cwiseNotEqual.cpp |
| * Output: \verbinclude MatrixBase_cwiseNotEqual.out |
| * |
| * \sa cwiseEqual(), isApprox(), isMuchSmallerThan() |
| */ |
| template <typename OtherDerived> |
| EIGEN_DEVICE_FUNC inline const CwiseBinaryNotEqualReturnType<OtherDerived> cwiseNotEqual( |
| const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived>& other) const { |
| return CwiseBinaryNotEqualReturnType<OtherDerived>(derived(), other.derived()); |
| } |
| |
| /** \returns an expression of the coefficient-wise < operator of *this and \a other */ |
| template <typename OtherDerived> |
| EIGEN_DEVICE_FUNC inline const CwiseBinaryLessReturnType<OtherDerived> cwiseLess( |
| const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived>& other) const { |
| return CwiseBinaryLessReturnType<OtherDerived>(derived(), other.derived()); |
| } |
| |
| /** \returns an expression of the coefficient-wise > operator of *this and \a other */ |
| template <typename OtherDerived> |
| EIGEN_DEVICE_FUNC inline const CwiseBinaryGreaterReturnType<OtherDerived> cwiseGreater( |
| const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived>& other) const { |
| return CwiseBinaryGreaterReturnType<OtherDerived>(derived(), other.derived()); |
| } |
| |
| /** \returns an expression of the coefficient-wise <= operator of *this and \a other */ |
| template <typename OtherDerived> |
| EIGEN_DEVICE_FUNC inline const CwiseBinaryLessOrEqualReturnType<OtherDerived> cwiseLessOrEqual( |
| const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived>& other) const { |
| return CwiseBinaryLessOrEqualReturnType<OtherDerived>(derived(), other.derived()); |
| } |
| |
| /** \returns an expression of the coefficient-wise >= operator of *this and \a other */ |
| template <typename OtherDerived> |
| EIGEN_DEVICE_FUNC inline const CwiseBinaryGreaterOrEqualReturnType<OtherDerived> cwiseGreaterOrEqual( |
| const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived>& other) const { |
| return CwiseBinaryGreaterOrEqualReturnType<OtherDerived>(derived(), other.derived()); |
| } |
| |
| /** \returns an expression of the coefficient-wise min of *this and \a other |
| * |
| * Example: \include MatrixBase_cwiseMin.cpp |
| * Output: \verbinclude MatrixBase_cwiseMin.out |
| * |
| * \sa class CwiseBinaryOp, max() |
| */ |
| template <int NaNPropagation = PropagateFast, typename OtherDerived> |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const |
| CwiseBinaryOp<internal::scalar_min_op<Scalar, Scalar, NaNPropagation>, const Derived, const OtherDerived> |
| cwiseMin(const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived>& other) const { |
| return CwiseBinaryOp<internal::scalar_min_op<Scalar, Scalar, NaNPropagation>, const Derived, const OtherDerived>( |
| derived(), other.derived()); |
| } |
| |
| /** \returns an expression of the coefficient-wise min of *this and scalar \a other |
| * |
| * \sa class CwiseBinaryOp, min() |
| */ |
| template <int NaNPropagation = PropagateFast> |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const |
| CwiseBinaryOp<internal::scalar_min_op<Scalar, Scalar, NaNPropagation>, const Derived, const ConstantReturnType> |
| cwiseMin(const Scalar& other) const { |
| return cwiseMin<NaNPropagation>(Derived::Constant(rows(), cols(), other)); |
| } |
| |
| /** \returns an expression of the coefficient-wise max of *this and \a other |
| * |
| * Example: \include MatrixBase_cwiseMax.cpp |
| * Output: \verbinclude MatrixBase_cwiseMax.out |
| * |
| * \sa class CwiseBinaryOp, min() |
| */ |
| template <int NaNPropagation = PropagateFast, typename OtherDerived> |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const |
| CwiseBinaryOp<internal::scalar_max_op<Scalar, Scalar, NaNPropagation>, const Derived, const OtherDerived> |
| cwiseMax(const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived>& other) const { |
| return CwiseBinaryOp<internal::scalar_max_op<Scalar, Scalar, NaNPropagation>, const Derived, const OtherDerived>( |
| derived(), other.derived()); |
| } |
| |
| /** \returns an expression of the coefficient-wise max of *this and scalar \a other |
| * |
| * \sa class CwiseBinaryOp, min() |
| */ |
| template <int NaNPropagation = PropagateFast> |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const |
| CwiseBinaryOp<internal::scalar_max_op<Scalar, Scalar, NaNPropagation>, const Derived, const ConstantReturnType> |
| cwiseMax(const Scalar& other) const { |
| return cwiseMax<NaNPropagation>(Derived::Constant(rows(), cols(), other)); |
| } |
| |
| /** \returns an expression of the coefficient-wise quotient of *this and \a other |
| * |
| * Example: \include MatrixBase_cwiseQuotient.cpp |
| * Output: \verbinclude MatrixBase_cwiseQuotient.out |
| * |
| * \sa class CwiseBinaryOp, cwiseProduct(), cwiseInverse() |
| */ |
| template <typename OtherDerived> |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const |
| CwiseBinaryOp<internal::scalar_quotient_op<Scalar>, const Derived, const OtherDerived> |
| cwiseQuotient(const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived>& other) const { |
| return CwiseBinaryOp<internal::scalar_quotient_op<Scalar>, const Derived, const OtherDerived>(derived(), |
| other.derived()); |
| } |
| |
| using CwiseScalarEqualReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_EQ>, const Derived, const ConstantReturnType>; |
| using CwiseScalarNotEqualReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_NEQ>, const Derived, const ConstantReturnType>; |
| using CwiseScalarLessReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_LT>, const Derived, const ConstantReturnType>; |
| using CwiseScalarGreaterReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_GT>, const Derived, const ConstantReturnType>; |
| using CwiseScalarLessOrEqualReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_LE>, const Derived, const ConstantReturnType>; |
| using CwiseScalarGreaterOrEqualReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_GE>, const Derived, const ConstantReturnType>; |
| |
| /** \returns an expression of the coefficient-wise == operator of \c *this and a scalar \a s |
| * |
| * \warning this performs an exact comparison, which is generally a bad idea with floating-point types. |
| * In order to check for equality between two vectors or matrices with floating-point coefficients, it is |
| * generally a far better idea to use a fuzzy comparison as provided by isApprox() and |
| * isMuchSmallerThan(). |
| * |
| * \sa cwiseEqual(const MatrixBase<OtherDerived> &) const |
| */ |
| EIGEN_DEVICE_FUNC inline const CwiseScalarEqualReturnType cwiseEqual(const Scalar& s) const { |
| return CwiseScalarEqualReturnType(derived(), Derived::Constant(rows(), cols(), s)); |
| } |
| |
| /** \returns an expression of the coefficient-wise == operator of \c *this and a scalar \a s |
| * |
| * \warning this performs an exact comparison, which is generally a bad idea with floating-point types. |
| * In order to check for equality between two vectors or matrices with floating-point coefficients, it is |
| * generally a far better idea to use a fuzzy comparison as provided by isApprox() and |
| * isMuchSmallerThan(). |
| * |
| * \sa cwiseEqual(const MatrixBase<OtherDerived> &) const |
| */ |
| EIGEN_DEVICE_FUNC inline const CwiseScalarNotEqualReturnType cwiseNotEqual(const Scalar& s) const { |
| return CwiseScalarNotEqualReturnType(derived(), Derived::Constant(rows(), cols(), s)); |
| } |
| |
| /** \returns an expression of the coefficient-wise < operator of \c *this and a scalar \a s */ |
| EIGEN_DEVICE_FUNC inline const CwiseScalarLessReturnType cwiseLess(const Scalar& s) const { |
| return CwiseScalarLessReturnType(derived(), Derived::Constant(rows(), cols(), s)); |
| } |
| |
| /** \returns an expression of the coefficient-wise > operator of \c *this and a scalar \a s */ |
| EIGEN_DEVICE_FUNC inline const CwiseScalarGreaterReturnType cwiseGreater(const Scalar& s) const { |
| return CwiseScalarGreaterReturnType(derived(), Derived::Constant(rows(), cols(), s)); |
| } |
| |
| /** \returns an expression of the coefficient-wise <= operator of \c *this and a scalar \a s */ |
| EIGEN_DEVICE_FUNC inline const CwiseScalarLessOrEqualReturnType cwiseLessOrEqual(const Scalar& s) const { |
| return CwiseScalarLessOrEqualReturnType(derived(), Derived::Constant(rows(), cols(), s)); |
| } |
| |
| /** \returns an expression of the coefficient-wise >= operator of \c *this and a scalar \a s */ |
| EIGEN_DEVICE_FUNC inline const CwiseScalarGreaterOrEqualReturnType cwiseGreaterOrEqual(const Scalar& s) const { |
| return CwiseScalarGreaterOrEqualReturnType(derived(), Derived::Constant(rows(), cols(), s)); |
| } |
| |
| template <typename OtherDerived> |
| using CwiseBinaryTypedEqualReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_EQ, true>, const Derived, const OtherDerived>; |
| template <typename OtherDerived> |
| using CwiseBinaryTypedNotEqualReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_NEQ, true>, const Derived, const OtherDerived>; |
| template <typename OtherDerived> |
| using CwiseBinaryTypedLessReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_LT, true>, const Derived, const OtherDerived>; |
| template <typename OtherDerived> |
| using CwiseBinaryTypedGreaterReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_GT, true>, const Derived, const OtherDerived>; |
| template <typename OtherDerived> |
| using CwiseBinaryTypedLessOrEqualReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_LE, true>, const Derived, const OtherDerived>; |
| template <typename OtherDerived> |
| using CwiseBinaryTypedGreaterOrEqualReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_GE, true>, const Derived, const OtherDerived>; |
| |
| template <typename OtherDerived> |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryTypedEqualReturnType<OtherDerived> cwiseTypedEqual( |
| const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived>& other) const { |
| return CwiseBinaryTypedEqualReturnType<OtherDerived>(derived(), other.derived()); |
| } |
| |
| template <typename OtherDerived> |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryTypedNotEqualReturnType<OtherDerived> cwiseTypedNotEqual( |
| const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived>& other) const { |
| return CwiseBinaryTypedNotEqualReturnType<OtherDerived>(derived(), other.derived()); |
| } |
| |
| template <typename OtherDerived> |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryTypedLessReturnType<OtherDerived> cwiseTypedLess( |
| const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived>& other) const { |
| return CwiseBinaryTypedLessReturnType<OtherDerived>(derived(), other.derived()); |
| } |
| |
| template <typename OtherDerived> |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryTypedGreaterReturnType<OtherDerived> cwiseTypedGreater( |
| const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived>& other) const { |
| return CwiseBinaryTypedGreaterReturnType<OtherDerived>(derived(), other.derived()); |
| } |
| |
| template <typename OtherDerived> |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryTypedLessOrEqualReturnType<OtherDerived> cwiseTypedLessOrEqual( |
| const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived>& other) const { |
| return CwiseBinaryTypedLessOrEqualReturnType<OtherDerived>(derived(), other.derived()); |
| } |
| |
| template <typename OtherDerived> |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryTypedGreaterOrEqualReturnType<OtherDerived> |
| cwiseTypedGreaterOrEqual(const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived>& other) const { |
| return CwiseBinaryTypedGreaterOrEqualReturnType<OtherDerived>(derived(), other.derived()); |
| } |
| |
| using CwiseScalarTypedEqualReturnType = CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_EQ, true>, |
| const Derived, const ConstantReturnType>; |
| using CwiseScalarTypedNotEqualReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_NEQ, true>, const Derived, |
| const ConstantReturnType>; |
| using CwiseScalarTypedLessReturnType = CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_LT, true>, |
| const Derived, const ConstantReturnType>; |
| using CwiseScalarTypedGreaterReturnType = CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_GT, true>, |
| const Derived, const ConstantReturnType>; |
| using CwiseScalarTypedLessOrEqualReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_LE, true>, const Derived, |
| const ConstantReturnType>; |
| using CwiseScalarTypedGreaterOrEqualReturnType = |
| CwiseBinaryOp<internal::scalar_cmp_op<Scalar, Scalar, internal::cmp_GE, true>, const Derived, |
| const ConstantReturnType>; |
| |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseScalarTypedEqualReturnType cwiseTypedEqual(const Scalar& s) const { |
| return CwiseScalarTypedEqualReturnType(derived(), ConstantReturnType(rows(), cols(), s)); |
| } |
| |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseScalarTypedNotEqualReturnType |
| cwiseTypedNotEqual(const Scalar& s) const { |
| return CwiseScalarTypedNotEqualReturnType(derived(), ConstantReturnType(rows(), cols(), s)); |
| } |
| |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseScalarTypedLessReturnType cwiseTypedLess(const Scalar& s) const { |
| return CwiseScalarTypedLessReturnType(derived(), ConstantReturnType(rows(), cols(), s)); |
| } |
| |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseScalarTypedGreaterReturnType cwiseTypedGreater(const Scalar& s) const { |
| return CwiseScalarTypedGreaterReturnType(derived(), ConstantReturnType(rows(), cols(), s)); |
| } |
| |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseScalarTypedLessOrEqualReturnType |
| cwiseTypedLessOrEqual(const Scalar& s) const { |
| return CwiseScalarTypedLessOrEqualReturnType(derived(), ConstantReturnType(rows(), cols(), s)); |
| } |
| |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseScalarTypedGreaterOrEqualReturnType |
| cwiseTypedGreaterOrEqual(const Scalar& s) const { |
| return CwiseScalarTypedGreaterOrEqualReturnType(derived(), ConstantReturnType(rows(), cols(), s)); |
| } |
