From f27ddfc6acbfd28a55fd1a2a422ad05239ea9051 Mon Sep 17 00:00:00 2001 From: zhangshuai Date: Tue, 28 May 2019 08:28:29 +0800 Subject: [PATCH] add ign-math --- Gazebo_Distributed_MPI/mpi_run/hostfile | 2 +- ign-math/.gitignore | 1 + ign-math/AUTHORS | 1 + ign-math/CMakeLists.txt | 308 + ign-math/COPYING | 178 + ign-math/Changelog.md | 103 + ign-math/LICENSE | 15 + ign-math/NEWS | 1 + ign-math/README.md | 45 + ign-math/appveyor.yml | 22 + ign-math/bitbucket-pipelines.yml | 21 + ign-math/cmake/CodeCoverage.cmake | 134 + ign-math/cmake/DefaultCFlags.cmake | 42 + ign-math/cmake/DissectVersion.cmake | 5 + ign-math/cmake/FindOS.cmake | 55 + ign-math/cmake/FindSSE.cmake | 113 + ign-math/cmake/HostCFlags.cmake | 27 + ign-math/cmake/Ronn2Man.cmake | 59 + ign-math/cmake/SearchForStuff.cmake | 23 + ign-math/cmake/TargetArch.cmake | 158 + ign-math/cmake/TestUtils.cmake | 48 + ign-math/cmake/Utils.cmake | 179 + ign-math/cmake/cmake_uninstall.cmake.in | 21 + ign-math/cmake/config.hh.in | 15 + ign-math/cmake/cpack.cmake | 25 + ign-math/cmake/cpack_options.cmake.in | 28 + ign-math/cmake/ignition-math-config.cmake.in | 41 + ign-math/cmake/pkgconfig/ignition-math.in | 10 + ign-math/cmake/upload_doc.sh.in | 29 + ign-math/codecov.yml | 2 + ign-math/configure.bat | 23 + ign-math/doc/CMakeLists.txt | 14 + ign-math/doc/footer.html | 1 + ign-math/doc/header.html | 67 + ign-math/doc/ignition.in | 2306 +++++++ ign-math/doc/ignition_logo.svg | 249 + ign-math/doc/mainpage.html | 17 + ign-math/doc/style.css | 107 + ign-math/examples/CMakeLists.txt | 10 + ign-math/examples/triangle_example.cc | 80 + ign-math/examples/vector2_example.cc | 72 + ign-math/include/CMakeLists.txt | 1 + ign-math/include/ignition/CMakeLists.txt | 1 + .../include/ignition/math/AffineException.hh | 49 + ign-math/include/ignition/math/Angle.hh | 203 + ign-math/include/ignition/math/Box.hh | 231 + ign-math/include/ignition/math/BoxPrivate.hh | 45 + ign-math/include/ignition/math/CMakeLists.txt | 49 + ign-math/include/ignition/math/Color.hh | 318 + ign-math/include/ignition/math/Filter.hh | 248 + ign-math/include/ignition/math/Frustum.hh | 181 + .../include/ignition/math/FrustumPrivate.hh | 84 + ign-math/include/ignition/math/Helpers.hh | 680 ++ .../include/ignition/math/IndexException.hh | 48 + ign-math/include/ignition/math/Inertial.hh | 244 + ign-math/include/ignition/math/Kmeans.hh | 86 + .../include/ignition/math/KmeansPrivate.hh | 51 + ign-math/include/ignition/math/Line2.hh | 319 + ign-math/include/ignition/math/Line3.hh | 391 ++ ign-math/include/ignition/math/MassMatrix3.hh | 904 +++ .../include/ignition/math/MassMatrix3.ipynb | 134 + ign-math/include/ignition/math/Matrix3.hh | 528 ++ ign-math/include/ignition/math/Matrix4.hh | 860 +++ ign-math/include/ignition/math/OrientedBox.hh | 187 + ign-math/include/ignition/math/PID.hh | 228 + ign-math/include/ignition/math/Plane.hh | 232 + ign-math/include/ignition/math/Pose3.hh | 411 ++ ign-math/include/ignition/math/Quaternion.hh | 1074 ++++ ign-math/include/ignition/math/Rand.hh | 94 + .../include/ignition/math/RotationSpline.hh | 116 + .../ignition/math/RotationSplinePrivate.hh | 46 + .../include/ignition/math/SemanticVersion.hh | 160 + ign-math/include/ignition/math/SignalStats.hh | 231 + .../ignition/math/SignalStatsPrivate.hh | 74 + .../ignition/math/SphericalCoordinates.hh | 232 + ign-math/include/ignition/math/Spline.hh | 124 + .../include/ignition/math/SplinePrivate.hh | 49 + ign-math/include/ignition/math/Temperature.hh | 375 ++ ign-math/include/ignition/math/Triangle.hh | 247 + ign-math/include/ignition/math/Triangle3.hh | 284 + ign-math/include/ignition/math/Vector2.hh | 480 ++ ign-math/include/ignition/math/Vector3.hh | 752 +++ .../include/ignition/math/Vector3Stats.hh | 107 + .../ignition/math/Vector3StatsPrivate.hh | 44 + ign-math/include/ignition/math/Vector4.hh | 553 ++ ign-math/include/ignition/math/math.hh.in | 3 + ign-math/src/Angle.cc | 173 + ign-math/src/Angle_TEST.cc | 119 + ign-math/src/Box.cc | 332 + ign-math/src/Box_TEST.cc | 507 ++ ign-math/src/CMakeLists.txt | 60 + ign-math/src/Color.cc | 583 ++ ign-math/src/Color_TEST.cc | 379 ++ ign-math/src/Filter_TEST.cc | 105 + ign-math/src/Frustum.cc | 348 + ign-math/src/Frustum_TEST.cc | 651 ++ ign-math/src/Helpers.cc | 47 + ign-math/src/Helpers_TEST.cc | 434 ++ ign-math/src/IndexException.cc | 25 + ign-math/src/Inertial_TEST.cc | 527 ++ ign-math/src/Kmeans.cc | 172 + ign-math/src/Kmeans_TEST.cc | 142 + ign-math/src/Line2_TEST.cc | 262 + ign-math/src/Line3_TEST.cc | 292 + ign-math/src/MassMatrix3_TEST.cc | 857 +++ ign-math/src/Matrix3_TEST.cc | 400 ++ ign-math/src/Matrix4_TEST.cc | 653 ++ ign-math/src/OrientedBox_TEST.cc | 335 + ign-math/src/PID.cc | 243 + ign-math/src/PID_TEST.cc | 402 ++ ign-math/src/Plane_TEST.cc | 143 + ign-math/src/Pose_TEST.cc | 157 + ign-math/src/Quaternion_TEST.cc | 561 ++ ign-math/src/Rand.cc | 82 + ign-math/src/Rand_TEST.cc | 79 + ign-math/src/RotationSpline.cc | 204 + ign-math/src/RotationSplinePrivate.cc | 26 + ign-math/src/RotationSpline_TEST.cc | 95 + ign-math/src/SemanticVersion.cc | 294 + ign-math/src/SemanticVersion_TEST.cc | 217 + ign-math/src/SignalStats.cc | 349 + ign-math/src/SignalStats_TEST.cc | 621 ++ ign-math/src/SphericalCoordinates.cc | 557 ++ ign-math/src/SphericalCoordinates_TEST.cc | 385 ++ ign-math/src/Spline.cc | 275 + ign-math/src/Spline_TEST.cc | 111 + ign-math/src/Temperature.cc | 325 + ign-math/src/Temperature_TEST.cc | 178 + ign-math/src/Triangle3_TEST.cc | 258 + ign-math/src/Triangle_TEST.cc | 193 + ign-math/src/Vector2_TEST.cc | 302 + ign-math/src/Vector3Stats.cc | 121 + ign-math/src/Vector3Stats_TEST.cc | 190 + ign-math/src/Vector3_TEST.cc | 414 ++ ign-math/src/Vector4_TEST.cc | 310 + ign-math/test/CMakeLists.txt | 22 + .../test/gtest/cmake/internal_utils.cmake | 227 + .../gtest/include/gtest/gtest-death-test.h | 294 + .../test/gtest/include/gtest/gtest-message.h | 250 + .../gtest/include/gtest/gtest-param-test.h | 1421 +++++ .../include/gtest/gtest-param-test.h.pump | 487 ++ .../test/gtest/include/gtest/gtest-printers.h | 855 +++ ign-math/test/gtest/include/gtest/gtest-spi.h | 232 + .../gtest/include/gtest/gtest-test-part.h | 179 + .../gtest/include/gtest/gtest-typed-test.h | 259 + ign-math/test/gtest/include/gtest/gtest.h | 2291 +++++++ .../gtest/include/gtest/gtest_pred_impl.h | 358 ++ .../test/gtest/include/gtest/gtest_prod.h | 58 + .../internal/gtest-death-test-internal.h | 319 + .../include/gtest/internal/gtest-filepath.h | 206 + .../include/gtest/internal/gtest-internal.h | 1158 ++++ .../include/gtest/internal/gtest-linked_ptr.h | 233 + .../internal/gtest-param-util-generated.h | 5143 +++++++++++++++ .../gtest-param-util-generated.h.pump | 301 + .../include/gtest/internal/gtest-param-util.h | 619 ++ .../gtest/include/gtest/internal/gtest-port.h | 1947 ++++++ .../include/gtest/internal/gtest-string.h | 167 + .../include/gtest/internal/gtest-tuple.h | 1012 +++ .../include/gtest/internal/gtest-tuple.h.pump | 339 + .../include/gtest/internal/gtest-type-util.h | 3331 ++++++++++ .../gtest/internal/gtest-type-util.h.pump | 297 + ign-math/test/gtest/src/gtest-all.cc | 48 + ign-math/test/gtest/src/gtest-death-test.cc | 1344 ++++ ign-math/test/gtest/src/gtest-filepath.cc | 382 ++ ign-math/test/gtest/src/gtest-internal-inl.h | 1218 ++++ ign-math/test/gtest/src/gtest-port.cc | 805 +++ ign-math/test/gtest/src/gtest-printers.cc | 363 ++ ign-math/test/gtest/src/gtest-test-part.cc | 110 + ign-math/test/gtest/src/gtest-typed-test.cc | 110 + ign-math/test/gtest/src/gtest.cc | 5015 +++++++++++++++ ign-math/test/gtest/src/gtest_main.cc | 38 + ign-math/test/integration/CMakeLists.txt | 8 + ign-math/test/performance/CMakeLists.txt | 8 + ign-math/test/regression/CMakeLists.txt | 8 + ign-math/test/test_config.h.in | 1 + ign-math/tools/check_test_ran.py | 79 + ign-math/tools/code_check.sh | 143 + .../tools/cppcheck_rules/header_guard.rule | 10 + .../tools/cppcheck_rules/namespace_AZ.rule | 9 + ign-math/tools/cpplint.py | 5622 +++++++++++++++++ ign-math/tools/cpplint_to_cppcheckxml.py | 54 + 181 files changed, 68289 insertions(+), 1 deletion(-) create mode 100644 ign-math/.gitignore create mode 100644 ign-math/AUTHORS create mode 100644 ign-math/CMakeLists.txt create mode 100644 ign-math/COPYING create mode 100644 ign-math/Changelog.md create mode 100644 ign-math/LICENSE create mode 100644 ign-math/NEWS create mode 100644 ign-math/README.md create mode 100644 ign-math/appveyor.yml create mode 100644 ign-math/bitbucket-pipelines.yml create mode 100644 ign-math/cmake/CodeCoverage.cmake create mode 100644 ign-math/cmake/DefaultCFlags.cmake create mode 100644 ign-math/cmake/DissectVersion.cmake create mode 100644 ign-math/cmake/FindOS.cmake create mode 100644 ign-math/cmake/FindSSE.cmake create mode 100644 ign-math/cmake/HostCFlags.cmake create mode 100644 ign-math/cmake/Ronn2Man.cmake create mode 100644 ign-math/cmake/SearchForStuff.cmake create mode 100644 ign-math/cmake/TargetArch.cmake create mode 100644 ign-math/cmake/TestUtils.cmake create mode 100644 ign-math/cmake/Utils.cmake create mode 100644 ign-math/cmake/cmake_uninstall.cmake.in create mode 100644 ign-math/cmake/config.hh.in create mode 100644 ign-math/cmake/cpack.cmake create mode 100644 ign-math/cmake/cpack_options.cmake.in create mode 100644 ign-math/cmake/ignition-math-config.cmake.in create mode 100644 ign-math/cmake/pkgconfig/ignition-math.in create mode 100644 ign-math/cmake/upload_doc.sh.in create mode 100644 ign-math/codecov.yml create mode 100644 ign-math/configure.bat create mode 100644 ign-math/doc/CMakeLists.txt create mode 100644 ign-math/doc/footer.html create mode 100644 ign-math/doc/header.html create mode 100644 ign-math/doc/ignition.in create mode 100644 ign-math/doc/ignition_logo.svg create mode 100644 ign-math/doc/mainpage.html create mode 100644 ign-math/doc/style.css create mode 100644 ign-math/examples/CMakeLists.txt create mode 100644 ign-math/examples/triangle_example.cc create mode 100644 ign-math/examples/vector2_example.cc create mode 100644 ign-math/include/CMakeLists.txt create mode 100644 ign-math/include/ignition/CMakeLists.txt create mode 100644 ign-math/include/ignition/math/AffineException.hh create mode 100644 ign-math/include/ignition/math/Angle.hh create mode 100644 ign-math/include/ignition/math/Box.hh create mode 100644 ign-math/include/ignition/math/BoxPrivate.hh create mode 100644 ign-math/include/ignition/math/CMakeLists.txt create mode 100644 ign-math/include/ignition/math/Color.hh create mode 100644 ign-math/include/ignition/math/Filter.hh create mode 100644 ign-math/include/ignition/math/Frustum.hh create mode 100644 ign-math/include/ignition/math/FrustumPrivate.hh create mode 100644 ign-math/include/ignition/math/Helpers.hh create mode 100644 ign-math/include/ignition/math/IndexException.hh create mode 100644 ign-math/include/ignition/math/Inertial.hh create mode 100644 ign-math/include/ignition/math/Kmeans.hh create mode 100644 ign-math/include/ignition/math/KmeansPrivate.hh create mode 100644 ign-math/include/ignition/math/Line2.hh create mode 100644 ign-math/include/ignition/math/Line3.hh create mode 100644 ign-math/include/ignition/math/MassMatrix3.hh create mode 100644 ign-math/include/ignition/math/MassMatrix3.ipynb create mode 100644 ign-math/include/ignition/math/Matrix3.hh create mode 100644 ign-math/include/ignition/math/Matrix4.hh create mode 100644 ign-math/include/ignition/math/OrientedBox.hh create mode 100644 ign-math/include/ignition/math/PID.hh create mode 100644 ign-math/include/ignition/math/Plane.hh create mode 100644 ign-math/include/ignition/math/Pose3.hh create mode 100644 ign-math/include/ignition/math/Quaternion.hh create mode 100644 ign-math/include/ignition/math/Rand.hh create mode 100644 ign-math/include/ignition/math/RotationSpline.hh create mode 100644 ign-math/include/ignition/math/RotationSplinePrivate.hh create mode 100644 ign-math/include/ignition/math/SemanticVersion.hh create mode 100644 ign-math/include/ignition/math/SignalStats.hh create mode 100644 ign-math/include/ignition/math/SignalStatsPrivate.hh create mode 100644 ign-math/include/ignition/math/SphericalCoordinates.hh create mode 100644 ign-math/include/ignition/math/Spline.hh create mode 100644 ign-math/include/ignition/math/SplinePrivate.hh create mode 100644 ign-math/include/ignition/math/Temperature.hh create mode 100644 ign-math/include/ignition/math/Triangle.hh create mode 100644 ign-math/include/ignition/math/Triangle3.hh create mode 100644 ign-math/include/ignition/math/Vector2.hh create mode 100644 ign-math/include/ignition/math/Vector3.hh create mode 100644 ign-math/include/ignition/math/Vector3Stats.hh create mode 100644 ign-math/include/ignition/math/Vector3StatsPrivate.hh create mode 100644 ign-math/include/ignition/math/Vector4.hh create mode 100644 ign-math/include/ignition/math/math.hh.in create mode 100644 ign-math/src/Angle.cc create mode 100644 ign-math/src/Angle_TEST.cc create mode 100644 ign-math/src/Box.cc create mode 100644 ign-math/src/Box_TEST.cc create mode 100644 ign-math/src/CMakeLists.txt create mode 100644 ign-math/src/Color.cc create mode 100644 ign-math/src/Color_TEST.cc create mode 100644 ign-math/src/Filter_TEST.cc create mode 100644 ign-math/src/Frustum.cc create mode 100644 ign-math/src/Frustum_TEST.cc create mode 100644 ign-math/src/Helpers.cc create mode 100644 ign-math/src/Helpers_TEST.cc create mode 100644 ign-math/src/IndexException.cc create mode 100644 ign-math/src/Inertial_TEST.cc create mode 100644 ign-math/src/Kmeans.cc create mode 100644 ign-math/src/Kmeans_TEST.cc create mode 100644 ign-math/src/Line2_TEST.cc create mode 100644 ign-math/src/Line3_TEST.cc create mode 100644 ign-math/src/MassMatrix3_TEST.cc create mode 100644 ign-math/src/Matrix3_TEST.cc create mode 100644 ign-math/src/Matrix4_TEST.cc create mode 100644 ign-math/src/OrientedBox_TEST.cc create mode 100644 ign-math/src/PID.cc create mode 100644 ign-math/src/PID_TEST.cc create mode 100644 ign-math/src/Plane_TEST.cc create mode 100644 ign-math/src/Pose_TEST.cc create mode 100644 ign-math/src/Quaternion_TEST.cc create mode 100644 ign-math/src/Rand.cc create mode 100644 ign-math/src/Rand_TEST.cc create mode 100644 ign-math/src/RotationSpline.cc create mode 100644 ign-math/src/RotationSplinePrivate.cc create mode 100644 ign-math/src/RotationSpline_TEST.cc create mode 100644 ign-math/src/SemanticVersion.cc create mode 100644 ign-math/src/SemanticVersion_TEST.cc create mode 100644 ign-math/src/SignalStats.cc create mode 100644 ign-math/src/SignalStats_TEST.cc create mode 100644 ign-math/src/SphericalCoordinates.cc create mode 100644 ign-math/src/SphericalCoordinates_TEST.cc create mode 100644 ign-math/src/Spline.cc create mode 100644 ign-math/src/Spline_TEST.cc create mode 100644 ign-math/src/Temperature.cc create mode 100644 ign-math/src/Temperature_TEST.cc create mode 100644 ign-math/src/Triangle3_TEST.cc create mode 100644 ign-math/src/Triangle_TEST.cc create mode 100644 ign-math/src/Vector2_TEST.cc create mode 100644 ign-math/src/Vector3Stats.cc create mode 100644 ign-math/src/Vector3Stats_TEST.cc create mode 100644 ign-math/src/Vector3_TEST.cc create mode 100644 ign-math/src/Vector4_TEST.cc create mode 100644 ign-math/test/CMakeLists.txt create mode 100644 ign-math/test/gtest/cmake/internal_utils.cmake create mode 100644 ign-math/test/gtest/include/gtest/gtest-death-test.h create mode 100644 ign-math/test/gtest/include/gtest/gtest-message.h create mode 100644 ign-math/test/gtest/include/gtest/gtest-param-test.h create mode 100644 ign-math/test/gtest/include/gtest/gtest-param-test.h.pump create mode 100644 ign-math/test/gtest/include/gtest/gtest-printers.h create mode 100644 ign-math/test/gtest/include/gtest/gtest-spi.h create mode 100644 ign-math/test/gtest/include/gtest/gtest-test-part.h create mode 100644 ign-math/test/gtest/include/gtest/gtest-typed-test.h create mode 100644 ign-math/test/gtest/include/gtest/gtest.h create mode 100644 ign-math/test/gtest/include/gtest/gtest_pred_impl.h create mode 100644 ign-math/test/gtest/include/gtest/gtest_prod.h create mode 100644 ign-math/test/gtest/include/gtest/internal/gtest-death-test-internal.h create mode 100644 ign-math/test/gtest/include/gtest/internal/gtest-filepath.h create mode 100644 ign-math/test/gtest/include/gtest/internal/gtest-internal.h create mode 100644 ign-math/test/gtest/include/gtest/internal/gtest-linked_ptr.h create mode 100644 ign-math/test/gtest/include/gtest/internal/gtest-param-util-generated.h create mode 100644 ign-math/test/gtest/include/gtest/internal/gtest-param-util-generated.h.pump create mode 100644 ign-math/test/gtest/include/gtest/internal/gtest-param-util.h create mode 100644 ign-math/test/gtest/include/gtest/internal/gtest-port.h create mode 100644 ign-math/test/gtest/include/gtest/internal/gtest-string.h create mode 100644 ign-math/test/gtest/include/gtest/internal/gtest-tuple.h create mode 100644 ign-math/test/gtest/include/gtest/internal/gtest-tuple.h.pump create mode 100644 ign-math/test/gtest/include/gtest/internal/gtest-type-util.h create mode 100644 ign-math/test/gtest/include/gtest/internal/gtest-type-util.h.pump create mode 100644 ign-math/test/gtest/src/gtest-all.cc create mode 100644 ign-math/test/gtest/src/gtest-death-test.cc create mode 100644 ign-math/test/gtest/src/gtest-filepath.cc create mode 100644 ign-math/test/gtest/src/gtest-internal-inl.h create mode 100644 ign-math/test/gtest/src/gtest-port.cc create mode 100644 ign-math/test/gtest/src/gtest-printers.cc create mode 100644 ign-math/test/gtest/src/gtest-test-part.cc create mode 100644 ign-math/test/gtest/src/gtest-typed-test.cc create mode 100644 ign-math/test/gtest/src/gtest.cc create mode 100644 ign-math/test/gtest/src/gtest_main.cc create mode 100644 ign-math/test/integration/CMakeLists.txt create mode 100644 ign-math/test/performance/CMakeLists.txt create mode 100644 ign-math/test/regression/CMakeLists.txt create mode 100644 ign-math/test/test_config.h.in create mode 100755 ign-math/tools/check_test_ran.py create mode 100644 ign-math/tools/code_check.sh create mode 100644 ign-math/tools/cppcheck_rules/header_guard.rule create mode 100644 ign-math/tools/cppcheck_rules/namespace_AZ.rule create mode 100644 ign-math/tools/cpplint.py create mode 100644 ign-math/tools/cpplint_to_cppcheckxml.py diff --git a/Gazebo_Distributed_MPI/mpi_run/hostfile b/Gazebo_Distributed_MPI/mpi_run/hostfile index addd08b..8e019ca 100644 --- a/Gazebo_Distributed_MPI/mpi_run/hostfile +++ b/Gazebo_Distributed_MPI/mpi_run/hostfile @@ -1,4 +1,4 @@ airc02-PowerEdge-T640 slots=1 -zhangshuai-ThinkPad-X250 slots=1 +anwen slots=1 diff --git a/ign-math/.gitignore b/ign-math/.gitignore new file mode 100644 index 0000000..378eac2 --- /dev/null +++ b/ign-math/.gitignore @@ -0,0 +1 @@ +build diff --git a/ign-math/AUTHORS b/ign-math/AUTHORS new file mode 100644 index 0000000..65032b7 --- /dev/null +++ b/ign-math/AUTHORS @@ -0,0 +1 @@ +OSRFoundation diff --git a/ign-math/CMakeLists.txt b/ign-math/CMakeLists.txt new file mode 100644 index 0000000..96f4f46 --- /dev/null +++ b/ign-math/CMakeLists.txt @@ -0,0 +1,308 @@ +cmake_minimum_required(VERSION 2.8 FATAL_ERROR) + +set (IGN_PROJECT_NAME "math") + +project (ignition-${IGN_PROJECT_NAME}) +string (TOLOWER ${PROJECT_NAME} PROJECT_NAME_LOWER) +string (TOUPPER ${PROJECT_NAME} PROJECT_NAME_UPPER) + +set (PROJECT_MAJOR_VERSION 2) +set (PROJECT_MINOR_VERSION 9) +set (PROJECT_PATCH_VERSION 0) + +set (PROJECT_VERSION ${PROJECT_MAJOR_VERSION}.${PROJECT_MINOR_VERSION}) +set (PROJECT_VERSION_FULL + ${PROJECT_MAJOR_VERSION}.${PROJECT_MINOR_VERSION}.${PROJECT_PATCH_VERSION}) + +message (STATUS "${PROJECT_NAME} version ${PROJECT_VERSION_FULL}") + +set (project_cmake_dir ${PROJECT_SOURCE_DIR}/cmake + CACHE PATH "Location of CMake scripts") + +include (${project_cmake_dir}/Utils.cmake) + +######################################## +# Package Creation: +include (${project_cmake_dir}/cpack.cmake) +set (CPACK_PACKAGE_VERSION "${PROJECT_VERSION_FULL}") +set (CPACK_PACKAGE_VERSION_MAJOR "${PROJECT_MAJOR_VERSION}") +set (CPACK_PACKAGE_VERSION_MINOR "${PROJECT_MINOR_VERSION}") +set (CPACK_PACKAGE_VERSION_PATCH "${PROJECT_PATCH_VERSION}") + +if (CPACK_GENERATOR) + message(STATUS "Found CPack generators: ${CPACK_GENERATOR}") + + configure_file("${project_cmake_dir}/cpack_options.cmake.in" + ${PROJECT_CPACK_CFG_FILE} @ONLY) + + set(CPACK_PROJECT_CONFIG_FILE ${PROJECT_CPACK_CFG_FILE}) + include (CPack) +endif() + +# If we're configuring only to package source, stop here +if (PACKAGE_SOURCE_ONLY) + message(WARNING "Configuration was done in PACKAGE_SOURCE_ONLY mode." + "You can build a tarball (make package_source), but nothing else.") + return() +endif() + +################################################# +# Documentation: +add_subdirectory(doc) + +# Configure documentation uploader +configure_file("${project_cmake_dir}/upload_doc.sh.in" + ${CMAKE_BINARY_DIR}/upload_doc.sh @ONLY) + +# If we're configuring only to build docs, stop here +if (DOC_ONLY) + message(WARNING "Configuration was done in DOC_ONLY mode." + " You can build documentation (make doc), but nothing else.") + return() +endif() + +enable_testing() + +# Use GNUInstallDirst to get canonical paths +include(GNUInstallDirs) + +# with -fPIC +if(UNIX AND NOT WIN32) + set (CMAKE_INSTALL_PREFIX "/usr" CACHE STRING "Install Prefix") + find_program(CMAKE_UNAME uname /bin /usr/bin /usr/local/bin ) + if(CMAKE_UNAME) + exec_program(uname ARGS -m OUTPUT_VARIABLE CMAKE_SYSTEM_PROCESSOR) + set(CMAKE_SYSTEM_PROCESSOR ${CMAKE_SYSTEM_PROCESSOR} CACHE INTERNAL + "processor type (i386 and x86_64)") + if(CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64") + ADD_DEFINITIONS(-fPIC) + endif(CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64") + endif(CMAKE_UNAME) +endif() + +set (CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE ON) + +# developer's option to cache PKG_CONFIG_PATH and +# LD_LIBRARY_PATH for local installs +if(PKG_CONFIG_PATH) + set (ENV{PKG_CONFIG_PATH} ${PKG_CONFIG_PATH}:$ENV{PKG_CONFIG_PATH}) +endif() +if(LD_LIBRARY_PATH) + set (ENV{LD_LIBRARY_PATH} ${LD_LIBRARY_PATH}:$ENV{LD_LIBRARY_PATH}) +endif() + + +set (INCLUDE_INSTALL_DIR "${CMAKE_INSTALL_INCLUDEDIR}/ignition") +set (LIB_INSTALL_DIR ${CMAKE_INSTALL_LIBDIR}) +set (BIN_INSTALL_DIR ${CMAKE_INSTALL_BINDIR}) + +set (USE_FULL_RPATH OFF CACHE BOOL "Set to true to enable full rpath") + +if (USE_FULL_RPATH) + # use, i.e. don't skip the full RPATH for the build tree + set(CMAKE_SKIP_BUILD_RPATH FALSE) + + # when building, don't use the install RPATH already + # (but later on when installing) + set(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE) + + set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${LIB_INSTALL_DIR}") + + # add the automatically determined parts of the RPATH + # which point to directories outside the build tree to the install RPATH + set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE) + + # the RPATH to be used when installing, but only if its not a system directory + list(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES "${CMAKE_INSTALL_PREFIX}/${LIB_INSTALL_DIR}" isSystemDir) + if("${isSystemDir}" STREQUAL "-1") + set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${LIB_INSTALL_DIR}") + endif("${isSystemDir}" STREQUAL "-1") +endif() + +set (BUILD_IGNITION ON CACHE INTERNAL "Build Ignition Math" FORCE) +set (build_errors "" CACHE INTERNAL "build errors" FORCE) +set (build_warnings "" CACHE INTERNAL "build warnings" FORCE) + +include (${project_cmake_dir}/DissectVersion.cmake) + +message (STATUS "\n\n====== Finding 3rd Party Packages ======") +include (${project_cmake_dir}/SearchForStuff.cmake) +message (STATUS "----------------------------------------\n") + +##################################### +MESSAGE(STATUS "Checking ignition build type") +# Set the default build type +if (NOT CMAKE_BUILD_TYPE) + set (CMAKE_BUILD_TYPE "RelWithDebInfo" CACHE STRING + "Choose the type of build, options are: Debug Release RelWithDebInfo Profile Check" FORCE) +endif (NOT CMAKE_BUILD_TYPE) +# TODO: still convert to uppercase to keep backwards compatibility with +# uppercase old supported and deprecated modes +string(TOUPPER ${CMAKE_BUILD_TYPE} CMAKE_BUILD_TYPE_UPPERCASE) + +set (BUILD_TYPE_PROFILE FALSE) +set (BUILD_TYPE_RELEASE FALSE) +set (BUILD_TYPE_RELWITHDEBINFO FALSE) +set (BUILD_TYPE_DEBUG FALSE) + +if ("${CMAKE_BUILD_TYPE_UPPERCASE}" STREQUAL "PROFILE") + set (BUILD_TYPE_PROFILE TRUE) +elseif ("${CMAKE_BUILD_TYPE_UPPERCASE}" STREQUAL "RELEASE") + set (BUILD_TYPE_RELEASE TRUE) +elseif ("${CMAKE_BUILD_TYPE_UPPERCASE}" STREQUAL "RELWITHDEBINFO") + set (BUILD_TYPE_RELWITHDEBINFO TRUE) +elseif ("${CMAKE_BUILD_TYPE_UPPERCASE}" STREQUAL "DEBUG") + set (BUILD_TYPE_DEBUG TRUE) +elseif ("${CMAKE_BUILD_TYPE_UPPERCASE}" STREQUAL "COVERAGE") + include (${project_cmake_dir}/CodeCoverage.cmake) + set (BUILD_TYPE_DEBUG TRUE) + SETUP_TARGET_FOR_COVERAGE(coverage ctest coverage) +else() + build_error("CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE} unknown. Valid options are: Debug Release RelWithDebInfo Profile Check") +endif() + +##################################### +# Handle CFlags +unset (CMAKE_C_FLAGS_ALL CACHE) +unset (CMAKE_CXX_FLAGS CACHE) + +# Check if warning options are avaliable for the compiler and return WARNING_CXX_FLAGS variable +# MSVC generates tons of warnings on gtest code. +# Recommended to use /W4 instead of /Wall +if (MSVC) + set(WARN_LEVEL "/W4") +else() + set(WARN_LEVEL "-Wall") +endif() + +filter_valid_compiler_warnings(${WARN_LEVEL} -Wextra -Wno-long-long + -Wno-unused-value -Wno-unused-value -Wno-unused-value -Wno-unused-value + -Wfloat-equal -Wshadow -Winit-self -Wswitch-default + -Wmissing-include-dirs -pedantic) +set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}${WARNING_CXX_FLAGS}") +if (DEFINED EXTRA_CMAKE_CXX_FLAGS) + set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${EXTRA_CMAKE_CXX_FLAGS}") +endif() + +################################################# +# OS Specific initialization +if (UNIX) + ign_setup_unix() +else (WIN32) + ign_setup_windows() +endif() + +if(APPLE) + ign_setup_apple() +endif() + +################################################# +# Print warnings and errors +if ( build_warnings ) + message(STATUS "BUILD WARNINGS") + foreach (msg ${build_warnings}) + message(STATUS ${msg}) + endforeach () + message(STATUS "END BUILD WARNINGS\n") +endif (build_warnings) + +########### Add uninstall target ############### +configure_file( + "${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in" + "${CMAKE_CURRENT_BINARY_DIR}/cmake/cmake_uninstall.cmake" + IMMEDIATE @ONLY) +add_custom_target(uninstall + "${CMAKE_COMMAND}" -P + "${CMAKE_CURRENT_BINARY_DIR}/cmake/cmake_uninstall.cmake") + +if (build_errors) + message(STATUS "BUILD ERRORS: These must be resolved before compiling.") + foreach (msg ${build_errors}) + message(STATUS ${msg}) + endforeach () + message(STATUS "END BUILD ERRORS\n") + message (FATAL_ERROR "Errors encountered in build. " + "Please see the BUILD ERRORS above.") +else (build_errors) + + ######################################## + # Write the config.h file + configure_file (${project_cmake_dir}/config.hh.in + ${PROJECT_BINARY_DIR}/include/ignition/${IGN_PROJECT_NAME}/config.hh) + ign_install_includes( + ${IGN_PROJECT_NAME}${PROJECT_MAJOR_VERSION}/ignition/${IGN_PROJECT_NAME} + ${PROJECT_BINARY_DIR}/include/ignition/${IGN_PROJECT_NAME}/config.hh) + + include_directories( + ${PROJECT_SOURCE_DIR}/include + ${PROJECT_BINARY_DIR}/include + ) + link_directories(${PROJECT_BINARY_DIR}/src) + + if (DEFINED CMAKE_CXX_FLAGS) + message (STATUS "Custom CFlags:${CMAKE_CXX_FLAGS}") + else() + message (STATUS "Use default CFlags") + endif() + message (STATUS "Build Type: ${CMAKE_BUILD_TYPE}") + message (STATUS "Install path: ${CMAKE_INSTALL_PREFIX}") + + + if (BUILD_IGNITION) + set(TEST_TYPE "UNIT") + add_subdirectory(src) + add_subdirectory(include) + add_subdirectory(test) + endif (BUILD_IGNITION) + + ######################################## + # Make the package config files + set (pkgconfig_files ${PROJECT_NAME_LOWER}) + + foreach (pkgconfig ${pkgconfig_files}) + configure_file(${CMAKE_SOURCE_DIR}/cmake/pkgconfig/${pkgconfig}.in + ${CMAKE_CURRENT_BINARY_DIR}/cmake/pkgconfig/${pkgconfig}${PROJECT_MAJOR_VERSION}.pc @ONLY) + install(FILES ${CMAKE_CURRENT_BINARY_DIR}/cmake/pkgconfig/${pkgconfig}${PROJECT_MAJOR_VERSION}.pc + DESTINATION ${LIB_INSTALL_DIR}/pkgconfig COMPONENT pkgconfig) + endforeach() + + ######################################## + # Make the cmake config files + set(PKG_NAME ${PROJECT_NAME_UPPER}) + set(PKG_LIBRARIES ${PROJECT_NAME_LOWER}${PROJECT_MAJOR_VERSION}) + set(cmake_conf_file "${PROJECT_NAME_LOWER}${PROJECT_MAJOR_VERSION}-config.cmake") + set(cmake_conf_version_file "${PROJECT_NAME_LOWER}${PROJECT_MAJOR_VERSION}-config-version.cmake") + + set(PKG_DEPENDS) + + configure_file( + "${CMAKE_CURRENT_SOURCE_DIR}/cmake/${PROJECT_NAME_LOWER}-config.cmake.in" + "${CMAKE_CURRENT_BINARY_DIR}/${cmake_conf_file}" @ONLY) + + # Use write_basic_package_version_file to generate a ConfigVersion file that + # allow users of gazebo to specify the API or version to depend on + # TODO: keep this instruction until deprecate Ubuntu/Precise and update with + # https://github.com/Kitware/CMake/blob/v2.8.8/Modules/CMakePackageConfigHelpers.cmake + include(WriteBasicConfigVersionFile) + write_basic_config_version_file( + ${CMAKE_CURRENT_BINARY_DIR}/${cmake_conf_version_file} + VERSION "${PROJECT_VERSION_FULL}" + COMPATIBILITY SameMajorVersion) + + install(FILES + ${CMAKE_CURRENT_BINARY_DIR}/${cmake_conf_file} + ${CMAKE_CURRENT_BINARY_DIR}/${cmake_conf_version_file} + DESTINATION ${LIB_INSTALL_DIR}/cmake/${PROJECT_NAME_LOWER}${PROJECT_MAJOR_VERSION}/ COMPONENT cmake) + + ######################################## + # If present, load platform-specific build hooks. This system is used, + # for example, by the Ubuntu overlay, to + # arrange for installation of Ubuntu-specific application-launching + # configuration. + if (EXISTS ${PROJECT_SOURCE_DIR}/cmake/packager-hooks/CMakeLists.txt) + message(STATUS "Loading packager build hooks from cmake/packager-hooks") + add_subdirectory(cmake/packager-hooks) + endif() + + message(STATUS "Configuration successful. Type make to compile ${PROJECT_NAME_LOWER}") +endif(build_errors) diff --git a/ign-math/COPYING b/ign-math/COPYING new file mode 100644 index 0000000..4909afd --- /dev/null +++ b/ign-math/COPYING @@ -0,0 +1,178 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + diff --git a/ign-math/Changelog.md b/ign-math/Changelog.md new file mode 100644 index 0000000..f3f0834 --- /dev/null +++ b/ign-math/Changelog.md @@ -0,0 +1,103 @@ +## Ignition Math 2.x + +1. Fixed frustum falsely saying it contained AABB in some cases + * [Pull request 193](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/193) + +### Ignition Math 2.8 + +### Ignition Math 2.8.0 + +1. Added Color + * [Pull request 150](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/150) + +1. Added OrientedBox + * [Pull request 146](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/146) + +1. Added an assignment operator to the Frustum class. + * [Pull request 144](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/144) + +### Ignition Math 2.7 + +### Ignition Math 2.7.0 + +1. Add static const variables as alternative to macros in Helpers.hh + * [Pull request 137](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/137) + +1. Add new methods for floating numbers: lessOrEqual and greaterOrEqual + * [Pull request 134](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/134) + +### Ignition Math 2.6 + +### Ignition Math 2.6.0 + +1. Added copy constructor, equality operators and assignment operators to + SphericalCoordinates class. + * [Pull request 131](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/131) + +1. Fix Euler angle conversion of quaternions near singularities + * [Pull request 129](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/129) + +1. Backport triangle3, helper functions, equality helper to work with 387 fp unit + (Contribution from Rich Mattes). + * [Pull request 125](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/125) + * [Pull request 58](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/58) + * [Pull request 56](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/56) + +1. Added Matrix4::LookAt + * [Pull request 124](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/124) + +1. Set Inertial Rotations + * [Pull request 121](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/121) + +1. Added SemanticVersion class + * [Pull request 120](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/120) + +### Ignition Math 2.5 + +### Ignition Math 2.5.0 + +1. Added PID class + * [Pull request 117](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/117) + +1. Added SphericalCoordinate class + * [Pull request 108](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/108) + +### Ignition Math 2.4 + +#### Ignition Math 2.4.1 + +1. Combine inertial properties of different objects, returning the equivalent + inertial properties as if the objects were welded together. + * [Pull request 115](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/115) + +#### Ignition Math 2.4.0 + +1. New MassMatrix3 class + * [Pull request 112](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/112) +1. MassMatrix3 helper functions + * [Pull request 110](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/110) +1. Added Temperature class + * A contribution from Shintaro Noda + * [Pull request 113](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/113) + +### Ignition Math 2.3.0 + +1. Added simple volumes formulas + * [Pull request 84](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/84) +1. Add Length and SquaredLength for Vector2 with test + * [Pull request 73](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/73) +1. Add Equal function with numerical tolerance argument + * [Pull request 75](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/75) +1. First part of MassMatrix3 class, mostly accessors and modifiers + * [Pull request 77](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/77) +1. Add Transpose methods for Matrix3,4 with test + * [Pull request 74](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/74) +1. Multiplication improvements for Vector/Matrix classes + * [Pull request 69](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/69) +1. Scalar +,- operators for Vector[234] + * [Pull request 71](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/71) +1. Add Determinant method for Matrix[34] + * [Pull request 72](https://bitbucket.org/ignitionrobotics/ign-math/pull-requests/72) +1. Fixes for compiling and running tests on Windows 7/Visual Studio 2013 + Contribution from Silvio Traversaro. + * [Pull request 62](https://bitbucket.org/ignitionrobotics/ign-math/pull-request/62) diff --git a/ign-math/LICENSE b/ign-math/LICENSE new file mode 100644 index 0000000..bd33c43 --- /dev/null +++ b/ign-math/LICENSE @@ -0,0 +1,15 @@ +Software License Agreement (Apache License) + +Copyright 2012 Open Source Robotics Foundation + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/ign-math/NEWS b/ign-math/NEWS new file mode 100644 index 0000000..6b7be6e --- /dev/null +++ b/ign-math/NEWS @@ -0,0 +1 @@ +http://ignition_robotics.org diff --git a/ign-math/README.md b/ign-math/README.md new file mode 100644 index 0000000..3c28637 --- /dev/null +++ b/ign-math/README.md @@ -0,0 +1,45 @@ +# Ignition Math + + +**Math classes and functions for robot applications.** + +Ignition Math is a component in the Ignition framework, a set of libraries +designed to rapidly develop robot applications. The library defines math +classes and functions used in other Ignition libraries and programs. + + [http://ignitionrobotics.org](http://ignitionrobotics.org) + +## Continuous integration + +This project uses [appveyor](https://ci.appveyor.com/project/scpeters/ign-math/history) +for testing on Windows. +It has the following build status: +![appveyor badge](https://ci.appveyor.com/api/projects/status/bitbucket/ignitionrobotics/ign-math?svg=true) + +This project also uses [bitbucket pipelines](https://bitbucket.org/ignitionrobotics/ign-math/addon/pipelines/home#!/) +for testing with Linux. + +Test coverage reports are available at Codecov: + +[![codecov](https://codecov.io/bb/ignitionrobotics/ign-math/branch/ign-math2/graph/badge.svg)](https://codecov.io/bb/ignitionrobotics/ign-math) + +## Optional Dependencies + + sudo apt-get install doxygen + +## Installation + +Standard installation can be performed in UNIX systems using the following +steps: + + - mkdir build/ + - cd build/ + - cmake .. + - sudo make install + +## Uninstallation + +To uninstall the software installed with the previous steps: + + - cd build/ + - sudo make uninstall diff --git a/ign-math/appveyor.yml b/ign-math/appveyor.yml new file mode 100644 index 0000000..9057014 --- /dev/null +++ b/ign-math/appveyor.yml @@ -0,0 +1,22 @@ +os: + - Visual Studio 2013 + - Visual Studio 2015 + +configuration: + - Debug + - Release + +environment: + CTEST_OUTPUT_ON_FAILURE: 1 + +build_script: + - md build + - cd build + - cmake .. -DEXTRA_CMAKE_CXX_FLAGS="-WX" + - cmake --build . --config %CONFIGURATION% + +test_script: + - cmake --build . --config %CONFIGURATION% --target RUN_TESTS + +after_build: + - cmake --build . --config %CONFIGURATION% --target INSTALL diff --git a/ign-math/bitbucket-pipelines.yml b/ign-math/bitbucket-pipelines.yml new file mode 100644 index 0000000..68d56a0 --- /dev/null +++ b/ign-math/bitbucket-pipelines.yml @@ -0,0 +1,21 @@ +# This is a sample build configuration for C++. +# Check our guides at https://confluence.atlassian.com/x/VYk8Lw for more examples. +# Only use spaces to indent your .yml configuration. +# ----- +# You can specify a custom docker image from Docker Hub as your build environment. +image: ubuntu:xenial + +pipelines: + default: + - step: + script: # Modify the commands below to build your repository. + - apt-get update + - apt-get -y install cmake build-essential lcov curl mercurial + - mkdir build + - cd build + - cmake .. -DCMAKE_BUILD_TYPE=coverage + - make + - make test + - make coverage + - bash <(curl -s https://codecov.io/bash) + diff --git a/ign-math/cmake/CodeCoverage.cmake b/ign-math/cmake/CodeCoverage.cmake new file mode 100644 index 0000000..972fda7 --- /dev/null +++ b/ign-math/cmake/CodeCoverage.cmake @@ -0,0 +1,134 @@ +# +# 2012-01-31, Lars Bilke +# - Enable Code Coverage +# +# 2013-09-17, Joakim Söderberg +# - Added support for Clang. +# - Some additional usage instructions. +# +# USAGE: +# 1. Copy this file into your cmake modules path. +# +# 2. Add the following line to your CMakeLists.txt: +# INCLUDE(CodeCoverage) +# +# 3. Set compiler flags to turn off optimization and enable coverage: +# SET(CMAKE_CXX_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage") +# SET(CMAKE_C_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage") +# +# 3. Use the function SETUP_TARGET_FOR_COVERAGE to create a custom make target +# which runs your test executable and produces a lcov code coverage report: +# Example: +# SETUP_TARGET_FOR_COVERAGE( +# my_coverage_target # Name for custom target. +# test_driver # Name of the test driver executable that runs the tests. +# # NOTE! This should always have a ZERO as exit code +# # otherwise the coverage generation will not complete. +# coverage # Name of output directory. +# ) +# +# 4. Build a Debug build: +# cmake -DCMAKE_BUILD_TYPE=Debug .. +# make +# make my_coverage_target +# +# + +# Check prereqs +FIND_PROGRAM( GCOV_PATH gcov ) +FIND_PROGRAM( LCOV_PATH lcov ) +FIND_PROGRAM( GREP_PATH grep ) +FIND_PROGRAM( GENHTML_PATH genhtml ) +FIND_PROGRAM( GCOVR_PATH gcovr PATHS ${CMAKE_SOURCE_DIR}/tests) + +IF(NOT GCOV_PATH) + MESSAGE(FATAL_ERROR "gcov not found! Aborting...") +ENDIF() # NOT GCOV_PATH + +IF(NOT CMAKE_COMPILER_IS_GNUCXX) + # Clang version 3.0.0 and greater now supports gcov as well. + MESSAGE(WARNING "Compiler is not GNU gcc! Clang Version 3.0.0 and greater supports gcov as well, but older versions don't.") + + IF(NOT "${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang") + MESSAGE(FATAL_ERROR "Compiler is not GNU gcc! Aborting...") + ENDIF() +ENDIF() # NOT CMAKE_COMPILER_IS_GNUCXX + +SET(CMAKE_CXX_FLAGS_COVERAGE + "-g -O0 --coverage -fprofile-arcs -ftest-coverage" + CACHE STRING "Flags used by the C++ compiler during coverage builds." + FORCE ) +SET(CMAKE_C_FLAGS_COVERAGE + "-g -O0 --coverage -fprofile-arcs -ftest-coverage" + CACHE STRING "Flags used by the C compiler during coverage builds." + FORCE ) +SET(CMAKE_EXE_LINKER_FLAGS_COVERAGE + "" + CACHE STRING "Flags used for linking binaries during coverage builds." + FORCE ) +SET(CMAKE_SHARED_LINKER_FLAGS_COVERAGE + "" + CACHE STRING "Flags used by the shared libraries linker during coverage builds." + FORCE ) +MARK_AS_ADVANCED( + CMAKE_CXX_FLAGS_COVERAGE + CMAKE_C_FLAGS_COVERAGE + CMAKE_EXE_LINKER_FLAGS_COVERAGE + CMAKE_SHARED_LINKER_FLAGS_COVERAGE ) + +IF ( NOT (CMAKE_BUILD_TYPE STREQUAL "Debug" OR CMAKE_BUILD_TYPE STREQUAL "Coverage")) + MESSAGE( WARNING "Code coverage results with an optimized (non-Debug) build may be misleading" ) +ENDIF() # NOT CMAKE_BUILD_TYPE STREQUAL "Debug" + + +# Param _targetname The name of new the custom make target +# Param _testrunner The name of the target which runs the tests. +# MUST return ZERO always, even on errors. +# If not, no coverage report will be created! +# Param _outputname lcov output is generated as _outputname.info +# HTML report is generated in _outputname/index.html +# Optional fourth parameter is passed as arguments to _testrunner +# Pass them in list form, e.g.: "-j;2" for -j 2 +FUNCTION(SETUP_TARGET_FOR_COVERAGE _targetname _testrunner _outputname) + + IF(NOT LCOV_PATH) + MESSAGE(FATAL_ERROR "lcov not found! Aborting...") + ENDIF() # NOT LCOV_PATH + + IF(NOT GREP_PATH) + MESSAGE(FATAL_ERROR "grep not found! Run code coverage on linux or mac.") + ENDIF() + + IF(NOT GENHTML_PATH) + MESSAGE(FATAL_ERROR "genhtml not found! Aborting...") + ENDIF() # NOT GENHTML_PATH + + # Setup target + ADD_CUSTOM_TARGET(${_targetname} + + COMMAND ${CMAKE_COMMAND} -E remove ${_outputname}.info.cleaned + ${_outputname}.info + # Capturing lcov counters and generating report + COMMAND ${LCOV_PATH} -q --no-checksum --directory ${PROJECT_BINARY_DIR} + --capture --output-file ${_outputname}.info 2>/dev/null + COMMAND ${LCOV_PATH} -q --remove ${_outputname}.info + 'test/*' '/usr/*' '*_TEST*' --output-file ${_outputname}.info.cleaned + COMMAND ${GENHTML_PATH} -q --legend -o ${_outputname} + ${_outputname}.info.cleaned + COMMAND ${LCOV_PATH} --summary ${_outputname}.info.cleaned 2>&1 | grep "lines" | cut -d ' ' -f 4 | cut -d '%' -f 1 > coverage/lines.txt + COMMAND ${LCOV_PATH} --summary ${_outputname}.info.cleaned 2>&1 | grep "functions" | cut -d ' ' -f 4 | cut -d '%' -f 1 > coverage/functions.txt + COMMAND ${CMAKE_COMMAND} -E rename ${_outputname}.info.cleaned + ${_outputname}.info + + WORKING_DIRECTORY ${CMAKE_BINARY_DIR} + COMMENT "Resetting code coverage counters to zero.\n" + "Processing code coverage counters and generating report." + ) + + # Show info where to find the report + ADD_CUSTOM_COMMAND(TARGET ${_targetname} POST_BUILD + COMMAND COMMAND ${LCOV_PATH} -q --zerocounters --directory ${PROJECT_BINARY_DIR}; + COMMENT "Open ./${_outputname}/index.html in your browser to view the coverage report." + ) + +ENDFUNCTION() # SETUP_TARGET_FOR_COVERAGE diff --git a/ign-math/cmake/DefaultCFlags.cmake b/ign-math/cmake/DefaultCFlags.cmake new file mode 100644 index 0000000..247a56a --- /dev/null +++ b/ign-math/cmake/DefaultCFlags.cmake @@ -0,0 +1,42 @@ +# Build type link flags +set (CMAKE_LINK_FLAGS_RELEASE " " CACHE INTERNAL "Link flags for release" FORCE) +set (CMAKE_LINK_FLAGS_RELWITHDEBINFO " " CACHE INTERNAL "Link flags for release with debug support" FORCE) +set (CMAKE_LINK_FLAGS_DEBUG " " CACHE INTERNAL "Link flags for debug" FORCE) +set (CMAKE_LINK_FLAGS_PROFILE " -pg" CACHE INTERNAL "Link flags for profile" FORCE) +set (CMAKE_LINK_FLAGS_COVERAGE " --coverage" CACHE INTERNAL "Link flags for static code checking" FORCE) + +set (CMAKE_C_FLAGS_RELEASE "") +if (NOT APPLE) + # -s doesn't work with default osx compiler clang, alternative: + # http://stackoverflow.com/questions/6085491/gcc-vs-clang-symbol-strippingu + set (CMAKE_C_FLAGS_RELEASE "-s") +endif() +set (CMAKE_C_FLAGS_RELEASE " ${CMAKE_C_FLAGS_RELEASE} -O3 -DNDEBUG ${CMAKE_C_FLAGS_ALL}" CACHE INTERNAL "C Flags for release" FORCE) +set (CMAKE_CXX_FLAGS_RELEASE ${CMAKE_C_FLAGS_RELEASE}) + +set (CMAKE_C_FLAGS_RELWITHDEBINFO " -g -O2 ${CMAKE_C_FLAGS_ALL}" CACHE INTERNAL "C Flags for release with debug support" FORCE) +set (CMAKE_CXX_FLAGS_RELWITHDEBINFO ${CMAKE_C_FLAGS_RELWITHDEBINFO}) + +set (CMAKE_C_FLAGS_DEBUG " -ggdb3 ${CMAKE_C_FLAGS_ALL}" CACHE INTERNAL "C Flags for debug" FORCE) +set (CMAKE_CXX_FLAGS_DEBUG ${CMAKE_C_FLAGS_DEBUG}) + +set (CMAKE_C_FLAGS_PROFILE " -fno-omit-frame-pointer -g -pg ${CMAKE_C_FLAGS_ALL}" CACHE INTERNAL "C Flags for profile" FORCE) +set (CMAKE_CXX_FLAGS_PROFILE ${CMAKE_C_FLAGS_PROFILE}) + +set (CMAKE_C_FLAGS_COVERAGE " -g -O0 -Wformat=2 --coverage -fno-inline ${CMAKE_C_FLAGS_ALL}" CACHE INTERNAL "C Flags for static code checking" FORCE) +set (CMAKE_CXX_FLAGS_COVERAGE "${CMAKE_C_FLAGS_COVERAGE} -fno-elide-constructors -fno-default-inline -fno-implicit-inline-templates") + +##################################### +# Set all the global build flags +if (UNIX) + set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS_${CMAKE_BUILD_TYPE_UPPERCASE}}") + set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS_${CMAKE_BUILD_TYPE_UPPERCASE}} -std=c++11") + set (CMAKE_EXE_LINKER_FLAGS "${CMAKE_LINK_FLAGS_${CMAKE_BUILD_TYPE_UPPERCASE}}") + set (CMAKE_SHARED_LINKER_FLAGS "${CMAKE_LINK_FLAGS_${CMAKE_BUILD_TYPE_UPPERCASE}}") + set (CMAKE_MODULE_LINKER_FLAGS "${CMAKE_LINK_FLAGS_${CMAKE_BUILD_TYPE_UPPERCASE}}") + # Add visibility in UNIX + check_gcc_visibility() + if (GCC_SUPPORTS_VISIBILITY) + SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fvisibility=hidden") + endif() +endif() diff --git a/ign-math/cmake/DissectVersion.cmake b/ign-math/cmake/DissectVersion.cmake new file mode 100644 index 0000000..64b18ed --- /dev/null +++ b/ign-math/cmake/DissectVersion.cmake @@ -0,0 +1,5 @@ +# Find version components +STRING (REGEX REPLACE "^([0-9]+).*" "\\1" PROJECT_MAJOR_VERSION "${PROJECT_VERSION_FULL}") +STRING (REGEX REPLACE "^[0-9]+\\.([0-9]+).*" "\\1" PROJECT_MINOR_VERSION "${PROJECT_VERSION_FULL}") +STRING (REGEX REPLACE "^[0-9]+\\.[0-9]+\\.([0-9]+)" "\\1" PROJECT_REVISION_VERSION ${PROJECT_VERSION_FULL}) +STRING (REGEX REPLACE "^[0-9]+\\.[0-9]+\\.[0-9]+(.*)" "\\1" PROJECT_CANDIDATE_VERSION ${PROJECT_VERSION_FULL}) diff --git a/ign-math/cmake/FindOS.cmake b/ign-math/cmake/FindOS.cmake new file mode 100644 index 0000000..7a12f95 --- /dev/null +++ b/ign-math/cmake/FindOS.cmake @@ -0,0 +1,55 @@ +# Check the OS type. + +# CMake does not distinguish Linux from other Unices. +STRING (REGEX MATCH "Linux" PLAYER_OS_LINUX ${CMAKE_SYSTEM_NAME}) +# Nor *BSD +STRING (REGEX MATCH "BSD" PLAYER_OS_BSD ${CMAKE_SYSTEM_NAME}) +# Or Solaris. I'm seeing a trend, here +STRING (REGEX MATCH "SunOS" PLAYER_OS_SOLARIS ${CMAKE_SYSTEM_NAME}) + +# Windows is easy (for once) +IF (WIN32) + SET (PLAYER_OS_WIN TRUE BOOL INTERNAL) +ENDIF (WIN32) + +# Check if it's an Apple OS +IF (APPLE) + # Check if it's OS X or another MacOS (that's got to be pretty unlikely) + STRING (REGEX MATCH "Darwin" PLAYER_OS_OSX ${CMAKE_SYSTEM_NAME}) + IF (NOT PLAYER_OS_OSX) + SET (PLAYER_OS_MACOS TRUE BOOL INTERNAL) + ENDIF (NOT PLAYER_OS_OSX) +ENDIF (APPLE) + +# QNX +IF (QNXNTO) + SET (PLAYER_OS_QNX TRUE BOOL INTERNAL) +ENDIF (QNXNTO) + +IF (PLAYER_OS_LINUX) + MESSAGE (STATUS "Operating system is Linux") +ELSEIF (PLAYER_OS_BSD) + MESSAGE (STATUS "Operating system is BSD") +ELSEIF (PLAYER_OS_WIN) + MESSAGE (STATUS "Operating system is Windows") +ELSEIF (PLAYER_OS_OSX) + MESSAGE (STATUS "Operating system is Apple MacOS X") +ELSEIF (PLAYER_OS_MACOS) + MESSAGE (STATUS "Operating system is Apple MacOS (not OS X)") +ELSEIF (PLAYER_OS_QNX) + MESSAGE (STATUS "Operating system is QNX") +ELSEIF (PLAYER_OS_SOLARIS) + MESSAGE (STATUS "Operating system is Solaris") +ELSE (PLAYER_OS_LINUX) + MESSAGE (STATUS "Operating system is generic Unix") +ENDIF (PLAYER_OS_LINUX) + +################################################# +# Check for non-case-sensitive filesystems +execute_process(COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/tools/case_sensitive_filesystem + RESULT_VARIABLE FILESYSTEM_CASE_SENSITIVE_RETURN) +if (${FILESYSTEM_CASE_SENSITIVE_RETURN} EQUAL 0) + set(FILESYSTEM_CASE_SENSITIVE TRUE) +else() + set(FILESYSTEM_CASE_SENSITIVE FALSE) +endif() diff --git a/ign-math/cmake/FindSSE.cmake b/ign-math/cmake/FindSSE.cmake new file mode 100644 index 0000000..96622f5 --- /dev/null +++ b/ign-math/cmake/FindSSE.cmake @@ -0,0 +1,113 @@ +# Check if SSE instructions are available on the machine where +# the project is compiled. + +IF (ARCH MATCHES "i386" OR ARCH MATCHES "x86_64") + IF(CMAKE_SYSTEM_NAME MATCHES "Linux") + EXEC_PROGRAM(cat ARGS "/proc/cpuinfo" OUTPUT_VARIABLE CPUINFO) + + STRING(REGEX REPLACE "^.*(sse2).*$" "\\1" SSE_THERE ${CPUINFO}) + STRING(COMPARE EQUAL "sse2" "${SSE_THERE}" SSE2_TRUE) + IF (SSE2_TRUE) + set(SSE2_FOUND true CACHE BOOL "SSE2 available on host") + ELSE (SSE2_TRUE) + set(SSE2_FOUND false CACHE BOOL "SSE2 available on host") + ENDIF (SSE2_TRUE) + + # /proc/cpuinfo apparently omits sse3 :( + STRING(REGEX REPLACE "^.*[^s](sse3).*$" "\\1" SSE_THERE ${CPUINFO}) + STRING(COMPARE EQUAL "sse3" "${SSE_THERE}" SSE3_TRUE) + IF (NOT SSE3_TRUE) + STRING(REGEX REPLACE "^.*(T2300).*$" "\\1" SSE_THERE ${CPUINFO}) + STRING(COMPARE EQUAL "T2300" "${SSE_THERE}" SSE3_TRUE) + ENDIF (NOT SSE3_TRUE) + + STRING(REGEX REPLACE "^.*(ssse3).*$" "\\1" SSE_THERE ${CPUINFO}) + STRING(COMPARE EQUAL "ssse3" "${SSE_THERE}" SSSE3_TRUE) + IF (SSE3_TRUE OR SSSE3_TRUE) + set(SSE3_FOUND true CACHE BOOL "SSE3 available on host") + ELSE (SSE3_TRUE OR SSSE3_TRUE) + set(SSE3_FOUND false CACHE BOOL "SSE3 available on host") + ENDIF (SSE3_TRUE OR SSSE3_TRUE) + IF (SSSE3_TRUE) + set(SSSE3_FOUND true CACHE BOOL "SSSE3 available on host") + ELSE (SSSE3_TRUE) + set(SSSE3_FOUND false CACHE BOOL "SSSE3 available on host") + ENDIF (SSSE3_TRUE) + + STRING(REGEX REPLACE "^.*(sse4_1).*$" "\\1" SSE_THERE ${CPUINFO}) + STRING(COMPARE EQUAL "sse4_1" "${SSE_THERE}" SSE41_TRUE) + IF (SSE41_TRUE) + set(SSE4_1_FOUND true CACHE BOOL "SSE4.1 available on host") + ELSE (SSE41_TRUE) + set(SSE4_1_FOUND false CACHE BOOL "SSE4.1 available on host") + ENDIF (SSE41_TRUE) + + STRING(REGEX REPLACE "^.*(sse4_2).*$" "\\1" SSE_THERE ${CPUINFO}) + STRING(COMPARE EQUAL "sse4_2" "${SSE_THERE}" SSE42_TRUE) + IF (SSE42_TRUE) + set(SSE4_2_FOUND true CACHE BOOL "SSE4.2 available on host") + ELSE (SSE42_TRUE) + set(SSE4_2_FOUND false CACHE BOOL "SSE4.2 available on host") + ENDIF (SSE42_TRUE) + + ELSEIF(CMAKE_SYSTEM_NAME MATCHES "Darwin") + EXEC_PROGRAM("/usr/sbin/sysctl -n machdep.cpu.features" OUTPUT_VARIABLE + CPUINFO) + + STRING(REGEX REPLACE "^.*[^S](SSE2).*$" "\\1" SSE_THERE ${CPUINFO}) + STRING(COMPARE EQUAL "SSE2" "${SSE_THERE}" SSE2_TRUE) + IF (SSE2_TRUE) + set(SSE2_FOUND true CACHE BOOL "SSE2 available on host") + ELSE (SSE2_TRUE) + set(SSE2_FOUND false CACHE BOOL "SSE2 available on host") + ENDIF (SSE2_TRUE) + + STRING(REGEX REPLACE "^.*[^S](SSE3).*$" "\\1" SSE_THERE ${CPUINFO}) + STRING(COMPARE EQUAL "SSE3" "${SSE_THERE}" SSE3_TRUE) + IF (SSE3_TRUE) + set(SSE3_FOUND true CACHE BOOL "SSE3 available on host") + ELSE (SSE3_TRUE) + set(SSE3_FOUND false CACHE BOOL "SSE3 available on host") + ENDIF (SSE3_TRUE) + + STRING(REGEX REPLACE "^.*(SSSE3).*$" "\\1" SSE_THERE ${CPUINFO}) + STRING(COMPARE EQUAL "SSSE3" "${SSE_THERE}" SSSE3_TRUE) + IF (SSSE3_TRUE) + set(SSSE3_FOUND true CACHE BOOL "SSSE3 available on host") + ELSE (SSSE3_TRUE) + set(SSSE3_FOUND false CACHE BOOL "SSSE3 available on host") + ENDIF (SSSE3_TRUE) + + STRING(REGEX REPLACE "^.*(SSE4.1).*$" "\\1" SSE_THERE ${CPUINFO}) + STRING(COMPARE EQUAL "SSE4.1" "${SSE_THERE}" SSE41_TRUE) + IF (SSE41_TRUE) + set(SSE4_1_FOUND true CACHE BOOL "SSE4.1 available on host") + ELSE (SSE41_TRUE) + set(SSE4_1_FOUND false CACHE BOOL "SSE4.1 available on host") + ENDIF (SSE41_TRUE) + ELSEIF(CMAKE_SYSTEM_NAME MATCHES "Windows") + # TODO + set(SSE2_FOUND true CACHE BOOL "SSE2 available on host") + set(SSE3_FOUND false CACHE BOOL "SSE3 available on host") + set(SSSE3_FOUND false CACHE BOOL "SSSE3 available on host") + set(SSE4_1_FOUND false CACHE BOOL "SSE4.1 available on host") + ELSE(CMAKE_SYSTEM_NAME MATCHES "Linux") + set(SSE2_FOUND true CACHE BOOL "SSE2 available on host") + set(SSE3_FOUND false CACHE BOOL "SSE3 available on host") + set(SSSE3_FOUND false CACHE BOOL "SSSE3 available on host") + set(SSE4_1_FOUND false CACHE BOOL "SSE4.1 available on host") + ENDIF(CMAKE_SYSTEM_NAME MATCHES "Linux") +ENDIF(ARCH MATCHES "i386" OR ARCH MATCHES "x86_64") + +if(NOT SSE2_FOUND) + MESSAGE(STATUS "Could not find hardware support for SSE2 on this machine.") +endif(NOT SSE2_FOUND) +if(NOT SSE3_FOUND) + MESSAGE(STATUS "Could not find hardware support for SSE3 on this machine.") +endif(NOT SSE3_FOUND) +if(NOT SSSE3_FOUND) + MESSAGE(STATUS "Could not find hardware support for SSSE3 on this machine.") +endif(NOT SSSE3_FOUND) +if(NOT SSE4_1_FOUND) + MESSAGE(STATUS "Could not find hardware support for SSE4.1 on this machine.") +endif(NOT SSE4_1_FOUND) diff --git a/ign-math/cmake/HostCFlags.cmake b/ign-math/cmake/HostCFlags.cmake new file mode 100644 index 0000000..f38d8d7 --- /dev/null +++ b/ign-math/cmake/HostCFlags.cmake @@ -0,0 +1,27 @@ +include (${project_cmake_dir}/FindSSE.cmake) + +if (SSE2_FOUND) + set (CMAKE_C_FLAGS_ALL "-msse -msse2 ${CMAKE_C_FLAGS_ALL}") + if (NOT APPLE) + set (CMAKE_C_FLAGS_ALL "-mfpmath=sse ${CMAKE_C_FLAGS_ALL}") + endif() +endif() + +if (SSE3_FOUND) + set (CMAKE_C_FLAGS_ALL "-msse3 ${CMAKE_C_FLAGS_ALL}") +endif() +if (SSSE3_FOUND) + set (CMAKE_C_FLAGS_ALL "-mssse3 ${CMAKE_C_FLAGS_ALL}") +endif() + +if (SSE4_1_FOUND OR SSE4_2_FOUND) + if (SSE4_1_FOUND) + set (CMAKE_C_FLAGS_ALL "-msse4.1 ${CMAKE_C_FLAGS_ALL}") + endif() + if (SSE4_2_FOUND) + set (CMAKE_C_FLAGS_ALL "-msse4.2 ${CMAKE_C_FLAGS_ALL}") + endif() +else() + message(STATUS "\nSSE4 disabled.\n") +endif() + diff --git a/ign-math/cmake/Ronn2Man.cmake b/ign-math/cmake/Ronn2Man.cmake new file mode 100644 index 0000000..b9a8505 --- /dev/null +++ b/ign-math/cmake/Ronn2Man.cmake @@ -0,0 +1,59 @@ +# +# Based on work of Emmanuel Roullit +# Copyright 2009, 2012 Emmanuel Roullit. +# Subject to the GPL, version 2. +# +MACRO(ADD_MANPAGE_TARGET) + # It is not possible add a dependency to target 'install' + # Run hard-coded 'make man' when 'make install' is invoked + INSTALL(CODE "EXECUTE_PROCESS(COMMAND make man)") + ADD_CUSTOM_TARGET(man) +ENDMACRO(ADD_MANPAGE_TARGET) + +FIND_PROGRAM(RONN ronn) +FIND_PROGRAM(GZIP gzip) + +IF (NOT RONN OR NOT GZIP) + IF (NOT RONN) + BUILD_WARNING ("ronn not found, manpages won't be generated") + ENDIF(NOT RONN) + IF (NOT GZIP) + BUILD_WARNING ("gzip not found, manpages won't be generated") + ENDIF(NOT GZIP) + # empty macro + MACRO(manpage MANFILE) + ENDMACRO(manpage) + SET (MANPAGES_SUPPORT FALSE) +ELSE (NOT RONN OR NOT GZIP) + MESSAGE (STATUS "Looking for ronn to generate manpages - found") + SET (MANPAGES_SUPPORT TRUE) + + MACRO(manpage RONNFILE SECTION) + SET(RONNFILE_FULL_PATH ${CMAKE_CURRENT_SOURCE_DIR}/${RONNFILE}) + + ADD_CUSTOM_COMMAND( + OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${RONNFILE}.${SECTION} + DEPENDS ${RONNFILE} + COMMAND ${RONN} + ARGS -r --pipe ${RONNFILE_FULL_PATH}.${SECTION}.ronn + > ${CMAKE_CURRENT_BINARY_DIR}/${RONNFILE}.${SECTION} + ) + + ADD_CUSTOM_COMMAND( + OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${RONNFILE}.${SECTION}.gz + DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${RONNFILE}.${SECTION} + COMMAND ${GZIP} -c ${CMAKE_CURRENT_BINARY_DIR}/${RONNFILE}.${SECTION} + > ${CMAKE_CURRENT_BINARY_DIR}/${RONNFILE}.${SECTION}.gz + ) + + SET(MANPAGE_TARGET "man-${RONNFILE}") + + ADD_CUSTOM_TARGET(${MANPAGE_TARGET} DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${RONNFILE}.${SECTION}.gz) + ADD_DEPENDENCIES(man ${MANPAGE_TARGET}) + + INSTALL( + FILES ${CMAKE_CURRENT_BINARY_DIR}/${RONNFILE}.${SECTION}.gz + DESTINATION share/man/man${SECTION} + ) + ENDMACRO(manpage RONNFILE SECTION) +ENDIF(NOT RONN OR NOT GZIP) diff --git a/ign-math/cmake/SearchForStuff.cmake b/ign-math/cmake/SearchForStuff.cmake new file mode 100644 index 0000000..47ceda7 --- /dev/null +++ b/ign-math/cmake/SearchForStuff.cmake @@ -0,0 +1,23 @@ +include (${project_cmake_dir}/Utils.cmake) +include (CheckCXXSourceCompiles) + +include (${project_cmake_dir}/FindOS.cmake) +include (FindPkgConfig) + +# Detect the architecture +include (${project_cmake_dir}/TargetArch.cmake) +target_architecture(ARCH) +message(STATUS "Building for arch: ${ARCH}") + +######################################## +# Include man pages stuff +include (${project_cmake_dir}/Ronn2Man.cmake) +add_manpage_target() + +################################################# +# Macro to check for visibility capability in compiler +# Original idea from: https://gitorious.org/ferric-cmake-stuff/ +macro (check_gcc_visibility) + include (CheckCXXCompilerFlag) + check_cxx_compiler_flag(-fvisibility=hidden GCC_SUPPORTS_VISIBILITY) +endmacro() diff --git a/ign-math/cmake/TargetArch.cmake b/ign-math/cmake/TargetArch.cmake new file mode 100644 index 0000000..323824b --- /dev/null +++ b/ign-math/cmake/TargetArch.cmake @@ -0,0 +1,158 @@ +# Copyright (c) 2012 Petroules Corporation. All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# Redistributions of source code must retain the above copyright notice, this +# list of conditions and the following disclaimer. Redistributions in binary +# form must reproduce the above copyright notice, this list of conditions and +# the following disclaimer in the documentation and/or other materials +# provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR +# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +# Based on the Qt 5 processor detection code, so should be very accurate +# https://qt.gitorious.org/qt/qtbase/blobs/master/src/corelib/global/qprocessordetection.h +# Currently handles arm (v5, v6, v7), x86 (32/64), ia64, and ppc (32/64) + +# Regarding POWER/PowerPC, just as is noted in the Qt source, +# "There are many more known variants/revisions that we do not handle/detect." + + + +set(archdetect_c_code " +#if defined(__arm__) || defined(__TARGET_ARCH_ARM) + #if defined(__ARM_ARCH_7__) \\ + || defined(__ARM_ARCH_7A__) \\ + || defined(__ARM_ARCH_7R__) \\ + || defined(__ARM_ARCH_7M__) \\ + || (defined(__TARGET_ARCH_ARM) && __TARGET_ARCH_ARM-0 >= 7) + #error cmake_ARCH armv7 + #elif defined(__ARM_ARCH_6__) \\ + || defined(__ARM_ARCH_6J__) \\ + || defined(__ARM_ARCH_6T2__) \\ + || defined(__ARM_ARCH_6Z__) \\ + || defined(__ARM_ARCH_6K__) \\ + || defined(__ARM_ARCH_6ZK__) \\ + || defined(__ARM_ARCH_6M__) \\ + || (defined(__TARGET_ARCH_ARM) && __TARGET_ARCH_ARM-0 >= 6) + #error cmake_ARCH armv6 + #elif defined(__ARM_ARCH_5TEJ__) \\ + || (defined(__TARGET_ARCH_ARM) && __TARGET_ARCH_ARM-0 >= 5) + #error cmake_ARCH armv5 + #else + #error cmake_ARCH arm + #endif +#elif defined(__i386) || defined(__i386__) || defined(_M_IX86) + #error cmake_ARCH i386 +#elif defined(__x86_64) || defined(__x86_64__) || defined(__amd64) || defined(_M_X64) + #error cmake_ARCH x86_64 +#elif defined(__ia64) || defined(__ia64__) || defined(_M_IA64) + #error cmake_ARCH ia64 +#elif defined(__ppc__) || defined(__ppc) || defined(__powerpc__) \\ + || defined(_ARCH_COM) || defined(_ARCH_PWR) || defined(_ARCH_PPC) \\ + || defined(_M_MPPC) || defined(_M_PPC) + #if defined(__ppc64__) || defined(__powerpc64__) || defined(__64BIT__) + #error cmake_ARCH ppc64 + #else + #error cmake_ARCH ppc + #endif +#endif + +#error cmake_ARCH unknown +") + +# Set ppc_support to TRUE before including this file or ppc and ppc64 +# will be treated as invalid architectures since they are no longer supported by Apple + +function(target_architecture output_var) + if(APPLE AND CMAKE_OSX_ARCHITECTURES) + # On OS X we use CMAKE_OSX_ARCHITECTURES *if* it was set + # First let's normalize the order of the values + + # Note that it's not possible to compile PowerPC applications if you are using + # the OS X SDK version 10.6 or later - you'll need 10.4/10.5 for that, so we + # disable it by default + # See this page for more information: + # http://stackoverflow.com/questions/5333490/how-can-we-restore-ppc-ppc64-as-well-as-full-10-4-10-5-sdk-support-to-xcode-4 + + # Architecture defaults to i386 or ppc on OS X 10.5 and earlier, depending on the CPU type detected at runtime. + # On OS X 10.6+ the default is x86_64 if the CPU supports it, i386 otherwise. + + foreach(osx_arch ${CMAKE_OSX_ARCHITECTURES}) + if("${osx_arch}" STREQUAL "ppc" AND ppc_support) + set(osx_arch_ppc TRUE) + elseif("${osx_arch}" STREQUAL "i386") + set(osx_arch_i386 TRUE) + elseif("${osx_arch}" STREQUAL "x86_64") + set(osx_arch_x86_64 TRUE) + elseif("${osx_arch}" STREQUAL "ppc64" AND ppc_support) + set(osx_arch_ppc64 TRUE) + else() + message(FATAL_ERROR "Invalid OS X arch name: ${osx_arch}") + endif() + endforeach() + + # Now add all the architectures in our normalized order + if(osx_arch_ppc) + list(APPEND ARCH ppc) + endif() + + if(osx_arch_i386) + list(APPEND ARCH i386) + endif() + + if(osx_arch_x86_64) + list(APPEND ARCH x86_64) + endif() + + if(osx_arch_ppc64) + list(APPEND ARCH ppc64) + endif() + else() + file(WRITE "${CMAKE_BINARY_DIR}/arch.c" "${archdetect_c_code}") + + enable_language(C) + + # Detect the architecture in a rather creative way... + # This compiles a small C program which is a series of ifdefs that selects a + # particular #error preprocessor directive whose message string contains the + # target architecture. The program will always fail to compile (both because + # file is not a valid C program, and obviously because of the presence of the + # #error preprocessor directives... but by exploiting the preprocessor in this + # way, we can detect the correct target architecture even when cross-compiling, + # since the program itself never needs to be run (only the compiler/preprocessor) + try_run( + run_result_unused + compile_result_unused + "${CMAKE_BINARY_DIR}" + "${CMAKE_BINARY_DIR}/arch.c" + COMPILE_OUTPUT_VARIABLE ARCH + CMAKE_FLAGS CMAKE_OSX_ARCHITECTURES=${CMAKE_OSX_ARCHITECTURES} + ) + + # Parse the architecture name from the compiler output + string(REGEX MATCH "cmake_ARCH ([a-zA-Z0-9_]+)" ARCH "${ARCH}") + + # Get rid of the value marker leaving just the architecture name + string(REPLACE "cmake_ARCH " "" ARCH "${ARCH}") + + # If we are compiling with an unknown architecture this variable should + # already be set to "unknown" but in the case that it's empty (i.e. due + # to a typo in the code), then set it to unknown + if (NOT ARCH) + set(ARCH unknown) + endif() + endif() + + set(${output_var} "${ARCH}" PARENT_SCOPE) +endfunction() diff --git a/ign-math/cmake/TestUtils.cmake b/ign-math/cmake/TestUtils.cmake new file mode 100644 index 0000000..0fbb0b9 --- /dev/null +++ b/ign-math/cmake/TestUtils.cmake @@ -0,0 +1,48 @@ +################################################# +macro (ign_build_tests) + # Find the Python interpreter for running the + # check_test_ran.py script + find_package(PythonInterp QUIET) + + # Build all the tests + foreach(GTEST_SOURCE_file ${ARGN}) + string(REGEX REPLACE ".cc" "" BINARY_NAME ${GTEST_SOURCE_file}) + set(BINARY_NAME ${TEST_TYPE}_${BINARY_NAME}) + if(USE_LOW_MEMORY_TESTS) + add_definitions(-DUSE_LOW_MEMORY_TESTS=1) + endif(USE_LOW_MEMORY_TESTS) + add_executable(${BINARY_NAME} ${GTEST_SOURCE_file}) + + add_dependencies(${BINARY_NAME} + ignition-math${PROJECT_MAJOR_VERSION} + gtest gtest_main + ) + + if (UNIX) + target_link_libraries(${BINARY_NAME} + libgtest_main.a + libgtest.a + pthread + ignition-math${PROJECT_MAJOR_VERSION}) + elseif(WIN32) + target_link_libraries(${BINARY_NAME} + gtest.lib + gtest_main.lib + ignition-math${PROJECT_MAJOR_VERSION}.lib) + else() + message(FATAL_ERROR "Unsupported platform") + endif() + + add_test(${BINARY_NAME} ${CMAKE_CURRENT_BINARY_DIR}/${BINARY_NAME} + --gtest_output=xml:${CMAKE_BINARY_DIR}/test_results/${BINARY_NAME}.xml) + + set_tests_properties(${BINARY_NAME} PROPERTIES TIMEOUT 240) + + if(PYTHONINTERP_FOUND) + # Check that the test produced a result and create a failure if it didn't. + # Guards against crashed and timed out tests. + add_test(check_${BINARY_NAME} ${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/tools/check_test_ran.py + ${CMAKE_BINARY_DIR}/test_results/${BINARY_NAME}.xml) + endif() + endforeach() +endmacro() diff --git a/ign-math/cmake/Utils.cmake b/ign-math/cmake/Utils.cmake new file mode 100644 index 0000000..4bca480 --- /dev/null +++ b/ign-math/cmake/Utils.cmake @@ -0,0 +1,179 @@ +################################################################################ +#APPEND_TO_CACHED_STRING(_string _cacheDesc [items...]) +# Appends items to a cached list. +MACRO (APPEND_TO_CACHED_STRING _string _cacheDesc) + FOREACH (newItem ${ARGN}) + SET (${_string} "${${_string}} ${newItem}" CACHE INTERNAL ${_cacheDesc} FORCE) + ENDFOREACH (newItem ${ARGN}) + #STRING(STRIP ${${_string}} ${_string}) +ENDMACRO (APPEND_TO_CACHED_STRING) + +################################################################################ +# APPEND_TO_CACHED_LIST (_list _cacheDesc [items...] +# Appends items to a cached list. +MACRO (APPEND_TO_CACHED_LIST _list _cacheDesc) + SET (tempList ${${_list}}) + FOREACH (newItem ${ARGN}) + LIST (APPEND tempList ${newItem}) + ENDFOREACH (newItem ${newItem}) + SET (${_list} ${tempList} CACHE INTERNAL ${_cacheDesc} FORCE) +ENDMACRO(APPEND_TO_CACHED_LIST) + +################################################# +# Macro to turn a list into a string (why doesn't CMake have this built-in?) +MACRO (LIST_TO_STRING _string _list) + SET (${_string}) + FOREACH (_item ${_list}) + SET (${_string} "${${_string}} ${_item}") + ENDFOREACH (_item) + #STRING(STRIP ${${_string}} ${_string}) +ENDMACRO (LIST_TO_STRING) + +################################################# +# BUILD ERROR macro +macro (BUILD_ERROR) + foreach (str ${ARGN}) + SET (msg "\t${str}") + MESSAGE (STATUS ${msg}) + APPEND_TO_CACHED_LIST(build_errors "build errors" ${msg}) + endforeach () +endmacro (BUILD_ERROR) + +################################################# +# BUILD WARNING macro +macro (BUILD_WARNING) + foreach (str ${ARGN}) + SET (msg "\t${str}" ) + MESSAGE (STATUS ${msg} ) + APPEND_TO_CACHED_LIST(build_warnings "build warning" ${msg}) + endforeach (str ${ARGN}) +endmacro (BUILD_WARNING) + +################################################# +macro (ign_add_library _name) + set(LIBS_DESTINATION ${PROJECT_BINARY_DIR}/src) + set_source_files_properties(${ARGN} PROPERTIES COMPILE_DEFINITIONS "BUILDING_DLL") + add_library(${_name} SHARED ${ARGN}) + target_link_libraries (${_name} ${general_libraries}) + set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${LIBS_DESTINATION}) + if (MSVC) + set_target_properties( ${_name} PROPERTIES ARCHIVE_OUTPUT_DIRECTORY ${LIBS_DESTINATION}) + set_target_properties( ${_name} PROPERTIES ARCHIVE_OUTPUT_DIRECTORY_DEBUG ${LIBS_DESTINATION}) + set_target_properties( ${_name} PROPERTIES ARCHIVE_OUTPUT_DIRECTORY_RELEASE ${LIBS_DESTINATION}) + endif ( MSVC ) +endmacro () + +################################################# +macro (ign_add_static_library _name) + add_library(${_name} STATIC ${ARGN}) + target_link_libraries (${_name} ${general_libraries}) +endmacro () + +################################################# +macro (ign_add_executable _name) + add_executable(${_name} ${ARGN}) + target_link_libraries (${_name} ${general_libraries}) +endmacro () + + +################################################# +macro (ign_install_includes _subdir) + install(FILES ${ARGN} + DESTINATION ${INCLUDE_INSTALL_DIR}/${_subdir} COMPONENT headers) +endmacro() + +################################################# +macro (ign_install_library _name) + set_target_properties(${_name} PROPERTIES SOVERSION ${PROJECT_MAJOR_VERSION} VERSION ${PROJECT_VERSION_FULL}) + install (TARGETS ${_name} DESTINATION ${LIB_INSTALL_DIR} COMPONENT shlib) +endmacro () + +################################################# +macro (ign_install_executable _name) + set_target_properties(${_name} PROPERTIES VERSION ${PROJECT_VERSION_FULL}) + install (TARGETS ${_name} DESTINATION ${BIN_INSTALL_DIR}) + manpage(${_name} 1) +endmacro () + +################################################# +macro (ign_setup_unix) + # USE_HOST_CFLAGS (default TRUE) + # Will check building host machine for proper cflags + if(NOT DEFINED USE_HOST_CFLAGS OR USE_HOST_CFLAGS) + message(STATUS "Enable host CFlags") + include (${project_cmake_dir}/HostCFlags.cmake) + endif() + + # USE_UPSTREAM_CFLAGS (default TRUE) + # Will use predefined ignition developers cflags + if(NOT DEFINED USE_UPSTREAM_CFLAGS OR USE_UPSTREAM_CFLAGS) + message(STATUS "Enable upstream CFlags") + include(${project_cmake_dir}/DefaultCFlags.cmake) + endif() +endmacro() + +################################################# +macro (ign_setup_windows) + if(MSVC) + add_definitions("/EHsc") + endif() +endmacro() + +################################################# +macro (ign_setup_apple) + # NOTE MacOSX provides different system versions than CMake is parsing. + # The following table lists the most recent OSX versions + # 9.x.x = Mac OSX Leopard (10.5) + # 10.x.x = Mac OSX Snow Leopard (10.6) + # 11.x.x = Mac OSX Lion (10.7) + # 12.x.x = Mac OSX Mountain Lion (10.8) + if (${CMAKE_SYSTEM_VERSION} LESS 10) + add_definitions(-DMAC_OS_X_VERSION=1050) + elseif (${CMAKE_SYSTEM_VERSION} GREATER 10 AND ${CMAKE_SYSTEM_VERSION} LESS 11) + add_definitions(-DMAC_OS_X_VERSION=1060) + elseif (${CMAKE_SYSTEM_VERSION} GREATER 11 AND ${CMAKE_SYSTEM_VERSION} LESS 12) + add_definitions(-DMAC_OS_X_VERSION=1070) + elseif (${CMAKE_SYSTEM_VERSION} GREATER 12 OR ${CMAKE_SYSTEM_VERSION} EQUAL 12) + add_definitions(-DMAC_OS_X_VERSION=1080) + # Use libc++ on Mountain Lion (10.8) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -stdlib=libc++") + else () + add_definitions(-DMAC_OS_X_VERSION=0) + endif () + + set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,-undefined -Wl,dynamic_lookup") +endmacro() + +# This should be migrated to more fine control solution based on set_property APPEND +# directories. It's present on cmake 2.8.8 while precise version is 2.8.7 +link_directories(${PROJECT_BINARY_DIR}/test) +include_directories("${PROJECT_SOURCE_DIR}/test/gtest/include") + +################################################# +# Enable tests compilation by default +if (NOT DEFINED ENABLE_TESTS_COMPILATION) + set (ENABLE_TESTS_COMPILATION True) +endif() + +# Define testing macros as empty and redefine them if support is found and +# ENABLE_TESTS_COMPILATION is set to true +macro (ign_build_tests) +endmacro() + +if (ENABLE_TESTS_COMPILATION) + include (${project_cmake_dir}/TestUtils.cmake) +endif() + +################################################# +# Macro to setup supported compiler warnings +# Based on work of Florent Lamiraux, Thomas Moulard, JRL, CNRS/AIST. +include(CheckCXXCompilerFlag) + +macro(filter_valid_compiler_warnings) + foreach(flag ${ARGN}) + CHECK_CXX_COMPILER_FLAG(${flag} R${flag}) + if(${R${flag}}) + set(WARNING_CXX_FLAGS "${WARNING_CXX_FLAGS} ${flag}") + endif() + endforeach() +endmacro() diff --git a/ign-math/cmake/cmake_uninstall.cmake.in b/ign-math/cmake/cmake_uninstall.cmake.in new file mode 100644 index 0000000..efcb24a --- /dev/null +++ b/ign-math/cmake/cmake_uninstall.cmake.in @@ -0,0 +1,21 @@ +if(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt") + message(FATAL_ERROR "Cannot find install manifest: "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt"") +endif(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt") + +file(READ "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt" files) +string(REGEX REPLACE "\n" ";" files "${files}") +foreach(file ${files}) + message(STATUS "Uninstalling "$ENV{DESTDIR}${file}"") + if(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}") + exec_program( + "@CMAKE_COMMAND@" ARGS "-E remove "$ENV{DESTDIR}${file}"" + OUTPUT_VARIABLE rm_out + RETURN_VALUE rm_retval + ) + if(NOT "${rm_retval}" STREQUAL 0) + message(FATAL_ERROR "Problem when removing "$ENV{DESTDIR}${file}"") + endif(NOT "${rm_retval}" STREQUAL 0) + else(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}") + message(STATUS "File "$ENV{DESTDIR}${file}" does not exist.") + endif(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}") +endforeach(file) diff --git a/ign-math/cmake/config.hh.in b/ign-math/cmake/config.hh.in new file mode 100644 index 0000000..1789eef --- /dev/null +++ b/ign-math/cmake/config.hh.in @@ -0,0 +1,15 @@ +/* Config.hh. Generated by CMake for @PROJECT_NAME@. */ + +/* Version number */ +#define IGNITION_MATH_MAJOR_VERSION ${PROJECT_MAJOR_VERSION} +#define IGNITION_MATH_MINOR_VERSION ${PROJECT_MINOR_VERSION} +#define IGNITION_MATH_PATCH_VERSION ${PROJECT_PATCH_VERSION} + +#define IGNITION_MATH_VERSION "${PROJECT_VERSION}" +#define IGNITION_MATH_VERSION_FULL "${PROJECT_VERSION_FULL}" + +#define IGNITION_MATH_VERSION_HEADER "Ignition math, version ${PROJECT_VERSION_FULL}\nCopyright (C) 2014 Open Source Robotics Foundation.\nReleased under the Apache 2.0 License.\n\n" + +#cmakedefine BUILD_TYPE_PROFILE 1 +#cmakedefine BUILD_TYPE_DEBUG 1 +#cmakedefine BUILD_TYPE_RELEASE 1 diff --git a/ign-math/cmake/cpack.cmake b/ign-math/cmake/cpack.cmake new file mode 100644 index 0000000..db7df17 --- /dev/null +++ b/ign-math/cmake/cpack.cmake @@ -0,0 +1,25 @@ +################################################################################ +#Find available package generators + +# DEB +if ("${CMAKE_SYSTEM}" MATCHES "Linux") + find_program(DPKG_PROGRAM dpkg) + if (EXISTS ${DPKG_PROGRAM}) + list (APPEND CPACK_GENERATOR "DEB") + endif(EXISTS ${DPKG_PROGRAM}) + + find_program(RPMBUILD_PROGRAM rpmbuild) +endif() + +list (APPEND CPACK_SOURCE_GENERATOR "TBZ2") +list (APPEND CPACK_SOURCE_GENERATOR "ZIP") +list (APPEND CPACK_SOURCE_IGNORE_FILES "TODO;/.hg/;.swp$;/build/;.hgtags") + +include (InstallRequiredSystemLibraries) + +#execute_process(COMMAND dpkg --print-architecture _NPROCE) +set (DEBIAN_PACKAGE_DEPENDS "") + +set (RPM_PACKAGE_DEPENDS "") + +set (PROJECT_CPACK_CFG_FILE "${PROJECT_BINARY_DIR}/cpack_options.cmake") diff --git a/ign-math/cmake/cpack_options.cmake.in b/ign-math/cmake/cpack_options.cmake.in new file mode 100644 index 0000000..90fe4dd --- /dev/null +++ b/ign-math/cmake/cpack_options.cmake.in @@ -0,0 +1,28 @@ +set(CPACK_PACKAGE_NAME "@PROJECT_NAME@") +set(CPACK_PACKAGE_VENDOR "osrfoundation.org") +set(CPACK_PACKAGE_DESCRIPTION_SUMMARY + "A set of @IGN_PROJECT_NAME@ classes for robot applications.") +set(CPACK_PACKAGE_INSTALL_DIRECTORY "@PROJECT_NAME_LOWER@") +set(CPACK_RESOURCE_FILE_LICENSE "@CMAKE_CURRENT_SOURCE_DIR@/LICENSE") +set(CPACK_RESOURCE_FILE_README "@CMAKE_CURRENT_SOURCE_DIR@/README.md") +set(CPACK_PACKAGE_DESCRIPTION_FILE "@CMAKE_CURRENT_SOURCE_DIR@/README.md") +set(CPACK_PACKAGE_MAINTAINER "Nate Koenig ") +set(CPACK_PACKAGE_CONTACT "Nate Koenig ") + +set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "@DPKG_ARCH@") +set(CPACK_DEBIAN_PACKAGE_DEPENDS "@DEBIAN_PACKAGE_DEPENDS@") +set(CPACK_DEBIAN_PACKAGE_SECTION "devel") +set(CPACK_DEBIAN_PACKAGE_PRIORITY "optional") +set(CPACK_DEBIAN_PACKAGE_SHLIBDEPS ON) +set(CPACK_DEBIAN_PACKAGE_DESCRIPTION + "A set of @IGN_PROJECT_NAME@ classes for robot applications.") + +set(CPACK_RPM_PACKAGE_ARCHITECTURE "@DPKG_ARCH@") +set(CPACK_RPM_PACKAGE_REQUIRES "@DEBIAN_PACKAGE_DEPENDS@") +set(CPACK_RPM_PACKAGE_DESCRIPTION + "A set of @IGN_PROJECT_NAME@ classes for robot applications.") + +set (CPACK_PACKAGE_FILE_NAME + "@PROJECT_NAME_LOWER@@PROJECT_MAJOR_VERSION@-@PROJECT_VERSION_FULL@") +set (CPACK_SOURCE_PACKAGE_FILE_NAME + "@PROJECT_NAME_LOWER@@PROJECT_MAJOR_VERSION@-@PROJECT_VERSION_FULL@") diff --git a/ign-math/cmake/ignition-math-config.cmake.in b/ign-math/cmake/ignition-math-config.cmake.in new file mode 100644 index 0000000..bd7f32f --- /dev/null +++ b/ign-math/cmake/ignition-math-config.cmake.in @@ -0,0 +1,41 @@ +if (@PKG_NAME@_CONFIG_INCLUDED) + return() +endif() +set(@PKG_NAME@_CONFIG_INCLUDED TRUE) + +list(APPEND @PKG_NAME@_INCLUDE_DIRS "@CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_INCLUDEDIR@/ignition/@IGN_PROJECT_NAME@@PROJECT_MAJOR_VERSION@") + +list(APPEND @PKG_NAME@_LIBRARY_DIRS "@CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_LIBDIR@") + +list(APPEND @PKG_NAME@_CXX_FLAGS -std=c++11) +if ("${CMAKE_CXX_COMPILER_ID} " MATCHES "Clang ") + set(@PKG_NAME@_CXX_FLAGS "${@PKG_NAME@_CXX_FLAGS} -stdlib=libc++") +endif () + +# On windows we produce .dll libraries with no prefix +if (WIN32) + set(CMAKE_FIND_LIBRARY_PREFIXES "") + set(CMAKE_FIND_LIBRARY_SUFFIXES ".lib" ".dll") +endif() + +foreach(lib @PKG_LIBRARIES@) + set(onelib "${lib}-NOTFOUND") + find_library(onelib ${lib} + PATHS "@CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_LIBDIR@" + NO_DEFAULT_PATH + ) + if(NOT onelib) + message(FATAL_ERROR "Library '${lib}' in package @PKG_NAME@ is not installed properly") + endif() + list(APPEND @PKG_NAME@_LIBRARIES ${onelib}) +endforeach() + +foreach(dep @PKG_DEPENDS@) + if(NOT ${dep}_FOUND) + find_package(${dep} REQUIRED) + endif() + list(APPEND @PKG_NAME@_INCLUDE_DIRS "${${dep}_INCLUDE_DIRS}") + list(APPEND @PKG_NAME@_LIBRARIES "${${dep_lib}_LIBRARIES}") +endforeach() + +list(APPEND @PKG_NAME@_LDFLAGS "-L@CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_LIBDIR@") diff --git a/ign-math/cmake/pkgconfig/ignition-math.in b/ign-math/cmake/pkgconfig/ignition-math.in new file mode 100644 index 0000000..fba8b5d --- /dev/null +++ b/ign-math/cmake/pkgconfig/ignition-math.in @@ -0,0 +1,10 @@ +prefix=@CMAKE_INSTALL_PREFIX@ +libdir=${prefix}/@CMAKE_INSTALL_LIBDIR@ +includedir=${prefix}/@CMAKE_INSTALL_INCLUDEDIR@/ignition/@IGN_PROJECT_NAME@@PROJECT_MAJOR_VERSION@ + +Name: Ignition Math +Description: A set of math classes for robot applications +Version: @PROJECT_VERSION_FULL@ +Requires: +Libs: "-L${libdir}" -lignition-math@PROJECT_MAJOR_VERSION@ +CFlags: "-I${includedir}" -std=c++11 diff --git a/ign-math/cmake/upload_doc.sh.in b/ign-math/cmake/upload_doc.sh.in new file mode 100644 index 0000000..2afc291 --- /dev/null +++ b/ign-math/cmake/upload_doc.sh.in @@ -0,0 +1,29 @@ +#!/bin/sh + +# Check if the node was configured to use s3cmd +# This is done by running s3cmd --configure +if [ ! -f "${HOME}/.s3cfg" ]; then + echo "No $HOME/.s3cfg file found. Please config the software first in your system" + exit 1 +fi + +# Make documentation if not build +if [ ! -f "@CMAKE_BINARY_DIR@/doxygen/html/index.html" ]; then + make doc + if [ ! -f "@CMAKE_BINARY_DIR@/doxygen/html/index.html" ]; then + echo "Documentation not present. Install doxygen, and run `make doc` in the build directory" + exit 1 + fi +fi + +# Dry run +s3cmd sync @CMAKE_BINARY_DIR@/doxygen/html/* s3://osrf-distributions/ign-@IGN_PROJECT_NAME@/api/@PROJECT_VERSION_FULL@/ --dry-run -v + +echo -n "Upload (Y/n)? " +read ans + +if [ "$ans" = "n" ] || [ "$ans" = "N" ]; then + exit 1 +else + s3cmd sync @CMAKE_BINARY_DIR@/doxygen/html/* s3://osrf-distributions/ign-@IGN_PROJECT_NAME@/api/@PROJECT_VERSION_FULL@/ -v +fi diff --git a/ign-math/codecov.yml b/ign-math/codecov.yml new file mode 100644 index 0000000..6f25123 --- /dev/null +++ b/ign-math/codecov.yml @@ -0,0 +1,2 @@ +codecov: + branch: default diff --git a/ign-math/configure.bat b/ign-math/configure.bat new file mode 100644 index 0000000..6171f7b --- /dev/null +++ b/ign-math/configure.bat @@ -0,0 +1,23 @@ + +:: NOTE: This script is only meant to be used as part of the ignition developers' CI system +:: Users and developers should build and install this library using cmake and Visual Studio + +:: Set configuration variables +@set build_type=Release +@if not "%1"=="" set build_type=%1 +@echo Configuring for build type %build_type% + +:: Use legacy install location if unset +@if "%WORKSPACE_INSTALL_DIR%"=="" set WORKSPACE_INSTALL_DIR="install\%build_type%" + +:: Go to the directory that this configure.bat file exists in +cd /d %~dp0 + +:: Create a build directory and configure +md build +cd build +cmake .. -G "NMake Makefiles" -DCMAKE_INSTALL_PREFIX="%WORKSPACE_INSTALL_DIR%" -DCMAKE_BUILD_TYPE="%build_type%" -DENABLE_TESTS_COMPILATION:BOOL=True +:: Note: Testing is enabled by default in legacy branches. +:: Take care when merging this forward. + +:: If the caller wants to build and/or install, they should do so after calling this script diff --git a/ign-math/doc/CMakeLists.txt b/ign-math/doc/CMakeLists.txt new file mode 100644 index 0000000..36e4496 --- /dev/null +++ b/ign-math/doc/CMakeLists.txt @@ -0,0 +1,14 @@ +find_package(Doxygen) + +if (DOXYGEN_FOUND) + configure_file(${CMAKE_SOURCE_DIR}/doc/ignition.in + ${CMAKE_BINARY_DIR}/ignition.dox @ONLY) + + add_custom_target(doc + # Generate the API documentation + ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/ignition.dox + WORKING_DIRECTORY ${CMAKE_BINARY_DIR} + COMMAND cp ${CMAKE_SOURCE_DIR}/doc/ignition_logo.svg + ${CMAKE_BINARY_DIR}/doxygen/html + COMMENT "Generating API documentation with Doxygen" VERBATIM) +endif() diff --git a/ign-math/doc/footer.html b/ign-math/doc/footer.html new file mode 100644 index 0000000..71d71c4 --- /dev/null +++ b/ign-math/doc/footer.html @@ -0,0 +1 @@ + diff --git a/ign-math/doc/header.html b/ign-math/doc/header.html new file mode 100644 index 0000000..55ace60 --- /dev/null +++ b/ign-math/doc/header.html @@ -0,0 +1,67 @@ + + + + + + + Ignition: $title + + + + + + + + + + + + + +
+

