GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-08-13 20:26:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

hide internal stuff from doxygen by using #ifndef EIGEN_PARSED_BY_DOXYGEN.

Browse Source 
Sadly, \internal didn't hide internal stuff, it only hides the documentation!
This commit is contained in:
Benoit Jacob 2008-12-07 15:40:40 +00:00
parent 93c1f62979
commit 7e8ee5b527
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Eigen/src/Core/MatrixBase.h
View File

@ -56,10 +56,12 @@ template<typename Derived> class MatrixBase
{ {
public: public:
#ifndef EIGEN_PARSED_BY_DOXYGEN
class InnerIterator; class InnerIterator;
typedef typename ei_traits<Derived>::Scalar Scalar; typedef typename ei_traits<Derived>::Scalar Scalar;
typedef typename ei_packet_traits<Scalar>::type PacketScalar; typedef typename ei_packet_traits<Scalar>::type PacketScalar;
#endif // not EIGEN_PARSED_BY_DOXYGEN
enum { enum {
@ -140,6 +142,7 @@ template<typename Derived> class MatrixBase
ei_assert(ei_are_flags_consistent<Flags>::ret); ei_assert(ei_are_flags_consistent<Flags>::ret);
} }
#ifndef EIGEN_PARSED_BY_DOXYGEN
/** This is the "real scalar" type; if the \a Scalar type is already real numbers /** This is the "real scalar" type; if the \a Scalar type is already real numbers
* (e.g. int, float or double) then \a RealScalar is just the same as \a Scalar. If * (e.g. int, float or double) then \a RealScalar is just the same as \a Scalar. If
* \a Scalar is \a std::complex<T> then RealScalar is \a T. * \a Scalar is \a std::complex<T> then RealScalar is \a T.
@ -151,6 +154,7 @@ template<typename Derived> class MatrixBase
/** type of the equivalent square matrix */ /** type of the equivalent square matrix */
typedef Matrix<Scalar,EIGEN_ENUM_MAX(RowsAtCompileTime,ColsAtCompileTime), typedef Matrix<Scalar,EIGEN_ENUM_MAX(RowsAtCompileTime,ColsAtCompileTime),
EIGEN_ENUM_MAX(RowsAtCompileTime,ColsAtCompileTime)> SquareMatrixType; EIGEN_ENUM_MAX(RowsAtCompileTime,ColsAtCompileTime)> SquareMatrixType;
#endif // not EIGEN_PARSED_BY_DOXYGEN
/** \returns the number of rows. \sa cols(), RowsAtCompileTime */ /** \returns the number of rows. \sa cols(), RowsAtCompileTime */
inline int rows() const { return derived().rows(); } inline int rows() const { return derived().rows(); }
@ -174,6 +178,7 @@ template<typename Derived> class MatrixBase
* i.e., the number of rows for a columns major matrix, and the number of cols otherwise */ * i.e., the number of rows for a columns major matrix, and the number of cols otherwise */
int innerSize() const { return (int(Flags)&RowMajorBit) ? this->cols() : this->rows(); } int innerSize() const { return (int(Flags)&RowMajorBit) ? this->cols() : this->rows(); }
#ifndef EIGEN_PARSED_BY_DOXYGEN
/** \internal the type to which the expression gets evaluated (needed by MSVC) */ /** \internal the type to which the expression gets evaluated (needed by MSVC) */
typedef typename ei_eval<Derived>::type EvalType; typedef typename ei_eval<Derived>::type EvalType;
/** \internal Represents a constant matrix */ /** \internal Represents a constant matrix */
@ -206,6 +211,7 @@ template<typename Derived> class MatrixBase
typedef Block<CwiseNullaryOp<ei_scalar_identity_op<Scalar>, SquareMatrixType>, typedef Block<CwiseNullaryOp<ei_scalar_identity_op<Scalar>, SquareMatrixType>,
ei_traits<Derived>::RowsAtCompileTime, ei_traits<Derived>::RowsAtCompileTime,
ei_traits<Derived>::ColsAtCompileTime> BasisReturnType; ei_traits<Derived>::ColsAtCompileTime> BasisReturnType;
#endif // not EIGEN_PARSED_BY_DOXYGEN
/** Copies \a other into *this. \returns a reference to *this. */ /** Copies \a other into *this. \returns a reference to *this. */
@ -256,6 +262,7 @@ template<typename Derived> class MatrixBase
Scalar& operator[](int index); Scalar& operator[](int index);
Scalar& operator()(int index); Scalar& operator()(int index);
#ifndef EIGEN_PARSED_BY_DOXYGEN
template<typename OtherDerived> template<typename OtherDerived>
void copyCoeff(int row, int col, const MatrixBase<OtherDerived>& other); void copyCoeff(int row, int col, const MatrixBase<OtherDerived>& other);
template<typename OtherDerived> template<typename OtherDerived>
@ -264,6 +271,7 @@ template<typename Derived> class MatrixBase
void copyPacket(int row, int col, const MatrixBase<OtherDerived>& other); void copyPacket(int row, int col, const MatrixBase<OtherDerived>& other);
template<typename OtherDerived, int StoreMode, int LoadMode> template<typename OtherDerived, int StoreMode, int LoadMode>
void copyPacket(int index, const MatrixBase<OtherDerived>& other); void copyPacket(int index, const MatrixBase<OtherDerived>& other);
#endif // not EIGEN_PARSED_BY_DOXYGEN
template<int LoadMode> template<int LoadMode>
PacketScalar packet(int row, int col) const; PacketScalar packet(int row, int col) const;
@ -524,11 +532,12 @@ template<typename Derived> class MatrixBase
template<typename Visitor> template<typename Visitor>
void visit(Visitor& func) const; void visit(Visitor& func) const;
#ifndef EIGEN_PARSED_BY_DOXYGEN
inline const Derived& derived() const { return *static_cast<const Derived*>(this); } inline const Derived& derived() const { return *static_cast<const Derived*>(this); }
inline Derived& derived() { return *static_cast<Derived*>(this); } inline Derived& derived() { return *static_cast<Derived*>(this); }
inline Derived& const_cast_derived() const inline Derived& const_cast_derived() const
{ return *static_cast<Derived*>(const_cast<MatrixBase*>(this)); } { return *static_cast<Derived*>(const_cast<MatrixBase*>(this)); }
#endif // not EIGEN_PARSED_BY_DOXYGEN
const Cwise<Derived> cwise() const; const Cwise<Derived> cwise() const;
Cwise<Derived> cwise(); Cwise<Derived> cwise();