devtools/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2026-04-10 11:34:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add Array relational operator docs and FetchContent CMake guide

Browse Source 
libeigen/eigen!2329

Closes #2801 and #2793
This commit is contained in:
Pavel Guzenfeld
2026-03-21 01:50:58 +00:00
committed by Rasmus Munk Larsen
parent 9d1e5f3915
commit daecd28cd5
2 changed files with 140 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
doc/CoeffwiseMathFunctionsTable.dox
View File

@@ -471,6 +471,86 @@ This also means that, unless specified, if the function \c std::foo is available
plus \c using <a href="http://en.cppreference.com/w/cpp/numeric/math/isnan">\c std::isnan </a>; \cpp11</td>
<td></td>
</tr>
<tr>
<td class="code">
\anchor cwisetable_less
a \link ArrayBase::operator< operator< \endlink(b); \n
a \link ArrayBase::operator< operator< \endlink(s);
</td>
<td>coefficient-wise less than comparison (\f$ a_i \lt b_i \f$). \n
\c a and \c b can be either an array or scalar.</td>
<td class="code">
a[i] < b[i];
</td>
<td></td>
</tr>
<tr>
<td class="code">
\anchor cwisetable_less_equal
a \link ArrayBase::operator<= operator<= \endlink(b); \n
a \link ArrayBase::operator<= operator<= \endlink(s);
</td>
<td>coefficient-wise less than or equal comparison (\f$ a_i \le b_i \f$). \n
\c a and \c b can be either an array or scalar.</td>
<td class="code">
a[i] <= b[i];
</td>
<td></td>
</tr>
<tr>
<td class="code">
\anchor cwisetable_greater
a \link ArrayBase::operator> operator> \endlink(b); \n
a \link ArrayBase::operator> operator> \endlink(s);
</td>
<td>coefficient-wise greater than comparison (\f$ a_i \gt b_i \f$). \n
\c a and \c b can be either an array or scalar.</td>
<td class="code">
a[i] > b[i];
</td>
<td></td>
</tr>
<tr>
<td class="code">
\anchor cwisetable_greater_equal
a \link ArrayBase::operator>= operator>= \endlink(b); \n
a \link ArrayBase::operator>= operator>= \endlink(s);
</td>
<td>coefficient-wise greater than or equal comparison (\f$ a_i \ge b_i \f$). \n
\c a and \c b can be either an array or scalar.</td>
<td class="code">
a[i] >= b[i];
</td>
<td></td>
</tr>
<tr>
<td class="code">
\anchor cwisetable_equal
a \link ArrayBase::operator== operator== \endlink(b); \n
a \link ArrayBase::operator== operator== \endlink(s);
</td>
<td>coefficient-wise equality comparison (\f$ a_i = b_i \f$). \n
\c a and \c b can be either an array or scalar. \n
\warning Performs exact comparison; prefer \c isApprox() for floating-point types.</td>
<td class="code">
a[i] == b[i];
</td>
<td></td>
</tr>
<tr>
<td class="code">
\anchor cwisetable_not_equal
a \link ArrayBase::operator!= operator!= \endlink(b); \n
a \link ArrayBase::operator!= operator!= \endlink(s);
</td>
<td>coefficient-wise not-equal comparison (\f$ a_i \ne b_i \f$). \n
\c a and \c b can be either an array or scalar. \n
\warning Performs exact comparison; prefer \c isApprox() for floating-point types.</td>
<td class="code">
a[i] != b[i];
</td>
<td></td>
</tr>
<tr>
<th colspan="4">Error and gamma functions</th>
</tr>

60
doc/TopicCMakeGuide.dox
View File

@@ -60,6 +60,66 @@ if (TARGET Eigen3::Eigen)
endif (TARGET Eigen3::Eigen)
\endcode
\section title_fetchcontent Using FetchContent
Starting with CMake 3.11, you can use the
<a href="https://cmake.org/cmake/help/latest/module/FetchContent.html">FetchContent</a>
module to download and include %Eigen directly in your project without
installing it first.
A basic example:
\code{.cmake}
cmake_minimum_required(VERSION 3.11)
project(myproject)
include(FetchContent)
FetchContent_Declare(
Eigen
GIT_REPOSITORY https://gitlab.com/libeigen/eigen.git
GIT_TAG master
GIT_SHALLOW TRUE
EXCLUDE_FROM_ALL
)
FetchContent_MakeAvailable(Eigen)
add_executable(example example.cpp)
target_link_libraries(example Eigen3::Eigen)
\endcode
\subsection title_fetchcontent_options Disabling Eigen build options
When %Eigen is added as a sub-project, its documentation, testing, and
pkg-config targets may collide with your project's own targets. Disable
them before calling \c FetchContent_MakeAvailable:
\code{.cmake}
set(EIGEN_BUILD_DOC OFF CACHE BOOL "" FORCE)
set(EIGEN_BUILD_TESTING OFF CACHE BOOL "" FORCE)
set(BUILD_TESTING OFF CACHE BOOL "" FORCE)
set(EIGEN_BUILD_PKGCONFIG OFF CACHE BOOL "" FORCE)
FetchContent_MakeAvailable(Eigen)
\endcode
\subsection title_fetchcontent_exclude Using EXCLUDE_FROM_ALL
Projects that depend on %Eigen should typically exclude installing %Eigen by
default to avoid overwriting a previous installation. Pass
\c EXCLUDE_FROM_ALL in the \c FetchContent_Declare call (as shown above) or
the equivalent \c add_subdirectory option so that %Eigen's install rules are
not included in the default install target.
\subsection title_fetchcontent_cmake330 Note for CMake 3.30 and later
CMake 3.30 changed the default value of the
<a href="https://cmake.org/cmake/help/latest/policy/CMP0168.html">CMP0168</a>
policy so that \c FetchContent_Declare uses
\c FetchContent_Populate internally with a different sub-build strategy.
If you encounter issues with sub-builds you can either upgrade to a
compatible %Eigen version or set the policy explicitly:
\code{.cmake}
cmake_policy(SET CMP0168 OLD)
\endcode
*/
}