mirror of
https://gitlab.com/libeigen/eigen.git
synced 2025-07-19 19:34:29 +08:00

- update the tutorial - update doc of deprecated cwise function - update cwise doc snippets
265 lines
9.2 KiB
C++
265 lines
9.2 KiB
C++
|
|
/** \returns an expression of the coefficient wise product of \c *this and \a other
|
|
*
|
|
* \sa MatrixBase::cwiseProduct
|
|
*/
|
|
template<typename OtherDerived>
|
|
EIGEN_STRONG_INLINE const EIGEN_CWISE_PRODUCT_RETURN_TYPE(Derived,OtherDerived)
|
|
operator*(const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived> &other) const
|
|
{
|
|
return EIGEN_CWISE_PRODUCT_RETURN_TYPE(Derived,OtherDerived)(derived(), other.derived());
|
|
}
|
|
|
|
/** \returns an expression of the coefficient wise quotient of \c *this and \a other
|
|
*
|
|
* \sa MatrixBase::cwiseQuotient
|
|
*/
|
|
template<typename OtherDerived>
|
|
EIGEN_STRONG_INLINE const CwiseBinaryOp<ei_scalar_quotient_op<Scalar>, Derived, OtherDerived>
|
|
operator/(const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived> &other) const
|
|
{
|
|
return CwiseBinaryOp<ei_scalar_quotient_op<Scalar>, Derived, OtherDerived>(derived(), other.derived());
|
|
}
|
|
|
|
/** \returns an expression of the coefficient-wise min of \c *this and \a other
|
|
*
|
|
* Example: \include Cwise_min.cpp
|
|
* Output: \verbinclude Cwise_min.out
|
|
*
|
|
* \sa max()
|
|
*/
|
|
EIGEN_MAKE_CWISE_BINARY_OP(min,ei_scalar_min_op)
|
|
|
|
/** \returns an expression of the coefficient-wise max of \c *this and \a other
|
|
*
|
|
* Example: \include Cwise_max.cpp
|
|
* Output: \verbinclude Cwise_max.out
|
|
*
|
|
* \sa min()
|
|
*/
|
|
EIGEN_MAKE_CWISE_BINARY_OP(max,ei_scalar_max_op)
|
|
|
|
/** \returns an expression of the coefficient-wise \< operator of *this and \a other
|
|
*
|
|
* Example: \include Cwise_less.cpp
|
|
* Output: \verbinclude Cwise_less.out
|
|
*
|
|
* \sa all(), any(), operator>(), operator<=()
|
|
*/
|
|
EIGEN_MAKE_CWISE_BINARY_OP(operator<,std::less)
|
|
|
|
/** \returns an expression of the coefficient-wise \<= operator of *this and \a other
|
|
*
|
|
* Example: \include Cwise_less_equal.cpp
|
|
* Output: \verbinclude Cwise_less_equal.out
|
|
*
|
|
* \sa all(), any(), operator>=(), operator<()
|
|
*/
|
|
EIGEN_MAKE_CWISE_BINARY_OP(operator<=,std::less_equal)
|
|
|
|
/** \returns an expression of the coefficient-wise \> operator of *this and \a other
|
|
*
|
|
* Example: \include Cwise_greater.cpp
|
|
* Output: \verbinclude Cwise_greater.out
|
|
*
|
|
* \sa all(), any(), operator>=(), operator<()
|
|
*/
|
|
EIGEN_MAKE_CWISE_BINARY_OP(operator>,std::greater)
|
|
|
|
/** \returns an expression of the coefficient-wise \>= operator of *this and \a other
|
|
*
|
|
* Example: \include Cwise_greater_equal.cpp
|
|
* Output: \verbinclude Cwise_greater_equal.out
|
|
*
|
|
* \sa all(), any(), operator>(), operator<=()
|
|
*/
|
|
EIGEN_MAKE_CWISE_BINARY_OP(operator>=,std::greater_equal)
|
|
|
|
/** \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 Cwise_equal_equal.cpp
|
|
* Output: \verbinclude Cwise_equal_equal.out
|
|
*
|
|
* \sa all(), any(), isApprox(), isMuchSmallerThan()
|
|
*/
|
|
EIGEN_MAKE_CWISE_BINARY_OP(operator==,std::equal_to)
|
|
// template<typename ExpressionType>
|
|
// template<typename OtherDerived>
|
|
// inline const EIGEN_CWISE_BINOP_RETURN_TYPE(std::equal_to)
|
|
// operator==(const MatrixBase<OtherDerived> &other) const
|
|
// {
|
|
// return EIGEN_CWISE_BINOP_RETURN_TYPE(std::equal_to)(_expression(), 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 Cwise_not_equal.cpp
|
|
* Output: \verbinclude Cwise_not_equal.out
|
|
*
|
|
* \sa all(), any(), isApprox(), isMuchSmallerThan()
|
|
*/
|
|
EIGEN_MAKE_CWISE_BINARY_OP(operator!=,std::not_equal_to)
|
|
// template<typename ExpressionType>
|
|
// template<typename OtherDerived>
|
|
// inline const EIGEN_CWISE_BINOP_RETURN_TYPE(std::not_equal_to)
|
|
// operator!=(const MatrixBase<OtherDerived> &other) const
|
|
// {
|
|
// return EIGEN_CWISE_BINOP_RETURN_TYPE(std::not_equal_to)(_expression(), other.derived());
|
|
// }
|
|
|
|
// comparisons to scalar value
|
|
|
|
#if 0
|
|
|
|
/** \returns an expression of the coefficient-wise \< operator of *this and a scalar \a s
|
|
*
|
|
* \sa operator<(const MatrixBase<OtherDerived> &) const
|
|
*/
|
|
inline const EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE(std::less)
|
|
operator<(Scalar s) const
|
|
{
|
|
return EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE(std::less)(_expression(),
|
|
typename ExpressionType::ConstantReturnType(_expression().rows(), _expression().cols(), s));
|
|
}
|
|
|
|
/** \returns an expression of the coefficient-wise \<= operator of *this and a scalar \a s
|
|
*
|
|
* \sa operator<=(const MatrixBase<OtherDerived> &) const
|
|
*/
|
|
inline const EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE(std::less_equal)
|
|
operator<=(Scalar s) const
|
|
{
|
|
return EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE(std::less_equal)(_expression(),
|
|
typename ExpressionType::ConstantReturnType(_expression().rows(), _expression().cols(), s));
|
|
}
|
|
|
|
/** \returns an expression of the coefficient-wise \> operator of *this and a scalar \a s
|
|
*
|
|
* \sa operator>(const MatrixBase<OtherDerived> &) const
|
|
*/
|
|
inline const EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE(std::greater)
|
|
operator>(Scalar s) const
|
|
{
|
|
return EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE(std::greater)(_expression(),
|
|
typename ExpressionType::ConstantReturnType(_expression().rows(), _expression().cols(), s));
|
|
}
|
|
|
|
/** \returns an expression of the coefficient-wise \>= operator of *this and a scalar \a s
|
|
*
|
|
* \sa operator>=(const MatrixBase<OtherDerived> &) const
|
|
*/
|
|
inline const EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE(std::greater_equal)
|
|
operator>=(Scalar s) const
|
|
{
|
|
return EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE(std::greater_equal)(_expression(),
|
|
typename ExpressionType::ConstantReturnType(_expression().rows(), _expression().cols(), s));
|
|
}
|
|
|
|
/** \returns an expression of the coefficient-wise == operator of *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 operator==(const MatrixBase<OtherDerived> &) const
|
|
*/
|
|
inline const EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE(std::equal_to)
|
|
operator==(Scalar s) const
|
|
{
|
|
return EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE(std::equal_to)(_expression(),
|
|
typename ExpressionType::ConstantReturnType(_expression().rows(), _expression().cols(), s));
|
|
}
|
|
|
|
/** \returns an expression of the coefficient-wise != operator of *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 operator!=(const MatrixBase<OtherDerived> &) const
|
|
*/
|
|
inline const EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE(std::not_equal_to)
|
|
operator!=(Scalar s) const
|
|
{
|
|
return EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE(std::not_equal_to)(_expression(),
|
|
typename ExpressionType::ConstantReturnType(_expression().rows(), _expression().cols(), s));
|
|
}
|
|
|
|
#endif
|
|
|
|
// scalar addition
|
|
|
|
/** \returns an expression of \c *this with each coeff incremented by the constant \a scalar
|
|
*
|
|
* Example: \include Cwise_plus.cpp
|
|
* Output: \verbinclude Cwise_plus.out
|
|
*
|
|
* \sa operator+=(), operator-()
|
|
*/
|
|
inline const CwiseUnaryOp<ei_scalar_add_op<Scalar>, Derived>
|
|
operator+(const Scalar& scalar) const
|
|
{
|
|
return CwiseUnaryOp<ei_scalar_add_op<Scalar>, Derived>(derived(), ei_scalar_add_op<Scalar>(scalar));
|
|
}
|
|
|
|
friend inline const CwiseUnaryOp<ei_scalar_add_op<Scalar>, Derived>
|
|
operator+(const Scalar& scalar,const EIGEN_CURRENT_STORAGE_BASE_CLASS<Derived>& other)
|
|
{
|
|
return other + scalar;
|
|
}
|
|
|
|
/** Adds the given \a scalar to each coeff of this expression.
|
|
*
|
|
* Example: \include Cwise_plus_equal.cpp
|
|
* Output: \verbinclude Cwise_plus_equal.out
|
|
*
|
|
* \sa operator+(), operator-=()
|
|
*/
|
|
// inline Derived& operator+=(const Scalar& scalar)
|
|
// {
|
|
// return derived() = *this + scalar;
|
|
// }
|
|
|
|
/** \returns an expression of \c *this with each coeff decremented by the constant \a scalar
|
|
*
|
|
* Example: \include Cwise_minus.cpp
|
|
* Output: \verbinclude Cwise_minus.out
|
|
*
|
|
* \sa operator+(), operator-=()
|
|
*/
|
|
inline const CwiseUnaryOp<ei_scalar_add_op<Scalar>, Derived>
|
|
operator-(const Scalar& scalar) const
|
|
{
|
|
return *this + (-scalar);
|
|
}
|
|
|
|
friend inline const CwiseUnaryOp<ei_scalar_add_op<Scalar>, Derived>
|
|
operator-(const Scalar& scalar,const EIGEN_CURRENT_STORAGE_BASE_CLASS<Derived>& other)
|
|
{
|
|
return other + (-scalar);
|
|
}
|
|
|
|
/** Substracts the given \a scalar from each coeff of this expression.
|
|
*
|
|
* Example: \include Cwise_minus_equal.cpp
|
|
* Output: \verbinclude Cwise_minus_equal.out
|
|
*
|
|
* \sa operator+=(), operator-()
|
|
*/
|
|
// inline Derived& operator-=(const Scalar& scalar)
|
|
// {
|
|
// return derived() = *this - scalar;
|
|
// }
|