Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pose3: deprecate - and -= operators #438

Merged
merged 1 commit into from
Jun 8, 2022

Conversation

scpeters
Copy link
Member

@scpeters scpeters commented Jun 6, 2022

🎉 New feature

Part of #60.

Summary

As noted in gz-math#60, there are concerns about the pose subtraction operator. Given that it is equivalent to multiplying by an inverse (albeit with reversed order A - B = B.Inverse() * A), this deprecates the unitary negation operator - and the subtraction operators - and -=.

This is a draft PR until all usage of the deprecated behavior has been replaced in downstream repositories.

Test it

Run UNIT_Pose3_TEST

Checklist

  • Signed all commits for DCO
  • Added tests
  • Added example and/or tutorial
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

Part of #60.

Signed-off-by: Steve Peters <[email protected]>
@codecov
Copy link

codecov bot commented Jun 6, 2022

Codecov Report

Merging #438 (ae2e1c5) into main (b250500) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #438   +/-   ##
=======================================
  Coverage   99.69%   99.69%           
=======================================
  Files          73       73           
  Lines        6588     6588           
=======================================
  Hits         6568     6568           
  Misses         20       20           
Impacted Files Coverage Δ
include/gz/math/Pose3.hh 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b250500...ae2e1c5. Read the comment docs.

@scpeters scpeters marked this pull request as ready for review June 8, 2022 06:48
@scpeters scpeters merged commit 2bde663 into main Jun 8, 2022
@scpeters scpeters deleted the scpeters/pose_deprecate_subtraction branch June 8, 2022 06:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌱 garden Ignition Garden
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants