diff options
author | 2010-06-19 23:00:22 +0200 | |
---|---|---|
committer | 2010-06-19 23:00:22 +0200 | |
commit | eba418a458dd53a9a2c2af33f307e25ecc9413fa (patch) | |
tree | cee1b75bd08bd8308b2807f303de71f5c5ed1993 /Eigen | |
parent | 17af8c763d5aa58c40fc2c40ff6e8d6fc28a8d63 (diff) |
remove reference to the dead Array module
Diffstat (limited to 'Eigen')
-rw-r--r-- | Eigen/src/Array/Array.h | 2 | ||||
-rw-r--r-- | Eigen/src/Array/ArrayBase.h | 4 | ||||
-rw-r--r-- | Eigen/src/Array/BooleanRedux.h | 12 | ||||
-rw-r--r-- | Eigen/src/Array/Functors.h | 31 | ||||
-rw-r--r-- | Eigen/src/Array/GlobalFunctions.h | 2 | ||||
-rw-r--r-- | Eigen/src/Array/Norms.h | 4 | ||||
-rw-r--r-- | Eigen/src/Array/Random.h | 16 | ||||
-rw-r--r-- | Eigen/src/Array/Reverse.h | 4 | ||||
-rw-r--r-- | Eigen/src/Array/Select.h | 16 | ||||
-rw-r--r-- | Eigen/src/Array/VectorwiseOp.h | 24 | ||||
-rw-r--r-- | Eigen/src/Core/MatrixBase.h | 3 | ||||
-rw-r--r-- | Eigen/src/Eigen2Support/Cwise.h | 2 |
12 files changed, 23 insertions, 97 deletions
diff --git a/Eigen/src/Array/Array.h b/Eigen/src/Array/Array.h index 8cf1ae3fb..92dd708ea 100644 --- a/Eigen/src/Array/Array.h +++ b/Eigen/src/Array/Array.h @@ -232,8 +232,6 @@ class Array /** \defgroup arraytypedefs Global array typedefs * - * \ingroup Array_Module - * * Eigen defines several typedef shortcuts for most common 1D and 2D array types. * * The general patterns are the following: diff --git a/Eigen/src/Array/ArrayBase.h b/Eigen/src/Array/ArrayBase.h index 527bcd329..b9cb5cc6d 100644 --- a/Eigen/src/Array/ArrayBase.h +++ b/Eigen/src/Array/ArrayBase.h @@ -27,9 +27,7 @@ template<typename ExpressionType> class MatrixWrapper; -/** \ingroup Array_Module - * - * \class ArrayBase +/** \class ArrayBase * * \brief Base class for all 1D and 2D array, and related expressions * diff --git a/Eigen/src/Array/BooleanRedux.h b/Eigen/src/Array/BooleanRedux.h index 6f6a46a8f..58bae1c26 100644 --- a/Eigen/src/Array/BooleanRedux.h +++ b/Eigen/src/Array/BooleanRedux.h @@ -77,9 +77,7 @@ struct ei_any_unroller<Derived, Dynamic> inline static bool run(const Derived &) { return false; } }; -/** \array_module - * - * \returns true if all coefficients are true +/** \returns true if all coefficients are true * * Example: \include MatrixBase_all.cpp * Output: \verbinclude MatrixBase_all.out @@ -108,9 +106,7 @@ inline bool DenseBase<Derived>::all() const } } -/** \array_module - * - * \returns true if at least one coefficient is true +/** \returns true if at least one coefficient is true * * \sa all() */ @@ -136,9 +132,7 @@ inline bool DenseBase<Derived>::any() const } } -/** \array_module - * - * \returns the number of coefficients which evaluate to true +/** \returns the number of coefficients which evaluate to true * * \sa all(), any() */ diff --git a/Eigen/src/Array/Functors.h b/Eigen/src/Array/Functors.h index 975fd9c7f..15fde9ece 100644 --- a/Eigen/src/Array/Functors.h +++ b/Eigen/src/Array/Functors.h @@ -26,10 +26,7 @@ #define EIGEN_ARRAY_FUNCTORS_H /** \internal - * \array_module - * * \brief Template functor to add a scalar to a fixed other one - * * \sa class CwiseUnaryOp, Array::operator+ */ /* If you wonder why doing the ei_pset1() in packetOp() is an optimization check ei_scalar_multiple_op */ @@ -49,11 +46,7 @@ struct ei_functor_traits<ei_scalar_add_op<Scalar> > { enum { Cost = NumTraits<Scalar>::AddCost, PacketAccess = ei_packet_traits<Scalar>::size>1 }; }; /** \internal - * - * \array_module - * * \brief Template functor to compute the square root of a scalar - * * \sa class CwiseUnaryOp, Cwise::sqrt() */ template<typename Scalar> struct ei_scalar_sqrt_op { @@ -71,11 +64,7 @@ struct ei_functor_traits<ei_scalar_sqrt_op<Scalar> > }; /** \internal - * - * \array_module - * * \brief Template functor to compute the cosine of a scalar - * * \sa class CwiseUnaryOp, Cwise::cos() */ template<typename Scalar> struct ei_scalar_cos_op { @@ -94,11 +83,7 @@ struct ei_functor_traits<ei_scalar_cos_op<Scalar> > }; /** \internal - * - * \array_module - * * \brief Template functor to compute the sine of a scalar - * * \sa class CwiseUnaryOp, Cwise::sin() */ template<typename Scalar> struct ei_scalar_sin_op { @@ -117,11 +102,7 @@ struct ei_functor_traits<ei_scalar_sin_op<Scalar> > }; /** \internal - * - * \array_module - * * \brief Template functor to raise a scalar to a power - * * \sa class CwiseUnaryOp, Cwise::pow */ template<typename Scalar> @@ -137,11 +118,7 @@ struct ei_functor_traits<ei_scalar_pow_op<Scalar> > { enum { Cost = 5 * NumTraits<Scalar>::MulCost, PacketAccess = false }; }; /** \internal - * - * \array_module - * * \brief Template functor to compute the inverse of a scalar - * * \sa class CwiseUnaryOp, Cwise::inverse() */ template<typename Scalar> @@ -157,11 +134,7 @@ struct ei_functor_traits<ei_scalar_inverse_op<Scalar> > { enum { Cost = NumTraits<Scalar>::MulCost, PacketAccess = int(ei_packet_traits<Scalar>::size)>1 }; }; /** \internal - * - * \array_module - * * \brief Template functor to compute the square of a scalar - * * \sa class CwiseUnaryOp, Cwise::square() */ template<typename Scalar> @@ -177,11 +150,7 @@ struct ei_functor_traits<ei_scalar_square_op<Scalar> > { enum { Cost = NumTraits<Scalar>::MulCost, PacketAccess = int(ei_packet_traits<Scalar>::size)>1 }; }; /** \internal - * - * \array_module - * * \brief Template functor to compute the cube of a scalar - * * \sa class CwiseUnaryOp, Cwise::cube() */ template<typename Scalar> diff --git a/Eigen/src/Array/GlobalFunctions.h b/Eigen/src/Array/GlobalFunctions.h index 9aa022547..5de87e604 100644 --- a/Eigen/src/Array/GlobalFunctions.h +++ b/Eigen/src/Array/GlobalFunctions.h @@ -75,6 +75,6 @@ namespace Eigen EIGEN_ARRAY_DECLARE_GLOBAL_EIGEN_UNARY(ei_sqrt,ei_scalar_sqrt_op) } -// TODO: cleanly disable those functions that are not suppored on Array (ei_real_ref, ei_random, ei_isApprox...) +// TODO: cleanly disable those functions that are not supported on Array (ei_real_ref, ei_random, ei_isApprox...) #endif // EIGEN_GLOBAL_FUNCTIONS_H diff --git a/Eigen/src/Array/Norms.h b/Eigen/src/Array/Norms.h index 07741cdc9..8bb5e054c 100644 --- a/Eigen/src/Array/Norms.h +++ b/Eigen/src/Array/Norms.h @@ -62,9 +62,7 @@ struct ei_lpNorm_selector<Derived, Infinity> } }; -/** \array_module - * - * \returns the \f$ \ell^p \f$ norm of *this, that is, returns the p-th root of the sum of the p-th powers of the absolute values +/** \returns the \f$ \ell^p \f$ norm of *this, that is, returns the p-th root of the sum of the p-th powers of the absolute values * of the coefficients of *this. If \a p is the special value \a Eigen::Infinity, this function returns the \f$ \ell^p\infty \f$ * norm, that is the maximum of the absolute values of the coefficients of *this. * diff --git a/Eigen/src/Array/Random.h b/Eigen/src/Array/Random.h index c4c482bfa..5bbb99404 100644 --- a/Eigen/src/Array/Random.h +++ b/Eigen/src/Array/Random.h @@ -34,9 +34,7 @@ template<typename Scalar> 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 +/** \returns a random matrix expression * * The parameters \a rows and \a cols are the number of rows and of columns of * the returned matrix. Must be compatible with this MatrixBase type. @@ -61,9 +59,7 @@ DenseBase<Derived>::Random(Index rows, Index cols) return NullaryExpr(rows, cols, ei_scalar_random_op<Scalar>()); } -/** \array_module - * - * \returns a random vector expression +/** \returns a random vector expression * * The parameter \a size is the size of the returned vector. * Must be compatible with this MatrixBase type. @@ -90,9 +86,7 @@ DenseBase<Derived>::Random(Index size) return NullaryExpr(size, ei_scalar_random_op<Scalar>()); } -/** \array_module - * - * \returns a fixed-size random matrix or vector expression +/** \returns a fixed-size random matrix or vector expression * * This variant is only for fixed-size MatrixBase types. For dynamic-size types, you * need to use the variants taking size arguments. @@ -113,9 +107,7 @@ DenseBase<Derived>::Random() return NullaryExpr(RowsAtCompileTime, ColsAtCompileTime, ei_scalar_random_op<Scalar>()); } -/** \array_module - * - * Sets all coefficients in this expression to random values. +/** Sets all coefficients in this expression to random values. * * Example: \include MatrixBase_setRandom.cpp * Output: \verbinclude MatrixBase_setRandom.out diff --git a/Eigen/src/Array/Reverse.h b/Eigen/src/Array/Reverse.h index 2d7510902..2a074ec8a 100644 --- a/Eigen/src/Array/Reverse.h +++ b/Eigen/src/Array/Reverse.h @@ -27,9 +27,7 @@ #ifndef EIGEN_REVERSE_H #define EIGEN_REVERSE_H -/** \array_module \ingroup Array_Module - * - * \class Reverse +/** \class Reverse * * \brief Expression of the reverse of a vector or matrix * diff --git a/Eigen/src/Array/Select.h b/Eigen/src/Array/Select.h index 4bf6f76cb..5432cb172 100644 --- a/Eigen/src/Array/Select.h +++ b/Eigen/src/Array/Select.h @@ -25,9 +25,7 @@ #ifndef EIGEN_SELECT_H #define EIGEN_SELECT_H -/** \array_module \ingroup Array_Module - * - * \class Select +/** \class Select * * \brief Expression of a coefficient wise version of the C++ ternary operator ?: * @@ -107,9 +105,7 @@ class Select : ei_no_assignment_operator, }; -/** \array_module - * - * \returns a matrix where each coefficient (i,j) is equal to \a thenMatrix(i,j) +/** \returns a matrix where each coefficient (i,j) is equal to \a thenMatrix(i,j) * if \c *this(i,j), and \a elseMatrix(i,j) otherwise. * * Example: \include MatrixBase_select.cpp @@ -126,9 +122,7 @@ DenseBase<Derived>::select(const DenseBase<ThenDerived>& thenMatrix, return Select<Derived,ThenDerived,ElseDerived>(derived(), thenMatrix.derived(), elseMatrix.derived()); } -/** \array_module - * - * Version of DenseBase::select(const DenseBase&, const DenseBase&) with +/** Version of DenseBase::select(const DenseBase&, const DenseBase&) with * the \em else expression being a scalar value. * * \sa DenseBase::select(const DenseBase<ThenDerived>&, const DenseBase<ElseDerived>&) const, class Select @@ -143,9 +137,7 @@ DenseBase<Derived>::select(const DenseBase<ThenDerived>& thenMatrix, derived(), thenMatrix.derived(), ThenDerived::Constant(rows(),cols(),elseScalar)); } -/** \array_module - * - * Version of DenseBase::select(const DenseBase&, const DenseBase&) with +/** Version of DenseBase::select(const DenseBase&, const DenseBase&) with * the \em then expression being a scalar value. * * \sa DenseBase::select(const DenseBase<ThenDerived>&, const DenseBase<ElseDerived>&) const, class Select diff --git a/Eigen/src/Array/VectorwiseOp.h b/Eigen/src/Array/VectorwiseOp.h index 8926e7a04..069729072 100644 --- a/Eigen/src/Array/VectorwiseOp.h +++ b/Eigen/src/Array/VectorwiseOp.h @@ -26,9 +26,7 @@ #ifndef EIGEN_PARTIAL_REDUX_H #define EIGEN_PARTIAL_REDUX_H -/** \array_module \ingroup Array_Module - * - * \class PartialReduxExpr +/** \class PartialReduxExpr * * \brief Generic expression of a partially reduxed matrix * @@ -155,9 +153,7 @@ struct ei_member_redux { const BinaryOp m_functor; }; -/** \array_module \ingroup Array_Module - * - * \class VectorwiseOp +/** \class VectorwiseOp * * \brief Pseudo expression providing partial reduction operations * @@ -499,9 +495,7 @@ template<typename ExpressionType, int Direction> class VectorwiseOp ExpressionTypeNested m_matrix; }; -/** \array_module - * - * \returns a VectorwiseOp wrapper of *this providing additional partial reduction operations +/** \returns a VectorwiseOp wrapper of *this providing additional partial reduction operations * * Example: \include MatrixBase_colwise.cpp * Output: \verbinclude MatrixBase_colwise.out @@ -515,9 +509,7 @@ DenseBase<Derived>::colwise() const return derived(); } -/** \array_module - * - * \returns a writable VectorwiseOp wrapper of *this providing additional partial reduction operations +/** \returns a writable VectorwiseOp wrapper of *this providing additional partial reduction operations * * \sa rowwise(), class VectorwiseOp */ @@ -528,9 +520,7 @@ DenseBase<Derived>::colwise() return derived(); } -/** \array_module - * - * \returns a VectorwiseOp wrapper of *this providing additional partial reduction operations +/** \returns a VectorwiseOp wrapper of *this providing additional partial reduction operations * * Example: \include MatrixBase_rowwise.cpp * Output: \verbinclude MatrixBase_rowwise.out @@ -544,9 +534,7 @@ DenseBase<Derived>::rowwise() const return derived(); } -/** \array_module - * - * \returns a writable VectorwiseOp wrapper of *this providing additional partial reduction operations +/** \returns a writable VectorwiseOp wrapper of *this providing additional partial reduction operations * * \sa colwise(), class VectorwiseOp */ diff --git a/Eigen/src/Core/MatrixBase.h b/Eigen/src/Core/MatrixBase.h index ac5951d1e..f481c19fb 100644 --- a/Eigen/src/Core/MatrixBase.h +++ b/Eigen/src/Core/MatrixBase.h @@ -34,7 +34,8 @@ * types. Most of the Eigen API is contained in this class, and its base classes. Other important * classes for the Eigen API are Matrix, and VectorwiseOp. * - * Note that some methods are defined in the \ref Array_Module array module. + * Note that some methods are defined in other modules such as the \ref LU_Module LU module + * for all functions related to matrix inversions. * * \param Derived is the derived type, e.g. a matrix type, or an expression, etc. * diff --git a/Eigen/src/Eigen2Support/Cwise.h b/Eigen/src/Eigen2Support/Cwise.h index ab7056a1d..fe3b33cd7 100644 --- a/Eigen/src/Eigen2Support/Cwise.h +++ b/Eigen/src/Eigen2Support/Cwise.h @@ -52,8 +52,6 @@ * It is the return type of MatrixBase::cwise() * and most of the time this is the only way it is used. * - * Note that some methods are defined in the \ref Array_Module array module. - * * Example: \include MatrixBase_cwise_const.cpp * Output: \verbinclude MatrixBase_cwise_const.out * |