devtools/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2026-04-10 11:34:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

some documentation fixes (Cwise* and Cholesky)

Browse Source
This commit is contained in:
Gael Guennebaud
2008-05-22 16:31:00 +00:00
parent 94e1629a1b
commit 8f1fc80a77
9 changed files with 24 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Eigen/src/Core/CwiseBinaryOp.h
View File

@@ -41,10 +41,7 @@
* However, if you want to write a function returning such an expression, you
* will need to use this class.
*
* Here is an example illustrating this:
* \include class_CwiseBinaryOp.cpp
*
* \sa class ei_scalar_product_op, class ei_scalar_quotient_op
* \sa MatrixBase::cwise(const MatrixBase<OtherDerived> &,const CustomBinaryOp &) const, class CwiseUnaryOp, class CwiseNullaryOp
*/
template<typename BinaryOp, typename Lhs, typename Rhs>
struct ei_traits<CwiseBinaryOp<BinaryOp, Lhs, Rhs> >
@@ -220,6 +217,10 @@ MatrixBase<Derived>::cwiseMax(const MatrixBase<OtherDerived> &other) const
* The template parameter \a CustomBinaryOp is the type of the functor
* of the custom operator (see class CwiseBinaryOp for an example)
*
* Here is an example illustrating the use of custom functors:
* \include class_CwiseBinaryOp.cpp
* Output: \verbinclude class_CwiseBinaryOp.out
*
* \sa class CwiseBinaryOp, MatrixBase::operator+, MatrixBase::operator-, MatrixBase::cwiseProduct, MatrixBase::cwiseQuotient
*/
template<typename Derived>

1
Eigen/src/Core/CwiseNullaryOp.h
View File

@@ -38,6 +38,7 @@
* However, if you want to write a function returning such an expression, you
* will need to use this class.
*
* \sa class CwiseUnaryOp, class CwiseBinaryOp, MatrixBase::create()
*/
template<typename NullaryOp, typename MatrixType>
struct ei_traits<CwiseNullaryOp<NullaryOp, MatrixType> >

3
Eigen/src/Core/CwiseUnaryOp.h
View File

@@ -37,7 +37,7 @@
* It is the return type of the unary operator-, of a matrix or a vector, and most
* of the time this is the only way it is used.
*
* \sa class CwiseBinaryOp
* \sa MatrixBase::cwise(const CustomUnaryOp &) const, class CwiseBinaryOp, class CwiseNullaryOp
*/
template<typename UnaryOp, typename MatrixType>
struct ei_traits<CwiseUnaryOp<UnaryOp, MatrixType> >
@@ -100,6 +100,7 @@ class CwiseUnaryOp : ei_no_assignment_operator,
*
* Here is an example:
* \include class_CwiseUnaryOp.cpp
* Output: \verbinclude class_CwiseUnaryOp.out
*
* \sa class CwiseUnaryOp, class CwiseBinarOp, MatrixBase::operator-, MatrixBase::cwiseAbs
*/