GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-08-11 19:29:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

Adapted doxygen's new style sheet.

Browse Source 
Added documentation to some of the typedefs.
This commit is contained in:
Hauke Heibel 2010-01-15 15:45:07 +01:00
parent dd4b2f044d
commit 90d5a7c0dd
4 changed files with 112 additions and 165 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Eigen/src/Core/Matrix.h
View File

@ -36,7 +36,8 @@
* The %Matrix class encompasses \em both fixed-size and dynamic-size objects (\ref fixedsize "note"). * The %Matrix class encompasses \em both fixed-size and dynamic-size objects (\ref fixedsize "note").
* *
* The first three template parameters are required: * The first three template parameters are required:
* \tparam _Scalar Numeric type, i.e. float, double, int * \tparam _Scalar \anchor matrix_tparam_scalar Numeric type, e.g. float, double, int or std::complex<float>.
* User defined sclar types are supported as well (see \ref user_defined_scalars "here").
* \tparam _Rows Number of rows, or \b Dynamic * \tparam _Rows Number of rows, or \b Dynamic
* \tparam _Cols Number of columns, or \b Dynamic * \tparam _Cols Number of columns, or \b Dynamic
* *
@ -134,11 +135,10 @@ class Matrix
*/ */
typedef DenseStorageBase<Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>, Eigen::MatrixBase, _Options> Base; typedef DenseStorageBase<Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>, Eigen::MatrixBase, _Options> Base;
_EIGEN_GENERIC_PUBLIC_INTERFACE(Matrix)
/** \brief Template parameter alias for \ref matrix_tparam_options "_Options". */
enum { Options = _Options }; enum { Options = _Options };
_EIGEN_GENERIC_PUBLIC_INTERFACE(Matrix)
typedef typename Base::PlainMatrixType PlainMatrixType; typedef typename Base::PlainMatrixType PlainMatrixType;
// friend class Eigen::Map<Matrix, Unaligned>; // friend class Eigen::Map<Matrix, Unaligned>;

14
Eigen/src/Core/util/Macros.h
View File

@ -277,11 +277,19 @@ using Eigen::ei_cos;
#define EIGEN_INHERIT_ASSIGNMENT_OPERATORS(Derived) \ #define EIGEN_INHERIT_ASSIGNMENT_OPERATORS(Derived) \
EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR(Derived) EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR(Derived)
/**
* Just a side note. Commenting within defines works only by documenting
* behind the object (via /*!<../). Comments cannot be multi-line and thus
* we have these extra long lines. What is confusing doxygen over here is
* that we use '\' and basically have a bunch of typedefs with their
* documentation in a single line.
**/
#define _EIGEN_GENERIC_PUBLIC_INTERFACE(Derived) \ #define _EIGEN_GENERIC_PUBLIC_INTERFACE(Derived) \
typedef typename Eigen::ei_traits<Derived>::Scalar Scalar; \ typedef typename Eigen::ei_traits<Derived>::Scalar Scalar; /*!< \brief Numeric type, e.g. float, double, int or std::complex<float>. */ \
typedef typename Eigen::NumTraits<Scalar>::Real RealScalar; \ typedef typename Eigen::NumTraits<Scalar>::Real RealScalar; /*!< \brief The underlying numeric type for composed scalar types. \details In cases where Scalar is e.g. std::complex<T>, T were corresponding to RealScalar. */ \
typedef typename Base::PacketScalar PacketScalar; \ typedef typename Base::PacketScalar PacketScalar; \
typedef typename Base::CoeffReturnType CoeffReturnType; \ typedef typename Base::CoeffReturnType CoeffReturnType; /*!< \brief The return type for coefficient access. \details Depending on whether the object allows direct coefficient access (e.g. for a MatrixXd), this type is either 'const Scalar&' or simply 'Scalar' for objects that do not allow direct coefficient access. */ \
typedef typename Eigen::ei_nested<Derived>::type Nested; \ typedef typename Eigen::ei_nested<Derived>::type Nested; \
enum { RowsAtCompileTime = Eigen::ei_traits<Derived>::RowsAtCompileTime, \ enum { RowsAtCompileTime = Eigen::ei_traits<Derived>::RowsAtCompileTime, \
ColsAtCompileTime = Eigen::ei_traits<Derived>::ColsAtCompileTime, \ ColsAtCompileTime = Eigen::ei_traits<Derived>::ColsAtCompileTime, \

2
doc/I00_CustomizingEigen.dox
View File

@ -115,7 +115,7 @@ Eigen::MatrixBase<Eigen::Matrix<std::complex<float>, 10000, 1, 2, 10000, 1>
>2, 10000, 1> >*)((const spectral1d*)where)) + 8u)))’ >2, 10000, 1> >*)((const spectral1d*)where)) + 8u)))’
\endcode \endcode
\section CustomScalarType Using custom scalar types \anchor user_defined_scalars \section CustomScalarType Using custom scalar types
By default, Eigen currently supports the following scalar types: \c int, \c float, \c double, \c std::complex<float>, \c std::complex<double>, \c long \c double, \c long \c long \c int (64 bits integers), and \c bool. The \c long \c double is especially useful on x86-64 systems or when the SSE2 instruction set is enabled because it enforces the use of x87 registers with extended accuracy. By default, Eigen currently supports the following scalar types: \c int, \c float, \c double, \c std::complex<float>, \c std::complex<double>, \c long \c double, \c long \c long \c int (64 bits integers), and \c bool. The \c long \c double is especially useful on x86-64 systems or when the SSE2 instruction set is enabled because it enforces the use of x87 registers with extended accuracy.

