Merge branch 'gz-math8' into merge_8_main_20241007

gazebosim · Oct 7, 2024 · ab6c73d · ab6c73d
2 parents 99398fa + eeb17ea
commit ab6c73d
Show file tree

Hide file tree

Showing 17 changed files with 102 additions and 538 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -1,18 +1,25 @@
 ## Gazebo Math 8.x
 
-### Gazebo Math 8.0.0 (2024-09-XX)
+### Gazebo Math 8.0.0 (2024-09-25)
+
+1. Miscellaneous documentation fixes
+    * [Pull request #632](https://github.com/gazebosim/gz-math/pull/632)
+    * [Pull request #631](https://github.com/gazebosim/gz-math/pull/631)
+    * [Pull request #630](https://github.com/gazebosim/gz-math/pull/630)
+    * [Pull request #628](https://github.com/gazebosim/gz-math/pull/628)
+
+1. Fix Vector examples
+    * [Pull request #629](https://github.com/gazebosim/gz-math/pull/629)
 
 1. Added CoordinateVector3 and used it in SphericalCoordinates
     * [Pull request #616](https://github.com/gazebosim/gz-math/pull/616)
 
 1. Clamping color channel values to within [0, 1]
     * [Pull request #613](https://github.com/gazebosim/gz-math/pull/613)
 
-1. Implement rule of zero part 2
-    * [Pull request #614](https://github.com/gazebosim/gz-math/pull/614)
-
-1. Use ImplPtr, fix rule of 0 part 1
+1. Use ImplPtr, Implement rule of zero
     * [Pull request #608](https://github.com/gazebosim/gz-math/pull/608)
+    * [Pull request #614](https://github.com/gazebosim/gz-math/pull/614)
 
 1. Fix flaky Stopwatch test
     * [Pull request #610](https://github.com/gazebosim/gz-math/pull/610)

diff --git a/README.md b/README.md
@@ -9,10 +9,10 @@
 
 Build | Status
 -- | --
-Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-math/branch/main/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-math/branch/main)
-Ubuntu Noble  | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_math-ci-main-noble-amd64)](https://build.osrfoundation.org/job/gz_math-ci-main-noble-amd64)
-Homebrew      | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_math-ci-main-homebrew-amd64)](https://build.osrfoundation.org/job/gz_math-ci-main-homebrew-amd64)
-Windows       | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_math-main-win)](https://build.osrfoundation.org/job/gz_math-main-win)
+Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-math/branch/gz-math8/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-math/tree/gz-math8)
+Ubuntu Noble  | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_math-ci-gz-math8-noble-amd64)](https://build.osrfoundation.org/job/gz_math-ci-gz-math8-noble-amd64)
+Homebrew      | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_math-ci-gz-math8-homebrew-amd64)](https://build.osrfoundation.org/job/gz_math-ci-gz-math8-homebrew-amd64)
+Windows       | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_math-8-win)](https://build.osrfoundation.org/job/gz_math-8-win)
 
 Gazebo Math, a component of [Gazebo](https://gazebosim.org), provides general purpose math
 classes and functions designed for robotic applications.
@@ -27,9 +27,9 @@ classes and functions designed for robotic applications.
 
 [Folder Structure](#folder-structure)
 
-[Code of Conduct](#code-of-conduct)
+[Contributing](#contributing)
 
-[Contributing](#code-of-contributing)
+[Code of Conduct](#code-of-conduct)
 
 [Versioning](#versioning)
 
@@ -47,11 +47,11 @@ Math types.
 
 # Install
 
-See the [installation tutorial](https://gazebosim.org/api/math/7/install.html).
+See the [installation tutorial](https://gazebosim.org/api/math/8/install.html).
 
 # Usage
 
-Please refer to the [examples directory](https://github.com/gazebosim/gz-math/raw/main/examples/).
+Please refer to the [examples directory](https://github.com/gazebosim/gz-math/raw/gz-math8/examples/).
 
 # Folder Structure
 
@@ -90,4 +90,4 @@ This library uses [Semantic Versioning](https://semver.org/). Additionally, this
 
 # License
 
-This library is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0). See also the [LICENSE](https://github.com/gazebosim/gz-math/blob/main/LICENSE) file.
+This library is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0). See also the [LICENSE](https://github.com/gazebosim/gz-math/blob/gz-math8/LICENSE) file.
diff --git a/eigen3/include/CMakeLists.txt b/eigen3/include/CMakeLists.txt
@@ -1,2 +1 @@
 add_subdirectory(gz)
-install(DIRECTORY ignition DESTINATION ${GZ_INCLUDE_INSTALL_DIR_FULL})
diff --git a/eigen3/include/ignition/math/eigen3.hh b/eigen3/include/ignition/math/eigen3.hh
diff --git a/eigen3/include/ignition/math/eigen3/Conversions.hh b/eigen3/include/ignition/math/eigen3/Conversions.hh
diff --git a/eigen3/include/ignition/math/eigen3/Util.hh b/eigen3/include/ignition/math/eigen3/Util.hh
diff --git a/examples/vector3_example.py b/examples/vector3_example.py
@@ -23,7 +23,7 @@
 import gz.math8
 
 v1 = gz.math8.Vector3d(0, 0, 3)
-print("v =: {} {} {}\n".format(v1.x(), v1.y(), v1.z()))
+print("v1 = {} {} {}\n".format(v1.x(), v1.y(), v1.z()))
 
 v2 = gz.math8.Vector3d(4, 0, 0)
 print("v2 = {} {} {}\n".format(v2.x(), v2.y(), v2.z()))

diff --git a/examples/vector3_example.rb b/examples/vector3_example.rb
@@ -23,7 +23,7 @@
 require 'gz/math'
 
 v1 = Gz::Math::Vector3d.new(0, 0, 0)
-printf("v =: %f %f %f\n", v1.X(), v1.Y(), v1.Z())
+printf("v1 = %f %f %f\n", v1.X(), v1.Y(), v1.Z())
 
 v2 = Gz::Math::Vector3d.new(1, 0, 0)
 printf("v2 = %f %f %f\n", v2.X(), v2.Y(), v2.Z())

diff --git a/tutorials/angle.md b/tutorials/angle.md
diff --git a/tutorials/color.md b/tutorials/color.md
@@ -54,4 +54,4 @@ You can also set or read a color in HSV.
 
 \snippet examples/color_example.cc Set value from HSV
 
-There are more functions in `Color`. Take a look at the [API](https://gazebosim.org/api/math/7/classgz_1_1math_1_1Color.html)
+There are more functions in `Color`. Take a look at the [API](https://gazebosim.org/api/math/8/classgz_1_1math_1_1Color.html)
diff --git a/tutorials/example_angle.md b/tutorials/example_angle.md
@@ -14,13 +14,20 @@ cd gz-math/examples
 mkdir build
 cd build
 cmake ..
+# Linux and macOS
 make
+# Windows
+cd ..
+cmake --build build --config Release
 ```
 
 When the code is compiled, run:
 
 ```{.sh}
+# Linux and macOS
 ./angle_example
+# Windows
+.\build\Release\angle_example.exe
 ```
 
 The ouput of the program:

diff --git a/tutorials/example_triangle.md b/tutorials/example_triangle.md
@@ -12,13 +12,20 @@ cd gz-math/examples
 mkdir build
 cd build
 cmake ..
+# Linux and macOS
 make
+# Windows
+cd ..
+cmake --build build --config Release
 ```
 
 When the code is compiled, run:
 
 ```{.sh}
+# Linux and macOS
 ./triangle_example
+# Windows
+.\build\Release\triangle_example.exe
 ```
 
 The ouput of the program:
@@ -69,4 +76,4 @@ The `Intersects` function checks if a line segment intersects the triangle. It a
 
 \snippet examples/triangle_example.cc intersect
 
-There are more functions in `Triangle`. Take a look at the [API](https://gazebosim.org/api/math/7/)
+There are more functions in `Triangle`. Take a look at the [API](https://gazebosim.org/api/math/8/)