aboutsummaryrefslogtreecommitdiffhomepage
path: root/unsupported
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2013-01-11 10:48:43 +0100
committerGravatar Gael Guennebaud <g.gael@free.fr>2013-01-11 10:48:43 +0100
commit1ccd90a927e7386574ff845ff0d326733352e9d1 (patch)
treee81b7f41f94f162ab3213955d048947f97203985 /unsupported
parentcc444bbbf916765f83a22ae50cd8eeeb1167ccbd (diff)
Make the MatrixFunctions documentation page looks a bit better
Diffstat (limited to 'unsupported')
-rw-r--r--unsupported/Eigen/MatrixFunctions22
1 files changed, 12 insertions, 10 deletions
diff --git a/unsupported/Eigen/MatrixFunctions b/unsupported/Eigen/MatrixFunctions
index 1221f6b8b..124175841 100644
--- a/unsupported/Eigen/MatrixFunctions
+++ b/unsupported/Eigen/MatrixFunctions
@@ -64,15 +64,17 @@
/**
-\page matrixbaseextra MatrixBase methods defined in the MatrixFunctions module
+\page matrixbaseextra_page
\ingroup MatrixFunctions_Module
+\section matrixbaseextra MatrixBase methods defined in the MatrixFunctions module
+
The remainder of the page documents the following MatrixBase methods
which are defined in the MatrixFunctions module.
-\section matrixbase_cos MatrixBase::cos()
+\subsection matrixbase_cos MatrixBase::cos()
Compute the matrix cosine.
@@ -89,7 +91,7 @@ This function calls \ref matrixbase_matrixfunction "matrixFunction()" with StdSt
-\section matrixbase_cosh MatrixBase::cosh()
+\subsection matrixbase_cosh MatrixBase::cosh()
Compute the matrix hyberbolic cosine.
@@ -106,7 +108,7 @@ This function calls \ref matrixbase_matrixfunction "matrixFunction()" with StdSt
-\section matrixbase_exp MatrixBase::exp()
+\subsection matrixbase_exp MatrixBase::exp()
Compute the matrix exponential.
@@ -161,7 +163,7 @@ Output: \verbinclude MatrixExponential.out
\c complex<float>, \c complex<double>, or \c complex<long double> .
-\section matrixbase_log MatrixBase::log()
+\subsection matrixbase_log MatrixBase::log()
Compute the matrix logarithm.
@@ -220,7 +222,7 @@ double> .
class MatrixLogarithmAtomic, MatrixBase::sqrt().
-\section matrixbase_pow MatrixBase::pow()
+\subsection matrixbase_pow MatrixBase::pow()
Compute the matrix raised to arbitrary real power.
@@ -282,7 +284,7 @@ double> .
\sa MatrixBase::exp(), MatrixBase::log(), class MatrixPower.
-\section matrixbase_matrixfunction MatrixBase::matrixFunction()
+\subsection matrixbase_matrixfunction MatrixBase::matrixFunction()
Compute a matrix function.
@@ -338,7 +340,7 @@ A.matrixFunction(StdStemFunctions<std::complex<double> >::exp, &B);
-\section matrixbase_sin MatrixBase::sin()
+\subsection matrixbase_sin MatrixBase::sin()
Compute the matrix sine.
@@ -356,7 +358,7 @@ Output: \verbinclude MatrixSine.out
-\section matrixbase_sinh MatrixBase::sinh()
+\subsection matrixbase_sinh MatrixBase::sinh()
Compute the matrix hyperbolic sine.
@@ -373,7 +375,7 @@ Example: \include MatrixSinh.cpp
Output: \verbinclude MatrixSinh.out
-\section matrixbase_sqrt MatrixBase::sqrt()
+\subsection matrixbase_sqrt MatrixBase::sqrt()
Compute the matrix square root.