aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
Diffstat
-rw-r--r--Eigen/src/Array/BooleanRedux.h8
-rw-r--r--Eigen/src/Array/Random.h10
-rw-r--r--Eigen/src/Core/Block.h10
-rw-r--r--Eigen/src/Core/CommaInitializer.h2
-rw-r--r--Eigen/src/Core/CwiseBinaryOp.h2
-rw-r--r--Eigen/src/Core/CwiseNullaryOp.h6
-rw-r--r--Eigen/src/Core/CwiseUnaryOp.h2
-rw-r--r--Eigen/src/Core/CwiseUnaryView.h2
-rw-r--r--Eigen/src/Core/DiagonalMatrix.h26
-rw-r--r--Eigen/src/Core/VectorBlock.h12
-rw-r--r--Eigen/src/Geometry/AngleAxis.h4
-rw-r--r--doc/Doxyfile.in1
-rw-r--r--unsupported/Eigen/BVH2
-rw-r--r--unsupported/doc/Doxyfile.in1
14 files changed, 22 insertions, 66 deletions
diff --git a/Eigen/src/Array/BooleanRedux.h b/Eigen/src/Array/BooleanRedux.h
index 6a5e208de..ab6e06d56 100644
--- a/Eigen/src/Array/BooleanRedux.h
+++ b/Eigen/src/Array/BooleanRedux.h
@@ -78,10 +78,8 @@ struct ei_any_unroller<Derived, Dynamic>
};
/** \array_module
- *
- * \returns true if all coefficients are true
*
- * \addexample CwiseAll \label How to check whether a point is inside a box (using operator< and all())
+ * \returns true if all coefficients are true
*
* Example: \include MatrixBase_all.cpp
* Output: \verbinclude MatrixBase_all.out
@@ -107,7 +105,7 @@ inline bool MatrixBase<Derived>::all() const
}
/** \array_module
- *
+ *
* \returns true if at least one coefficient is true
*
* \sa MatrixBase::all()
@@ -131,7 +129,7 @@ inline bool MatrixBase<Derived>::any() const
}
/** \array_module
- *
+ *
* \returns the number of coefficients which evaluate to true
*
* \sa MatrixBase::all(), MatrixBase::any()
diff --git a/Eigen/src/Array/Random.h b/Eigen/src/Array/Random.h
index 15cc6ae7c..adadf99e3 100644
--- a/Eigen/src/Array/Random.h
+++ b/Eigen/src/Array/Random.h
@@ -34,7 +34,7 @@ struct ei_functor_traits<ei_scalar_random_op<Scalar> >
{ enum { Cost = 5 * NumTraits<Scalar>::MulCost, PacketAccess = false, IsRepeatable = false }; };
/** \array_module
- *
+ *
* \returns a random matrix expression
*
* The parameters \a rows and \a cols are the number of rows and of columns of
@@ -44,8 +44,6 @@ struct ei_functor_traits<ei_scalar_random_op<Scalar> >
* it is redundant to pass \a rows and \a cols as arguments, so Random() should be used
* instead.
*
- * \addexample RandomExample \label How to create a matrix with random coefficients
- *
* Example: \include MatrixBase_random_int_int.cpp
* Output: \verbinclude MatrixBase_random_int_int.out
*
@@ -63,7 +61,7 @@ MatrixBase<Derived>::Random(int rows, int cols)
}
/** \array_module
- *
+ *
* \returns a random vector expression
*
* The parameter \a size is the size of the returned vector.
@@ -92,7 +90,7 @@ MatrixBase<Derived>::Random(int size)
}
/** \array_module
- *
+ *
* \returns a fixed-size random matrix or vector expression
*
* This variant is only for fixed-size MatrixBase types. For dynamic-size types, you
@@ -115,7 +113,7 @@ MatrixBase<Derived>::Random()
}
/** \array_module
- *
+ *
* Sets all coefficients in this expression to random values.
*
* Example: \include MatrixBase_setRandom.cpp
diff --git a/Eigen/src/Core/Block.h b/Eigen/src/Core/Block.h
index 42d6bc3c3..cebfeaf75 100644
--- a/Eigen/src/Core/Block.h
+++ b/Eigen/src/Core/Block.h
@@ -308,8 +308,6 @@ class Block<MatrixType,BlockRows,BlockCols,PacketAccess,HasDirectAccess>
* \param blockRows the number of rows in the block
* \param blockCols the number of columns in the block
*
- * \addexample BlockIntIntIntInt \label How to reference a sub-matrix (dynamic-size)
- *
* Example: \include MatrixBase_block_int_int_int_int.cpp
* Output: \verbinclude MatrixBase_block_int_int_int_int.out
*
@@ -341,8 +339,6 @@ inline const typename BlockReturnType<Derived>::Type MatrixBase<Derived>
* \param cRows the number of rows in the corner
* \param cCols the number of columns in the corner
*
- * \addexample BlockCornerDynamicSize \label How to reference a sub-corner of a matrix
- *
* Example: \include MatrixBase_corner_enum_int_int.cpp
* Output: \verbinclude MatrixBase_corner_enum_int_int.out
*
@@ -452,8 +448,6 @@ MatrixBase<Derived>::corner(CornerType type) const
* \param startRow the first row in the block
* \param startCol the first column in the block
*
- * \addexample BlockSubMatrixFixedSize \label How to reference a sub-matrix (fixed-size)
- *
* Example: \include MatrixBase_block_int_int.cpp
* Output: \verbinclude MatrixBase_block_int_int.out
*
@@ -481,8 +475,6 @@ MatrixBase<Derived>::block(int startRow, int startCol) const
/** \returns an expression of the \a i-th column of *this. Note that the numbering starts at 0.
*
- * \addexample BlockColumn \label How to reference a single column of a matrix
- *
* Example: \include MatrixBase_col.cpp
* Output: \verbinclude MatrixBase_col.out
*
@@ -504,8 +496,6 @@ MatrixBase<Derived>::col(int i) const
/** \returns an expression of the \a i-th row of *this. Note that the numbering starts at 0.
*
- * \addexample BlockRow \label How to reference a single row of a matrix
- *
* Example: \include MatrixBase_row.cpp
* Output: \verbinclude MatrixBase_row.out
*
diff --git a/Eigen/src/Core/CommaInitializer.h b/Eigen/src/Core/CommaInitializer.h
index c0dd701f2..e86f47ad0 100644
--- a/Eigen/src/Core/CommaInitializer.h
+++ b/Eigen/src/Core/CommaInitializer.h
@@ -124,8 +124,6 @@ struct CommaInitializer
* The coefficients must be provided in a row major order and exactly match
* the size of the matrix. Otherwise an assertion is raised.
*
- * \addexample CommaInit \label How to easily set all the coefficients of a matrix
- *
* Example: \include MatrixBase_set.cpp
* Output: \verbinclude MatrixBase_set.out
*
diff --git a/Eigen/src/Core/CwiseBinaryOp.h b/Eigen/src/Core/CwiseBinaryOp.h
index 78de9fbce..875bc9aa5 100644
--- a/Eigen/src/Core/CwiseBinaryOp.h
+++ b/Eigen/src/Core/CwiseBinaryOp.h
@@ -291,8 +291,6 @@ Cwise<ExpressionType>::max(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)
*
- * \addexample CustomCwiseBinaryFunctors \label How to use custom coeff wise binary functors
- *
* Here is an example illustrating the use of custom functors:
* \include class_CwiseBinaryOp.cpp
* Output: \verbinclude class_CwiseBinaryOp.out
diff --git a/Eigen/src/Core/CwiseNullaryOp.h b/Eigen/src/Core/CwiseNullaryOp.h
index 804bc2e74..61ce51885 100644
--- a/Eigen/src/Core/CwiseNullaryOp.h
+++ b/Eigen/src/Core/CwiseNullaryOp.h
@@ -317,8 +317,6 @@ Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>::setConstant(int row
* it is redundant to pass \a rows and \a cols as arguments, so Zero() should be used
* instead.
*
- * \addexample Zero \label How to take get a zero matrix
- *
* Example: \include MatrixBase_zero_int_int.cpp
* Output: \verbinclude MatrixBase_zero_int_int.out
*
@@ -448,8 +446,6 @@ Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>::setZero(int rows, i
* it is redundant to pass \a rows and \a cols as arguments, so Ones() should be used
* instead.
*
- * \addexample One \label How to get a matrix with all coefficients equal one
- *
* Example: \include MatrixBase_ones_int_int.cpp
* Output: \verbinclude MatrixBase_ones_int_int.out
*
@@ -576,8 +572,6 @@ Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>::setOnes(int rows, i
* it is redundant to pass \a rows and \a cols as arguments, so Identity() should be used
* instead.
*
- * \addexample Identity \label How to get an identity matrix
- *
* Example: \include MatrixBase_identity_int_int.cpp
* Output: \verbinclude MatrixBase_identity_int_int.out
*
diff --git a/Eigen/src/Core/CwiseUnaryOp.h b/Eigen/src/Core/CwiseUnaryOp.h
index d701c25d9..6e4c0d4ec 100644
--- a/Eigen/src/Core/CwiseUnaryOp.h
+++ b/Eigen/src/Core/CwiseUnaryOp.h
@@ -109,8 +109,6 @@ class CwiseUnaryOp : ei_no_assignment_operator,
* The template parameter \a CustomUnaryOp is the type of the functor
* of the custom unary operator.
*
- * \addexample CustomCwiseUnaryFunctors \label How to use custom coeff wise unary functors
- *
* Example:
* \include class_CwiseUnaryOp.cpp
* Output: \verbinclude class_CwiseUnaryOp.out
diff --git a/Eigen/src/Core/CwiseUnaryView.h b/Eigen/src/Core/CwiseUnaryView.h
index 4b7d87953..580344379 100644
--- a/Eigen/src/Core/CwiseUnaryView.h
+++ b/Eigen/src/Core/CwiseUnaryView.h
@@ -98,8 +98,6 @@ class CwiseUnaryView : public MatrixBase<CwiseUnaryView<ViewOp, MatrixType> >
* The template parameter \a CustomUnaryOp is the type of the functor
* of the custom unary operator.
*
- * \addexample CustomCwiseUnaryFunctors \label How to use custom coeff wise unary functors
- *
* Example:
* \include class_CwiseUnaryOp.cpp
* Output: \verbinclude class_CwiseUnaryOp.out
diff --git a/Eigen/src/Core/DiagonalMatrix.h b/Eigen/src/Core/DiagonalMatrix.h
index ebbed15d4..a74695921 100644
--- a/Eigen/src/Core/DiagonalMatrix.h
+++ b/Eigen/src/Core/DiagonalMatrix.h
@@ -32,7 +32,7 @@ class DiagonalBase : public AnyMatrixBase<Derived>
public:
typedef typename ei_traits<Derived>::DiagonalVectorType DiagonalVectorType;
typedef typename DiagonalVectorType::Scalar Scalar;
-
+
enum {
RowsAtCompileTime = DiagonalVectorType::SizeAtCompileTime,
ColsAtCompileTime = DiagonalVectorType::SizeAtCompileTime,
@@ -41,14 +41,14 @@ class DiagonalBase : public AnyMatrixBase<Derived>
IsVectorAtCompileTime = 0,
Flags = 0
};
-
+
typedef Matrix<Scalar, RowsAtCompileTime, ColsAtCompileTime, 0, MaxRowsAtCompileTime, MaxColsAtCompileTime> DenseMatrixType;
-
+
#ifndef EIGEN_PARSED_BY_DOXYGEN
inline const Derived& derived() const { return *static_cast<const Derived*>(this); }
inline Derived& derived() { return *static_cast<Derived*>(this); }
#endif // not EIGEN_PARSED_BY_DOXYGEN
-
+
DenseMatrixType toDenseMatrix() const { return derived(); }
template<typename DenseDerived>
void evalToDense(MatrixBase<DenseDerived> &other) const;
@@ -64,7 +64,7 @@ class DiagonalBase : public AnyMatrixBase<Derived>
inline int rows() const { return diagonal().size(); }
inline int cols() const { return diagonal().size(); }
-
+
template<typename MatrixDerived>
const DiagonalProduct<MatrixDerived, Derived, DiagonalOnTheLeft>
operator*(const MatrixBase<MatrixDerived> &matrix) const;
@@ -100,20 +100,20 @@ class DiagonalMatrix
: public DiagonalBase<DiagonalMatrix<_Scalar,_Size> >
{
public:
-
+
typedef typename ei_traits<DiagonalMatrix>::DiagonalVectorType DiagonalVectorType;
typedef const DiagonalMatrix& Nested;
typedef _Scalar Scalar;
-
+
protected:
DiagonalVectorType m_diagonal;
-
+
public:
inline const DiagonalVectorType& diagonal() const { return m_diagonal; }
inline DiagonalVectorType& diagonal() { return m_diagonal; }
-
+
/** Default constructor without initialization */
inline DiagonalMatrix() {}
@@ -152,7 +152,7 @@ class DiagonalMatrix
m_diagonal = other.m_diagonal();
return *this;
}
-
+
inline void resize(int size) { m_diagonal.resize(size); }
inline void setZero() { m_diagonal.setZero(); }
inline void setZero(int size) { m_diagonal.setZero(size); }
@@ -194,10 +194,10 @@ class DiagonalWrapper
public:
typedef _DiagonalVectorType DiagonalVectorType;
typedef DiagonalWrapper Nested;
-
+
inline DiagonalWrapper(const DiagonalVectorType& diagonal) : m_diagonal(diagonal) {}
const DiagonalVectorType& diagonal() const { return m_diagonal; }
-
+
protected:
const typename DiagonalVectorType::Nested m_diagonal;
};
@@ -207,8 +207,6 @@ class DiagonalWrapper
*
* \only_for_vectors
*
- * \addexample AsDiagonalExample \label How to build a diagonal matrix from a vector
- *
* Example: \include MatrixBase_asDiagonal.cpp
* Output: \verbinclude MatrixBase_asDiagonal.out
*
diff --git a/Eigen/src/Core/VectorBlock.h b/Eigen/src/Core/VectorBlock.h
index 7ce5977f6..b291f7b1a 100644
--- a/Eigen/src/Core/VectorBlock.h
+++ b/Eigen/src/Core/VectorBlock.h
@@ -88,7 +88,7 @@ template<typename VectorType, int Size, int PacketAccess> class VectorBlock
using Base::operator-=;
using Base::operator*=;
using Base::operator/=;
-
+
/** Dynamic-size constructor
*/
inline VectorBlock(const VectorType& vector, int start, int size)
@@ -96,7 +96,7 @@ template<typename VectorType, int Size, int PacketAccess> class VectorBlock
IsColVector ? start : 0, IsColVector ? 0 : start,
IsColVector ? size : 1, IsColVector ? 1 : size)
{
-
+
EIGEN_STATIC_ASSERT_VECTOR_ONLY(VectorBlock);
}
@@ -114,8 +114,6 @@ template<typename VectorType, int Size, int PacketAccess> class VectorBlock
*
* \only_for_vectors
*
- * \addexample VectorBlockIntInt \label How to reference a sub-vector (dynamic size)
- *
* \param start the first coefficient in the segment
* \param size the number of coefficients in the segment
*
@@ -151,8 +149,6 @@ MatrixBase<Derived>::segment(int start, int size) const
*
* \param size the number of coefficients in the block
*
- * \addexample BlockInt \label How to reference a sub-vector (fixed-size)
- *
* Example: \include MatrixBase_start_int.cpp
* Output: \verbinclude MatrixBase_start_int.out
*
@@ -185,8 +181,6 @@ MatrixBase<Derived>::start(int size) const
*
* \param size the number of coefficients in the block
*
- * \addexample BlockEnd \label How to reference the end of a vector (fixed-size)
- *
* Example: \include MatrixBase_end_int.cpp
* Output: \verbinclude MatrixBase_end_int.out
*
@@ -251,8 +245,6 @@ MatrixBase<Derived>::segment(int start) const
*
* The template parameter \a Size is the number of coefficients in the block
*
- * \addexample BlockStart \label How to reference the start of a vector (fixed-size)
- *
* Example: \include MatrixBase_template_int_start.cpp
* Output: \verbinclude MatrixBase_template_int_start.out
*
diff --git a/Eigen/src/Geometry/AngleAxis.h b/Eigen/src/Geometry/AngleAxis.h
index 9fd239354..b9dfa6972 100644
--- a/Eigen/src/Geometry/AngleAxis.h
+++ b/Eigen/src/Geometry/AngleAxis.h
@@ -39,8 +39,6 @@
* \li \c AngleAxisf for \c float
* \li \c AngleAxisd for \c double
*
- * \addexample AngleAxisForEuler \label How to define a rotation from Euler-angles
- *
* Combined with MatrixBase::Unit{X,Y,Z}, AngleAxis can be used to easily
* mimic Euler-angles. Here is an example:
* \include AngleAxis_mimic_euler.cpp
@@ -85,7 +83,7 @@ public:
AngleAxis() {}
/** Constructs and initialize the angle-axis rotation from an \a angle in radian
* and an \a axis which \b must \b be \b normalized.
- *
+ *
* \warning If the \a axis vector is not normalized, then the angle-axis object
* represents an invalid rotation. */
template<typename Derived>
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index a66750c3e..dba66c0d9 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -212,7 +212,6 @@ ALIASES = "only_for_vectors=This is only for vectors (either row-
"svd_module=This is defined in the %SVD module. \code #include <Eigen/SVD> \endcode" \
"geometry_module=This is defined in the %Geometry module. \code #include <Eigen/Geometry> \endcode" \
"leastsquares_module=This is defined in the %LeastSquares module. \code #include <Eigen/LeastSquares> \endcode" \
- "addexample=\anchor" \
"label=\bug" \
"redstar=<a href='#warningarraymodule' style='color:red;text-decoration: none;'>*</a>" \
"nonstableyet=\warning This is not considered to be part of the stable public API yet. Changes may happen in future releases. See \ref Experimental \"Experimental parts of Eigen\""
diff --git a/unsupported/Eigen/BVH b/unsupported/Eigen/BVH
index 7b9c3c7c6..f307da2f7 100644
--- a/unsupported/Eigen/BVH
+++ b/unsupported/Eigen/BVH
@@ -94,8 +94,6 @@ namespace Eigen {
* responsibility of the intersectObject function to keep track of the results in whatever manner is appropriate.
* The cartesian product intersection and the BVMinimize queries are similar--see their individual documentation.
*
- * \addexample BVH_Example \label How to use a BVH to find the closest pair between two point sets
- *
* The following is a simple but complete example for how to use the BVH to accelerate the search for a closest red-blue point pair:
* \include BVH_Example.cpp
* Output: \verbinclude BVH_Example.out
diff --git a/unsupported/doc/Doxyfile.in b/unsupported/doc/Doxyfile.in
index c33986224..561f18fe7 100644
--- a/unsupported/doc/Doxyfile.in
+++ b/unsupported/doc/Doxyfile.in
@@ -211,7 +211,6 @@ ALIASES = "only_for_vectors=This is only for vectors (either row-
"svd_module=This is defined in the %SVD module. \code #include <Eigen/SVD> \endcode" \
"geometry_module=This is defined in the %Geometry module. \code #include <Eigen/Geometry> \endcode" \
"leastsquares_module=This is defined in the %LeastSquares module. \code #include <Eigen/LeastSquares> \endcode" \
- "addexample=\anchor" \
"label=\bug" \
"redstar=<a href='#warningarraymodule' style='color:red;text-decoration: none;'>*</a>" \
"nonstableyet=\warning This is not considered to be part of the stable public API yet. Changes may happen in future releases. See \ref Experimental \"Experimental parts of Eigen\""
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-20 03:41:09 +0000