* doc improvements in Cwise and PartialRedux:

  - 33 new snippets
  - unfuck doxygen output in Cwise (issues with function macros)
  - more see-also links from outside, making Cwise more discoverable
* rename matrixNorm() to operatorNorm(). There are many matrix norms
  (the L2 is another one) but only one is called the operator norm.
  Risk of confusion with keyword operator is not too scary after all.

5 files changed, 44 insertions, 12 deletions

diff --git a/Eigen/src/Core/Cwise.h b/Eigen/src/Core/Cwise.h
index d89800faa..0f81a8a4b 100644
--- a/Eigen/src/Core/Cwise.h
+++ b/Eigen/src/Core/Cwise.h
@@ -48,7 +48,10 @@
   *
   * Note that some methods are defined in the \ref Array module.
   *
-  * \sa MatrixBase::cwise()
+  * Example: \include MatrixBase_cwise_const.cpp
+  * Output: \verbinclude MatrixBase_cwise_const.out
+  *
+  * \sa MatrixBase::cwise() const, MatrixBase::cwise()
   */
 template<typename ExpressionType> class Cwise
 {
@@ -133,7 +136,10 @@ template<typename ExpressionType> class Cwise
 
 /** \returns a Cwise wrapper of *this providing additional coefficient-wise operations
   *
-  * \sa class Cwise
+  * Example: \include MatrixBase_cwise_const.cpp
+  * Output: \verbinclude MatrixBase_cwise_const.out
+  *
+  * \sa class Cwise, cwise()
   */
 template<typename Derived>
 inline const Cwise<Derived>
@@ -144,7 +150,10 @@ MatrixBase<Derived>::cwise() const
 
 /** \returns a Cwise wrapper of *this providing additional coefficient-wise operations
   *
-  * \sa class Cwise
+  * Example: \include MatrixBase_cwise.cpp
+  * Output: \verbinclude MatrixBase_cwise.out
+  *
+  * \sa class Cwise, cwise() const
   */
 template<typename Derived>
 inline Cwise<Derived>
diff --git a/Eigen/src/Core/CwiseBinaryOp.h b/Eigen/src/Core/CwiseBinaryOp.h
index dcf2c9063..2f506377f 100644
--- a/Eigen/src/Core/CwiseBinaryOp.h
+++ b/Eigen/src/Core/CwiseBinaryOp.h
@@ -125,7 +125,9 @@ class CwiseBinaryOp : ei_no_assignment_operator,
 
 /**\returns an expression of the difference of \c *this and \a other
   *
-  * \sa class CwiseBinaryOp, MatrixBase::operator-=()
+  * \note If you want to substract a given scalar from all coefficients, see Cwise::operator-().
+  *
+  * \sa class CwiseBinaryOp, MatrixBase::operator-=(), Cwise::operator-()
   */
 template<typename Derived>
 template<typename OtherDerived>
@@ -153,7 +155,9 @@ MatrixBase<Derived>::operator-=(const MatrixBase<OtherDerived> &other)
   *
   * \returns an expression of the sum of \c *this and \a other
   *
-  * \sa class CwiseBinaryOp, MatrixBase::operator+=()
+  * \note If you want to add a given scalar to all coefficients, see Cwise::operator+().
+  *
+  * \sa class CwiseBinaryOp, MatrixBase::operator+=(), Cwise::operator+()
   */
 template<typename Derived>
 template<typename OtherDerived>
@@ -177,12 +181,10 @@ MatrixBase<Derived>::operator+=(const MatrixBase<OtherDerived>& other)
 
 /** \returns an expression of the Schur product (coefficient wise product) of *this and \a other
   *
-  * \addexample CwiseProduct \label How to perform a component wise product of two matrices.
-  *
   * Example: \include Cwise_product.cpp
   * Output: \verbinclude Cwise_product.out
   * 
-  * \sa class CwiseBinaryOp
+  * \sa class CwiseBinaryOp, operator/(), square()
   */
 template<typename ExpressionType>
 template<typename OtherDerived>
@@ -194,7 +196,10 @@ Cwise<ExpressionType>::operator*(const MatrixBase<OtherDerived> &other) const
 
 /** \returns an expression of the coefficient-wise quotient of *this and \a other
   *
-  * \sa class CwiseBinaryOp
+  * Example: \include Cwise_quotient.cpp
+  * Output: \verbinclude Cwise_quotient.out
+  *
+  * \sa class CwiseBinaryOp, operator*(), inverse()
   */
 template<typename ExpressionType>
 template<typename OtherDerived>
@@ -206,6 +211,9 @@ Cwise<ExpressionType>::operator/(const MatrixBase<OtherDerived> &other) const
 
 /** \returns an expression of the coefficient-wise min of *this and \a other
   *
+  * Example: \include Cwise_min.cpp
+  * Output: \verbinclude Cwise_min.out
+  *
   * \sa class CwiseBinaryOp
   */
 template<typename ExpressionType>
@@ -218,6 +226,9 @@ Cwise<ExpressionType>::min(const MatrixBase<OtherDerived> &other) const
 
 /** \returns an expression of the coefficient-wise max of *this and \a other
   *
+  * Example: \include Cwise_max.cpp
+  * Output: \verbinclude Cwise_max.out
+  *
   * \sa class CwiseBinaryOp
   */
 template<typename ExpressionType>
diff --git a/Eigen/src/Core/CwiseUnaryOp.h b/Eigen/src/Core/CwiseUnaryOp.h
index e9aeb6608..85a8872c0 100644
--- a/Eigen/src/Core/CwiseUnaryOp.h
+++ b/Eigen/src/Core/CwiseUnaryOp.h
@@ -111,7 +111,7 @@ class CwiseUnaryOp : ei_no_assignment_operator,
   *
   * \addexample CustomCwiseUnaryFunctors \label How to use custom coeff wise unary functors
   *
-  * Here is an example:
+  * Example:
   * \include class_CwiseUnaryOp.cpp
   * Output: \verbinclude class_CwiseUnaryOp.out
   *
@@ -135,6 +135,11 @@ MatrixBase<Derived>::operator-() const
 }
 
 /** \returns an expression of the coefficient-wise absolute value of \c *this
+  *
+  * Example: \include Cwise_abs.cpp
+  * Output: \verbinclude Cwise_abs.out
+  *
+  * \sa abs2()
   */
 template<typename ExpressionType>
 inline const EIGEN_CWISE_UNOP_RETURN_TYPE(ei_scalar_abs_op)