253
doc/eigendoxy.css
View File

@ -1,20 +1,23 @@
BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV {
font-family: Geneva, Arial, Helvetica, sans-serif; font-family: Verdana, Arial, Helvetica, sans-serif;
font-size: 9.4pt; font-size: 10pt;
}
BODY,TD {
/*font-size: 90%;*/
} }
H1 { H1 {
text-align: center; text-align: center;
font-size: 15pt; font-size: 150%;
} }
H2 { H2 {
font-size: 12pt; font-size: 120%;
background-color : #d8d6af; margin-top : 20pt;
} }
H3 { H3 {
font-size: 100%; font-size: 100%;
}
TD H2
{
/* We need the margin in order to ensure that in tables
* the headings are centered. */
margin-top: 12px;
margin-bottom: 12px;
} }
CAPTION { CAPTION {
font-weight: bold font-weight: bold
@ -210,119 +213,35 @@ SPAN.vhdlchar { color: #000000 }
SPAN.vhdlkeyword { color: #700070 } SPAN.vhdlkeyword { color: #700070 }
SPAN.vhdllogic { color: #ff0000 } SPAN.vhdllogic { color: #ff0000 }
.mdescLeft { /* @group Member Descriptions */
padding: 0px 8px 4px 8px;
font-size: 90%; .mdescLeft, .mdescRight,
font-style: italic; .memItemLeft, .memItemRight,
background-color: #FAFAFA; .memTemplItemLeft, .memTemplItemRight, .memTemplParams {
border-top: 1px none #E0E0E0; background-color: #FAFAFA;
border-right: 1px none #E0E0E0; border: none;
border-bottom: 1px none #E0E0E0; margin: 4px;
border-left: 1px none #E0E0E0; padding: 1px 0 0 8px;
margin: 0px;
} }
.mdescRight {
padding: 0px 8px 4px 8px; .mdescLeft, .mdescRight {
font-size: 90%; padding: 0px 8px 4px 8px;
font-style: italic; color: #555;
background-color: #FAFAFA;
border-top: 1px none #E0E0E0;
border-right: 1px none #E0E0E0;
border-bottom: 1px none #E0E0E0;
border-left: 1px none #E0E0E0;
margin: 0px;
} }
.memItemLeft {
padding: 1px 0px 0px 8px; .memItemLeft, .memItemRight, .memTemplParams {
margin: 4px; border-top: 1px solid #ccc;
border-top-width: 1px;
border-right-width: 1px;
border-bottom-width: 1px;
border-left-width: 1px;
border-top-color: #E0E0E0;
border-right-color: #E0E0E0;
border-bottom-color: #E0E0E0;
border-left-color: #E0E0E0;
border-top-style: solid;
border-right-style: none;
border-bottom-style: none;
border-left-style: none;
background-color: #FAFAFA;
font-size: 90%;
} }
.memItemRight {
padding: 1px 8px 0px 8px; .memItemLeft, .memTemplItemLeft {
margin: 4px; white-space: nowrap;
border-top-width: 1px;
border-right-width: 1px;
border-bottom-width: 1px;
border-left-width: 1px;
border-top-color: #E0E0E0;
border-right-color: #E0E0E0;
border-bottom-color: #E0E0E0;
border-left-color: #E0E0E0;
border-top-style: solid;
border-right-style: none;
border-bottom-style: none;
border-left-style: none;
background-color: #FAFAFA;
font-size: 90%;
}
.memTemplItemLeft {
padding: 1px 0px 0px 8px;
margin: 4px;
border-top-width: 1px;
border-right-width: 1px;
border-bottom-width: 1px;
border-left-width: 1px;
border-top-color: #E0E0E0;
border-right-color: #E0E0E0;
border-bottom-color: #E0E0E0;
border-left-color: #E0E0E0;
border-top-style: none;
border-right-style: none;
border-bottom-style: none;
border-left-style: none;
background-color: #FAFAFA;
font-size: 90%;
}
.memTemplItemRight {
padding: 1px 8px 0px 8px;
margin: 4px;
border-top-width: 1px;
border-right-width: 1px;
border-bottom-width: 1px;
border-left-width: 1px;
border-top-color: #E0E0E0;
border-right-color: #E0E0E0;
border-bottom-color: #E0E0E0;
border-left-color: #E0E0E0;
border-top-style: none;
border-right-style: none;
border-bottom-style: none;
border-left-style: none;
background-color: #FAFAFA;
font-size: 90%;
} }
.memTemplParams { .memTemplParams {
padding: 1px 0px 0px 8px; color: #606060;
margin: 4px; white-space: nowrap;
border-top-width: 1px;
border-right-width: 1px;
border-bottom-width: 1px;
border-left-width: 1px;
border-top-color: #E0E0E0;
border-right-color: #E0E0E0;
border-bottom-color: #E0E0E0;
border-left-color: #E0E0E0;
border-top-style: solid;
border-right-style: none;
border-bottom-style: none;
border-left-style: none;
color: #606060;
background-color: #FAFAFA;
font-size: 90%;
} }
.search { .search {
color: #003399; color: #003399;
font-weight: bold; font-weight: bold;
@ -355,62 +274,85 @@ TH.dirtab {
background: #e8eef2; background: #e8eef2;
font-weight: bold; font-weight: bold;
} }
HR { hr {
height: 1px; height: 0;
border: none; border: none;
border-top: 1px solid black; border-top: 1px solid #666;
} }
/* Style for detailed member documentation */ /* Styles for detailed member documentation */
.memtemplate { .memtemplate {
font-size: 90%; font-size: 80%;
color: #606060; color: #606060;
font-weight: normal; font-weight: normal;
margin-left: 3px; margin-left: 3px;
} }
.memnav { .memnav {
background-color: #e8eef2; background-color: #e8eef2;
border: 1px solid #84b0c7; border: 1px solid #84b0c7;
text-align: center; text-align: center;
margin: 2px; margin: 2px;
margin-right: 15px; margin-right: 15px;
padding: 2px; padding: 2px;
} }
.memitem { .memitem {
padding: 4px; padding: 0;
background-color: #eef3f5; margin-bottom: 10px;
border-width: 1px;
border-style: solid;
border-color: #dedeee;
-moz-border-radius: 8px 8px 8px 8px;
} }
.memname { .memname {
white-space: nowrap; white-space: nowrap;
font-weight: bold; font-weight: bold;
} }
.memdoc{
padding-left: 10px; .memproto, .memdoc {
border: 1px solid #84b0c7;
} }
.memproto { .memproto {
background-color: #d5e1e8; padding: 2;
width: 100%; background-color: #d5e1e8;
border-width: 1px; font-weight: bold;
border-style: solid; -webkit-border-top-left-radius: 8px;
border-color: #84b0c7; -webkit-border-top-right-radius: 8px;
font-weight: bold; -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
-moz-border-radius: 8px 8px 8px 8px; -moz-border-radius-topleft: 8px;
-moz-border-radius-topright: 8px;
-moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
} }
.memdoc {
padding: 2px 5px;
background-color: #eef3f5;
border-top-width: 0;
-webkit-border-bottom-left-radius: 8px;
-webkit-border-bottom-right-radius: 8px;
-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
-moz-border-radius-bottomleft: 8px;
-moz-border-radius-bottomright: 8px;
-moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
}
.paramkey { .paramkey {
text-align: right; text-align: right;
} }
.paramtype { .paramtype {
white-space: nowrap; white-space: nowrap;
} }
.paramname { .paramname {
color: #602020; color: #602020;
font-style: italic; white-space: nowrap;
white-space: nowrap;
} }
.paramname em {
font-style: normal;
}
/* End Styling for detailed member documentation */ /* End Styling for detailed member documentation */
/* for the tree view */ /* for the tree view */
@ -530,11 +472,8 @@ table.tutorial_code td {
padding: 2pt 5pt 2pt 5pt; padding: 2pt 5pt 2pt 5pt;
vertical-align: middle; vertical-align: middle;
} }
DIV.eimainmenu { DIV.eimainmenu {
text-align: center; text-align: center;
/* border-top: solid; */ /* border-top: solid; */
/* border-bottom: solid; */ /* border-bottom: solid; */
} }