summaryrefslogtreecommitdiffhomepage
path: root/eigen/doc
diff options
context:
space:
mode:
Diffstat (limited to 'eigen/doc')
-rw-r--r--eigen/doc/CMakeLists.txt4
-rw-r--r--eigen/doc/CoeffwiseMathFunctionsTable.dox7
-rw-r--r--eigen/doc/Doxyfile.in6
-rw-r--r--eigen/doc/eigen_navtree_hacks.js46
-rw-r--r--eigen/doc/eigendoxy.css2
-rw-r--r--eigen/doc/snippets/MatrixBase_cwiseEqual.cpp2
-rw-r--r--eigen/doc/snippets/MatrixBase_cwiseNotEqual.cpp2
-rw-r--r--eigen/doc/special_examples/CMakeLists.txt1
8 files changed, 39 insertions, 31 deletions
diff --git a/eigen/doc/CMakeLists.txt b/eigen/doc/CMakeLists.txt
index db413bc..8ff7559 100644
--- a/eigen/doc/CMakeLists.txt
+++ b/eigen/doc/CMakeLists.txt
@@ -34,8 +34,8 @@ set(EIGEN_DOXY_PROJECT_NAME "Eigen-unsupported")
set(EIGEN_DOXY_OUTPUT_DIRECTORY_SUFFIX "/unsupported")
set(EIGEN_DOXY_INPUT "\"${Eigen_SOURCE_DIR}/unsupported/Eigen\" \"${Eigen_SOURCE_DIR}/unsupported/doc\"")
set(EIGEN_DOXY_HTML_COLORSTYLE_HUE "0")
-# set(EIGEN_DOXY_TAGFILES "\"${Eigen_BINARY_DIR}/doc/eigen.doxytags =../\"")
-set(EIGEN_DOXY_TAGFILES "")
+set(EIGEN_DOXY_TAGFILES "\"${Eigen_BINARY_DIR}/doc/Eigen.doxytags=..\"")
+#set(EIGEN_DOXY_TAGFILES "")
configure_file(
${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
diff --git a/eigen/doc/CoeffwiseMathFunctionsTable.dox b/eigen/doc/CoeffwiseMathFunctionsTable.dox
index 3ae9420..12a565b 100644
--- a/eigen/doc/CoeffwiseMathFunctionsTable.dox
+++ b/eigen/doc/CoeffwiseMathFunctionsTable.dox
@@ -63,7 +63,7 @@ This also means that, unless specified, if the function \c std::foo is available
\anchor cwisetable_conj
a.\link ArrayBase::conjugate conjugate\endlink(); \n
\link Eigen::conj conj\endlink(a); \n
- m.\link MatrixBase::conjugate conjugate();
+ m.\link MatrixBase::conjugate conjugate\endlink();
</td>
<td><a href="https://en.wikipedia.org/wiki/Complex_conjugate">complex conjugate</a> (\f$ \bar{a_i} \f$),\n
no-op for real </td>
@@ -133,8 +133,9 @@ This also means that, unless specified, if the function \c std::foo is available
<td class="code">
\anchor cwisetable_pow
a.\link ArrayBase::pow pow\endlink(b); \n
- \link Eigen::pow pow\endlink(a,b);
+ \link ArrayBase::pow(const Eigen::ArrayBase< Derived > &x, const Eigen::ArrayBase< ExponentDerived > &exponents) pow\endlink(a,b);
</td>
+ <!-- For some reason Doxygen thinks that pow is in ArrayBase namespace -->
<td>raises a number to the given power (\f$ a_i ^ {b_i} \f$) \n \c a and \c b can be either an array or scalar.</td>
<td class="code">
using <a href="http://en.cppreference.com/w/cpp/numeric/math/pow">std::pow</a>; \n
@@ -271,7 +272,7 @@ This also means that, unless specified, if the function \c std::foo is available
<tr>
<td class="code">
\anchor cwisetable_atan
- a.\link ArrayBase::atan tan\endlink(); \n
+ a.\link ArrayBase::atan atan\endlink(); \n
\link Eigen::atan atan\endlink(a);
</td>
<td>computes arc tangent (\f$ \tan^{-1} a_i \f$)</td>
diff --git a/eigen/doc/Doxyfile.in b/eigen/doc/Doxyfile.in
index 48bb0a8..37948a6 100644
--- a/eigen/doc/Doxyfile.in
+++ b/eigen/doc/Doxyfile.in
@@ -1596,6 +1596,7 @@ PREDEFINED = EIGEN_EMPTY_STRUCT \
"EIGEN_CAT2(a,b)= a ## b"\
"EIGEN_CAT(a,b)=EIGEN_CAT2(a,b)"\
"EIGEN_CWISE_BINARY_RETURN_TYPE(LHS,RHS,OPNAME)=CwiseBinaryOp<EIGEN_CAT(EIGEN_CAT(internal::scalar_,OPNAME),_op)<LHS::Scalar, RHS::Scalar>, const LHS, const RHS>"\
+ "EIGEN_ALIGN_TO_BOUNDARY(x)="\
DOXCOMMA=,
@@ -1618,6 +1619,9 @@ EXPAND_AS_DEFINED = EIGEN_MAKE_TYPEDEFS \
EIGEN_EULER_ANGLES_TYPEDEFS \
EIGEN_EULER_ANGLES_SINGLE_TYPEDEF \
EIGEN_EULER_SYSTEM_TYPEDEF \
+ EIGEN_AUTODIFF_DECLARE_GLOBAL_UNARY \
+ EIGEN_MATRIX_FUNCTION \
+ EIGEN_MATRIX_FUNCTION_1 \
EIGEN_DOC_UNARY_ADDONS \
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL \
EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF
@@ -1665,7 +1669,7 @@ ALLEXTERNALS = NO
# in the modules index. If set to NO, only the current project's groups will
# be listed.
-EXTERNAL_GROUPS = YES
+EXTERNAL_GROUPS = NO
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of `which perl').
diff --git a/eigen/doc/eigen_navtree_hacks.js b/eigen/doc/eigen_navtree_hacks.js
index 39c59f7..a6f8c34 100644
--- a/eigen/doc/eigen_navtree_hacks.js
+++ b/eigen/doc/eigen_navtree_hacks.js
@@ -64,18 +64,20 @@ function getNode(o, po)
// Overloaded to adjust the size of the navtree wrt the toc
function resizeHeight()
{
- var toc = $("#nav-toc");
- var header = $("#header");
- var content = $("#doc-content");
- var navtree = $("#nav-path");
+ var header = $("#top");
var sidenav = $("#side-nav");
- var tocHeight = toc.height(); // <- we added this line
- var headerHeight = header.height();
- var footerHeight = footer.height();
+ var content = $("#doc-content");
+ var navtree = $("#nav-tree");
+ var footer = $("#nav-path");
+ var toc = $("#nav-toc");
+
+ var headerHeight = header.outerHeight();
+ var footerHeight = footer.outerHeight();
+ var tocHeight = toc.height();
var windowHeight = $(window).height() - headerHeight - footerHeight;
content.css({height:windowHeight + "px"});
- navtree.css({height:(windowHeight-tocHeight) + "px"}); // <- we modified this line
- sidenav.css({height:(windowHeight) + "px",top: headerHeight+"px"});
+ navtree.css({height:(windowHeight-tocHeight) + "px"});
+ sidenav.css({height:windowHeight + "px"});
}
// Overloaded to save the root node into global_navtree_object
@@ -159,19 +161,18 @@ function createIndent(o,domNode,node,level)
var level=-2; // <- we replaced level=-1 by level=-2
var n = node;
while (n.parentNode) { level++; n=n.parentNode; }
- var imgNode = document.createElement("img");
- imgNode.style.paddingLeft=(16*(level)).toString()+'px';
- imgNode.width = 16;
- imgNode.height = 22;
- imgNode.border = 0;
if (checkChildrenData(node)) { // <- we modified this line to use checkChildrenData(node) instead of node.childrenData
+ var imgNode = document.createElement("span");
+ imgNode.className = 'arrow';
+ imgNode.style.paddingLeft=(16*level).toString()+'px';
+ imgNode.innerHTML=arrowRight;
node.plus_img = imgNode;
node.expandToggle = document.createElement("a");
node.expandToggle.href = "javascript:void(0)";
node.expandToggle.onclick = function() {
if (node.expanded) {
$(node.getChildrenUL()).slideUp("fast");
- node.plus_img.src = node.relpath+"ftv2pnode.png";
+ node.plus_img.innerHTML=arrowRight;
node.expanded = false;
} else {
expandNode(o, node, false, false);
@@ -179,11 +180,13 @@ function createIndent(o,domNode,node,level)
}
node.expandToggle.appendChild(imgNode);
domNode.appendChild(node.expandToggle);
- imgNode.src = node.relpath+"ftv2pnode.png";
} else {
- imgNode.src = node.relpath+"ftv2node.png";
- domNode.appendChild(imgNode);
- }
+ var span = document.createElement("span");
+ span.className = 'arrow';
+ span.style.width = 16*(level+1)+'px';
+ span.innerHTML = '&#160;';
+ domNode.appendChild(span);
+ }
}
// Overloaded to automatically expand the selected node
@@ -237,8 +240,7 @@ $(document).ready(function() {
setTimeout(arguments.callee, 10);
}
})();
-});
-$(window).load(function() {
- resizeHeight();
+ $(window).load(resizeHeight);
});
+
diff --git a/eigen/doc/eigendoxy.css b/eigen/doc/eigendoxy.css
index 9a036d2..225f5d3 100644
--- a/eigen/doc/eigendoxy.css
+++ b/eigen/doc/eigendoxy.css
@@ -165,6 +165,8 @@ div.toc {
bottom:0;
border-radius:0px;
border-style: solid none none none;
+ max-height:50%;
+ overflow-y: scroll;
}
div.toc h3 {
diff --git a/eigen/doc/snippets/MatrixBase_cwiseEqual.cpp b/eigen/doc/snippets/MatrixBase_cwiseEqual.cpp
index eb3656f..469af64 100644
--- a/eigen/doc/snippets/MatrixBase_cwiseEqual.cpp
+++ b/eigen/doc/snippets/MatrixBase_cwiseEqual.cpp
@@ -3,5 +3,5 @@ m << 1, 0,
1, 1;
cout << "Comparing m with identity matrix:" << endl;
cout << m.cwiseEqual(MatrixXi::Identity(2,2)) << endl;
-int count = m.cwiseEqual(MatrixXi::Identity(2,2)).count();
+Index count = m.cwiseEqual(MatrixXi::Identity(2,2)).count();
cout << "Number of coefficients that are equal: " << count << endl;
diff --git a/eigen/doc/snippets/MatrixBase_cwiseNotEqual.cpp b/eigen/doc/snippets/MatrixBase_cwiseNotEqual.cpp
index 6a2e4fb..7f0a105 100644
--- a/eigen/doc/snippets/MatrixBase_cwiseNotEqual.cpp
+++ b/eigen/doc/snippets/MatrixBase_cwiseNotEqual.cpp
@@ -3,5 +3,5 @@ m << 1, 0,
1, 1;
cout << "Comparing m with identity matrix:" << endl;
cout << m.cwiseNotEqual(MatrixXi::Identity(2,2)) << endl;
-int count = m.cwiseNotEqual(MatrixXi::Identity(2,2)).count();
+Index count = m.cwiseNotEqual(MatrixXi::Identity(2,2)).count();
cout << "Number of coefficients that are not equal: " << count << endl;
diff --git a/eigen/doc/special_examples/CMakeLists.txt b/eigen/doc/special_examples/CMakeLists.txt
index 101fbc5..66ba4de 100644
--- a/eigen/doc/special_examples/CMakeLists.txt
+++ b/eigen/doc/special_examples/CMakeLists.txt
@@ -19,7 +19,6 @@ if(QT4_FOUND)
add_dependencies(all_examples Tutorial_sparse_example)
endif(QT4_FOUND)
-check_cxx_compiler_flag("-std=c++11" EIGEN_COMPILER_SUPPORT_CPP11)
if(EIGEN_COMPILER_SUPPORT_CPP11)
add_executable(random_cpp11 random_cpp11.cpp)
target_link_libraries(random_cpp11 ${EIGEN_STANDARD_LIBRARIES_TO_LINK_TO})