diff options
author | 2010-04-18 22:14:55 -0400 | |
---|---|---|
committer | 2010-04-18 22:14:55 -0400 | |
commit | 504a31f643468d05a10e3474b76a61e80022df59 (patch) | |
tree | 7a1e64c8e95c001a998aa27d9ccb31a68a197339 /Eigen/src/plugins | |
parent | 34b14c48f31e5b794d48fd083f5fa39d7b4a6411 (diff) |
renaming (MatrixType ---> whatever appropriate)
and documentation improvements
Diffstat (limited to 'Eigen/src/plugins')
-rw-r--r-- | Eigen/src/plugins/ArrayCwiseBinaryOps.h | 121 | ||||
-rw-r--r-- | Eigen/src/plugins/CommonCwiseBinaryOps.h | 6 | ||||
-rw-r--r-- | Eigen/src/plugins/CommonCwiseUnaryOps.h | 18 | ||||
-rw-r--r-- | Eigen/src/plugins/MatrixCwiseBinaryOps.h | 12 | ||||
-rw-r--r-- | Eigen/src/plugins/MatrixCwiseUnaryOps.h | 4 |
5 files changed, 20 insertions, 141 deletions
diff --git a/Eigen/src/plugins/ArrayCwiseBinaryOps.h b/Eigen/src/plugins/ArrayCwiseBinaryOps.h index 87d1d4145..b48a58234 100644 --- a/Eigen/src/plugins/ArrayCwiseBinaryOps.h +++ b/Eigen/src/plugins/ArrayCwiseBinaryOps.h @@ -1,4 +1,3 @@ - /** \returns an expression of the coefficient wise product of \c *this and \a other * * \sa MatrixBase::cwiseProduct @@ -88,13 +87,6 @@ EIGEN_MAKE_CWISE_BINARY_OP(operator>=,std::greater_equal) * \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 * @@ -109,95 +101,6 @@ EIGEN_MAKE_CWISE_BINARY_OP(operator==,std::equal_to) * \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 @@ -220,18 +123,6 @@ operator+(const Scalar& scalar,const EIGEN_CURRENT_STORAGE_BASE_CLASS<Derived>& 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 @@ -250,15 +141,3 @@ operator-(const Scalar& scalar,const EIGEN_CURRENT_STORAGE_BASE_CLASS<Derived>& { 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; -// } diff --git a/Eigen/src/plugins/CommonCwiseBinaryOps.h b/Eigen/src/plugins/CommonCwiseBinaryOps.h index 762cb3b8c..400a7b0e0 100644 --- a/Eigen/src/plugins/CommonCwiseBinaryOps.h +++ b/Eigen/src/plugins/CommonCwiseBinaryOps.h @@ -29,7 +29,7 @@ * * \note If you want to substract a given scalar from all coefficients, see Cwise::operator-(). * - * \sa class CwiseBinaryOp, MatrixBase::operator-=() + * \sa class CwiseBinaryOp, operator-=() */ EIGEN_MAKE_CWISE_BINARY_OP(operator-,ei_scalar_difference_op) @@ -37,7 +37,7 @@ EIGEN_MAKE_CWISE_BINARY_OP(operator-,ei_scalar_difference_op) * * \note If you want to add a given scalar to all coefficients, see Cwise::operator+(). * - * \sa class CwiseBinaryOp, MatrixBase::operator+=() + * \sa class CwiseBinaryOp, operator+=() */ EIGEN_MAKE_CWISE_BINARY_OP(operator+,ei_scalar_sum_op) @@ -50,7 +50,7 @@ EIGEN_MAKE_CWISE_BINARY_OP(operator+,ei_scalar_sum_op) * \include class_CwiseBinaryOp.cpp * Output: \verbinclude class_CwiseBinaryOp.out * - * \sa class CwiseBinaryOp, MatrixBase::operator+, MatrixBase::operator-, MatrixBase::cwiseProduct + * \sa class CwiseBinaryOp, operator+, operator-, cwiseProduct */ template<typename CustomBinaryOp, typename OtherDerived> EIGEN_STRONG_INLINE const CwiseBinaryOp<CustomBinaryOp, Derived, OtherDerived> diff --git a/Eigen/src/plugins/CommonCwiseUnaryOps.h b/Eigen/src/plugins/CommonCwiseUnaryOps.h index ec76ca38f..74601c2d2 100644 --- a/Eigen/src/plugins/CommonCwiseUnaryOps.h +++ b/Eigen/src/plugins/CommonCwiseUnaryOps.h @@ -27,28 +27,28 @@ #ifndef EIGEN_PARSED_BY_DOXYGEN -/** \internal Represents a scalar multiple of a matrix */ +/** \internal Represents a scalar multiple of an expression */ typedef CwiseUnaryOp<ei_scalar_multiple_op<Scalar>, Derived> ScalarMultipleReturnType; -/** \internal Represents a quotient of a matrix by a scalar*/ +/** \internal Represents a quotient of an expression by a scalar*/ typedef CwiseUnaryOp<ei_scalar_quotient1_op<Scalar>, Derived> ScalarQuotient1ReturnType; -/** \internal the return type of MatrixBase::conjugate() */ +/** \internal the return type of conjugate() */ typedef typename ei_meta_if<NumTraits<Scalar>::IsComplex, const CwiseUnaryOp<ei_scalar_conjugate_op<Scalar>, Derived>, const Derived& >::ret ConjugateReturnType; -/** \internal the return type of MatrixBase::real() const */ +/** \internal the return type of real() const */ typedef typename ei_meta_if<NumTraits<Scalar>::IsComplex, const CwiseUnaryOp<ei_scalar_real_op<Scalar>, Derived>, const Derived& >::ret RealReturnType; -/** \internal the return type of MatrixBase::real() */ +/** \internal the return type of real() */ typedef typename ei_meta_if<NumTraits<Scalar>::IsComplex, CwiseUnaryView<ei_scalar_real_op<Scalar>, Derived>, Derived& >::ret NonConstRealReturnType; -/** \internal the return type of MatrixBase::imag() const */ +/** \internal the return type of imag() const */ typedef CwiseUnaryOp<ei_scalar_imag_op<Scalar>, Derived> ImagReturnType; -/** \internal the return type of MatrixBase::imag() */ +/** \internal the return type of imag() */ typedef CwiseUnaryView<ei_scalar_imag_op<Scalar>, Derived> NonConstImagReturnType; #endif // not EIGEN_PARSED_BY_DOXYGEN @@ -139,7 +139,7 @@ imag() const { return derived(); } * \include class_CwiseUnaryOp.cpp * Output: \verbinclude class_CwiseUnaryOp.out * - * \sa class CwiseUnaryOp, class CwiseBinarOp, MatrixBase::operator-, Cwise::abs + * \sa class CwiseUnaryOp, class CwiseBinarOp */ template<typename CustomUnaryOp> inline const CwiseUnaryOp<CustomUnaryOp, Derived> @@ -157,7 +157,7 @@ unaryExpr(const CustomUnaryOp& func = CustomUnaryOp()) const * \include class_CwiseUnaryOp.cpp * Output: \verbinclude class_CwiseUnaryOp.out * - * \sa class CwiseUnaryOp, class CwiseBinarOp, MatrixBase::operator-, Cwise::abs + * \sa class CwiseUnaryOp, class CwiseBinarOp */ template<typename CustomViewOp> inline const CwiseUnaryView<CustomViewOp, Derived> diff --git a/Eigen/src/plugins/MatrixCwiseBinaryOps.h b/Eigen/src/plugins/MatrixCwiseBinaryOps.h index 1efe7b314..dd91fbd75 100644 --- a/Eigen/src/plugins/MatrixCwiseBinaryOps.h +++ b/Eigen/src/plugins/MatrixCwiseBinaryOps.h @@ -43,13 +43,13 @@ cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived> &other) const * * \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 MatrixBase::isApprox() and - * MatrixBase::isMuchSmallerThan(). + * 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 MatrixBase::cwiseNotEqual(), MatrixBase::isApprox(), MatrixBase::isMuchSmallerThan() + * \sa cwiseNotEqual(), isApprox(), isMuchSmallerThan() */ template<typename OtherDerived> inline const CwiseBinaryOp<std::equal_to<Scalar>, Derived, OtherDerived> @@ -62,13 +62,13 @@ cwiseEqual(const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived> &other) const * * \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 MatrixBase::isApprox() and - * MatrixBase::isMuchSmallerThan(). + * 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 MatrixBase::cwiseEqual(), MatrixBase::isApprox(), MatrixBase::isMuchSmallerThan() + * \sa cwiseEqual(), isApprox(), isMuchSmallerThan() */ template<typename OtherDerived> inline const CwiseBinaryOp<std::not_equal_to<Scalar>, Derived, OtherDerived> diff --git a/Eigen/src/plugins/MatrixCwiseUnaryOps.h b/Eigen/src/plugins/MatrixCwiseUnaryOps.h index 8927711ed..6ffaf675c 100644 --- a/Eigen/src/plugins/MatrixCwiseUnaryOps.h +++ b/Eigen/src/plugins/MatrixCwiseUnaryOps.h @@ -69,8 +69,8 @@ cwiseInverse() const { return derived(); } * * \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 MatrixBase::isApprox() and - * MatrixBase::isMuchSmallerThan(). + * generally a far better idea to use a fuzzy comparison as provided by isApprox() and + * isMuchSmallerThan(). * * \sa cwiseEqual(const MatrixBase<OtherDerived> &) const */ |