+ +

+ +
+
+
API
+
Class List
+
Class Hierarchy
+
Globals
+
Namespace Members
+
Files
+
+
+
+
+
Links
+
Ignition Website
+
Report Documentation Issues
+
+
+ +
+ + + + +
+ +
+ +
+
+ +
diff --git a/ign-math/doc/ignition.in b/ign-math/doc/ignition.in new file mode 100644 index 0000000..32cb4bd --- /dev/null +++ b/ign-math/doc/ignition.in @@ -0,0 +1,2306 @@ +# Doxyfile 1.8.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = IgnitionMath + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = @PROJECT_VERSION_FULL@ + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = doxygen + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = YES + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = NO + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = YES + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = NO + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = YES + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = YES + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = YES + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = /tmp/ignition-math_dox.warn + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = @CMAKE_SOURCE_DIR@/doc/mainpage.html \ + @CMAKE_SOURCE_DIR@/include/ignition/math + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.hh \ + *.h + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = examples + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = *.cc \ + *.hh + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = YES + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 3 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = "@CMAKE_SOURCE_DIR@/doc/header.html" + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = "@CMAKE_SOURCE_DIR@/doc/footer.html" + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = "@CMAKE_SOURCE_DIR@/doc/style.css" + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 13 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 76 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Gazebo API Documentation" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = YES + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /