mirror of
https://gitlab.com/libeigen/eigen.git
synced 2026-01-18 17:31:19 +01:00
1a5eecd45e
<!-- Thanks for contributing a merge request! We recommend that first-time contributors read our [contribution guidelines](https://eigen.tuxfamily.org/index.php?title=Contributing_to_Eigen). Before submitting the MR, please complete the following checks: - Create one PR per feature or bugfix, - Run the test suite to verify your changes. See our [test guidelines](https://eigen.tuxfamily.org/index.php?title=Tests). - Add tests to cover the bug addressed or any new feature. - Document new features. If it is a substantial change, add it to the [Changelog](https://gitlab.com/libeigen/eigen/-/blob/master/CHANGELOG.md). - Leave the following box checked when submitting: `Allow commits from members who can merge to the target branch`. This allows us to rebase and merge your change. Note that we are a team of volunteers; we appreciate your patience during the review process. --> ### Description <!--Please explain your changes.--> Clarify range spanning major versions only works with 3.4.1. ### Reference issue <!-- You can link to a specific issue using the gitlab syntax #<issue number>. If the MR fixes an issue, write "Fixes #<issue number>" to have the issue automatically closed on merge. --> Fixes #2994. Closes #2994 See merge request libeigen/eigen!2042
66 lines
2.2 KiB
Plaintext
66 lines
2.2 KiB
Plaintext
namespace Eigen {
|
|
|
|
/**
|
|
|
|
\page TopicCMakeGuide Using %Eigen in CMake Projects
|
|
|
|
%Eigen provides native CMake support which allows the library to be easily
|
|
used in CMake projects.
|
|
|
|
\note %CMake 3.5 (or later) is required to enable this functionality.
|
|
|
|
%Eigen exports a CMake target called `Eigen3::Eigen` which can be imported
|
|
using the `find_package` CMake command and used by calling
|
|
`target_link_libraries` as in the following example:
|
|
\code{.cmake}
|
|
cmake_minimum_required (VERSION 3.5)
|
|
project (myproject)
|
|
|
|
find_package (Eigen3 REQUIRED NO_MODULE)
|
|
|
|
add_executable (example example.cpp)
|
|
target_link_libraries (example Eigen3::Eigen)
|
|
\endcode
|
|
|
|
The above code snippet must be placed in a file called `CMakeLists.txt` alongside
|
|
`example.cpp`. After running
|
|
\code{.sh}
|
|
$ cmake path-to-example-directory
|
|
\endcode
|
|
CMake will produce project files that generate an executable called `example`.
|
|
Here, `path-to-example-directory` is the path to the directory that contains
|
|
both `CMakeLists.txt` and `example.cpp`. Note that if you have multiple
|
|
instances of %Eigen installed, `find_package` will use the first one
|
|
encountered. To request a specific version of %Eigen, use the `<version>`
|
|
option in `find_package`:
|
|
```
|
|
find_package(Eigen3 3.4 REQUIRED NO_MODULE) # Restricts to 3.4.z
|
|
```
|
|
Starting with Eigen 3.4.1, we also support a range spanning major versions:
|
|
```
|
|
find_package(Eigen3 3.4...5 REQUIRED NO_MODULE) # Any version >=3.4.1 but <6.0.0.
|
|
```
|
|
|
|
Do not forget to set the <a href="https://cmake.org/cmake/help/v3.7/variable/CMAKE_PREFIX_PATH.html">\c CMAKE_PREFIX_PATH </a> variable if Eigen is not installed in a default location or if you want to pick a specific version. For instance:
|
|
\code{.sh}
|
|
$ cmake path-to-example-directory -DCMAKE_PREFIX_PATH=$HOME/mypackages
|
|
\endcode
|
|
An alternative is to set the \c Eigen3_DIR cmake's variable to the respective path containing the \c Eigen3*.cmake files. For instance:
|
|
\code{.sh}
|
|
$ cmake path-to-example-directory -DEigen3_DIR=$HOME/mypackages/share/eigen3/cmake/
|
|
\endcode
|
|
|
|
If the `REQUIRED` option is omitted when locating %Eigen using
|
|
`find_package`, one can check whether the package was found as follows:
|
|
\code{.cmake}
|
|
find_package (Eigen3 NO_MODULE)
|
|
|
|
if (TARGET Eigen3::Eigen)
|
|
# Use the imported target
|
|
endif (TARGET Eigen3::Eigen)
|
|
\endcode
|
|
|
|
*/
|
|
|
|
}
|