@@ -144,6 +149,11 @@ Cwise<ExpressionType>::abs() const
 }
 
 /** \returns an expression of the coefficient-wise squared absolute value of \c *this
+  *
+  * Example: \include Cwise_abs2.cpp
+  * Output: \verbinclude Cwise_abs2.out
+  *
+  * \sa abs(), square()
   */
 template<typename ExpressionType>
 inline const EIGEN_CWISE_UNOP_RETURN_TYPE(ei_scalar_abs2_op)
diff --git a/Eigen/src/Core/MatrixBase.h b/Eigen/src/Core/MatrixBase.h
index 52b64283e..aa8e8983c 100644
--- a/Eigen/src/Core/MatrixBase.h
+++ b/Eigen/src/Core/MatrixBase.h
@@ -555,7 +555,7 @@ template<typename Derived> class MatrixBase
     const QR<EvalType> qr() const;
 
     EigenvaluesReturnType eigenvalues() const;
-    RealScalar matrixNorm() const;
+    RealScalar operatorNorm() const;
 
 /////////// Geometry module ///////////
 
diff --git a/Eigen/src/Core/Product.h b/Eigen/src/Core/Product.h
index 9bdbe3f26..2774b3f3b 100644
--- a/Eigen/src/Core/Product.h
+++ b/Eigen/src/Core/Product.h
@@ -261,7 +261,9 @@ template<typename LhsNested, typename RhsNested, int ProductMode> class Product
 
 /** \returns the matrix product of \c *this and \a other.
   *
-  * \sa lazy(), operator*=(const MatrixBase&)
+  * \note If instead of the matrix product you want the coefficient-wise product, see Cwise::operator*().
+  *
+  * \sa lazy(), operator*=(const MatrixBase&), Cwise::operator*()
   */
 template<typename Derived>
 template<typename OtherDerived>