diff options
author | Benoit Jacob <jacob.benoit.1@gmail.com> | 2010-04-18 22:14:55 -0400 |
---|---|---|
committer | Benoit Jacob <jacob.benoit.1@gmail.com> | 2010-04-18 22:14:55 -0400 |
commit | 504a31f643468d05a10e3474b76a61e80022df59 (patch) | |
tree | 7a1e64c8e95c001a998aa27d9ccb31a68a197339 /Eigen/src/Core/CwiseBinaryOp.h | |
parent | 34b14c48f31e5b794d48fd083f5fa39d7b4a6411 (diff) |
renaming (MatrixType ---> whatever appropriate)
and documentation improvements
Diffstat (limited to 'Eigen/src/Core/CwiseBinaryOp.h')
-rw-r--r-- | Eigen/src/Core/CwiseBinaryOp.h | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/Eigen/src/Core/CwiseBinaryOp.h b/Eigen/src/Core/CwiseBinaryOp.h index dd74f5b5c..18baf0307 100644 --- a/Eigen/src/Core/CwiseBinaryOp.h +++ b/Eigen/src/Core/CwiseBinaryOp.h @@ -28,18 +28,19 @@ /** \class CwiseBinaryOp * - * \brief Generic expression of a coefficient-wise operator between two matrices or vectors + * \brief Generic expression where a coefficient-wise binary operator is applied to two expressions * * \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-, and the Cwise methods, and most - * of the time this is the only way it is used. + * This class represents an expression where a coefficient-wise binary operator is applied to two expressions. + * It is the return type of binary operators, by which we mean only those binary operators where + * both the left-hand side and the right-hand side are Eigen expressions. + * For example, the return type of matrix1+matrix2 is a CwiseBinaryOp. * - * However, if you want to write a function returning such an expression, you - * will need to use this class. + * Most of the time, this is the only way that it is used, so you typically don't have to name + * CwiseBinaryOp types explicitly. * * \sa MatrixBase::binaryExpr(const MatrixBase<OtherDerived> &,const CustomBinaryOp &) const, class CwiseUnaryOp, class CwiseNullaryOp */ |