aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2008-05-22 16:31:00 +0000
committerGravatar Gael Guennebaud <g.gael@free.fr>2008-05-22 16:31:00 +0000
commit8f1fc80a77551b26c05669527534aff7b621b86c (patch)
tree145a82470e1193e7c25492925f10dcbe34221dd6 /doc
parent94e1629a1b64e384281514b3c11e4c74ca31a622 (diff)
some documentation fixes (Cwise* and Cholesky)
Diffstat (limited to 'doc')
-rw-r--r--doc/Doxyfile.in1
-rw-r--r--doc/examples/class_CwiseBinaryOp.cpp22
-rw-r--r--doc/examples/class_CwiseUnaryOp.cpp6
3 files changed, 9 insertions, 20 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index a54c8e2b7..d03648f0c 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -143,6 +143,7 @@ DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 1
GENERATE_TREEVIEW = NO
TREEVIEW_WIDTH = 250
+FORMULA_FONTSIZE = 12
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
diff --git a/doc/examples/class_CwiseBinaryOp.cpp b/doc/examples/class_CwiseBinaryOp.cpp
index b91abd1ef..f95090b4d 100644
--- a/doc/examples/class_CwiseBinaryOp.cpp
+++ b/doc/examples/class_CwiseBinaryOp.cpp
@@ -1,29 +1,17 @@
-// FIXME - this example is not too good as that functionality is provided in the Eigen API
-// additionally it's quite heavy. the CwiseUnaryOp example is better.
-
#include <Eigen/Core>
USING_PART_OF_NAMESPACE_EIGEN
using namespace std;
// define a custom template binary functor
-template<typename Scalar> struct CwiseMinOp EIGEN_EMPTY_STRUCT {
- Scalar operator()(const Scalar& a, const Scalar& b) const { return std::min(a,b); }
- enum { Cost = Eigen::ConditionalJumpCost + Eigen::NumTraits<Scalar>::AddCost };
+template<typename Scalar> struct MakeComplexOp EIGEN_EMPTY_STRUCT {
+ typedef complex<Scalar> result_type;
+ complex<Scalar> operator()(const Scalar& a, const Scalar& b) const { return complex<Scalar>(a,b); }
+ enum { Cost = 0 };
};
-// define a custom binary operator between two matrices
-template<typename Derived1, typename Derived2>
-const Eigen::CwiseBinaryOp<CwiseMinOp<typename Derived1::Scalar>, Derived1, Derived2>
-cwiseMin(const MatrixBase<Derived1> &mat1, const MatrixBase<Derived2> &mat2)
-{
- return Eigen::CwiseBinaryOp<CwiseMinOp<typename Derived1::Scalar>, Derived1, Derived2>(mat1, mat2);
-}
-
int main(int, char**)
{
Matrix4d m1 = Matrix4d::random(), m2 = Matrix4d::random();
- cout << cwiseMin(m1,m2) << endl; // use our new global operator
- cout << m1.cwise<CwiseMinOp<double> >(m2) << endl; // directly use the generic expression member
- cout << m1.cwise(m2, CwiseMinOp<double>()) << endl; // directly use the generic expression member (variant)
+ cout << m1.cwise(m2, MakeComplexOp<double>()) << endl;
return 0;
}
diff --git a/doc/examples/class_CwiseUnaryOp.cpp b/doc/examples/class_CwiseUnaryOp.cpp
index ea27876eb..4111b7eec 100644
--- a/doc/examples/class_CwiseUnaryOp.cpp
+++ b/doc/examples/class_CwiseUnaryOp.cpp
@@ -2,9 +2,9 @@
USING_PART_OF_NAMESPACE_EIGEN
using namespace std;
-// define a custom template binary functor
+// define a custom template unary functor
template<typename Scalar>
-struct CwiseClampOp EIGEN_EMPTY_STRUCT {
+struct CwiseClampOp {
CwiseClampOp(const Scalar& inf, const Scalar& sup) : m_inf(inf), m_sup(sup) {}
const Scalar operator()(const Scalar& x) const { return x<m_inf ? m_inf : (x>m_sup ? m_sup : x); }
Scalar m_inf, m_sup;
@@ -14,6 +14,6 @@ struct CwiseClampOp EIGEN_EMPTY_STRUCT {
int main(int, char**)
{
Matrix4d m1 = Matrix4d::random();
- cout << m1.cwise(CwiseClampOp<double>(-0.5,0.5)) << endl;
+ cout << m1 << endl << "becomes: " << endl << m1.cwise(CwiseClampOp<double>(-0.5,0.5)) << endl;
return 0;
}