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

Improve API and documentation for SpatialInertia construction. #521

Merged
merged 1 commit into from
Dec 10, 2018

Conversation

tkoolen
Copy link
Collaborator

@tkoolen tkoolen commented Dec 8, 2018

Fix #520. @togo59, I hope this will clarify things and improve usability.

@tkoolen tkoolen changed the title Improve API and documentation for SpatialInertia. Improve API and documentation for SpatialInertia construction. Dec 8, 2018
@tkoolen
Copy link
Collaborator Author

tkoolen commented Dec 8, 2018

CC: @Symplectomorphism, sorry it took so long.

@tkoolen
Copy link
Collaborator Author

tkoolen commented Dec 8, 2018

@rdeits, could I ask you to double check the rand changes?

Add warning to SpatialInertia doc. Improve show method for SpatialInertia.

SpatialInertia: add constructor doc, add convenience kwarg constructor, update rand method to use new constructor.

Add test for new SpatialInertia constructor.

Also add a `moment` keyword argument to the SpatialInertia constructor.

Use kwarg constructor in more places.
@codecov-io
Copy link

codecov-io commented Dec 9, 2018

Codecov Report

Merging #521 into master will increase coverage by 0.25%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #521      +/-   ##
==========================================
+ Coverage   99.27%   99.53%   +0.25%     
==========================================
  Files          38       38              
  Lines        1788     2770     +982     
==========================================
+ Hits         1775     2757     +982     
  Misses         13       13
Impacted Files Coverage Δ
src/spatial/motion_force_interaction.jl 100% <100%> (ø) ⬆️
src/graphs/abstract.jl 90.9% <0%> (-9.1%) ⬇️
src/spatial/spatialmotion.jl 99.06% <0%> (-0.94%) ⬇️
src/urdf/write.jl 100% <0%> (ø) ⬆️
src/graphs/directed_graph.jl 100% <0%> (ø) ⬆️
src/joint_types/sin_cos_revolute.jl 100% <0%> (ø) ⬆️
src/joint_types/fixed.jl 100% <0%> (ø) ⬆️
src/joint_types/quaternion_floating.jl 100% <0%> (ø) ⬆️
src/util.jl 100% <0%> (ø) ⬆️
src/joint_types/planar.jl 100% <0%> (ø) ⬆️
... and 26 more

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 94b14f7...73e97b6. Read the comment docs.

1 similar comment
@codecov-io
Copy link

codecov-io commented Dec 9, 2018

Codecov Report

Merging #521 into master will increase coverage by 0.25%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #521      +/-   ##
==========================================
+ Coverage   99.27%   99.53%   +0.25%     
==========================================
  Files          38       38              
  Lines        1788     2770     +982     
==========================================
+ Hits         1775     2757     +982     
  Misses         13       13
Impacted Files Coverage Δ
src/spatial/motion_force_interaction.jl 100% <100%> (ø) ⬆️
src/graphs/abstract.jl 90.9% <0%> (-9.1%) ⬇️
src/spatial/spatialmotion.jl 99.06% <0%> (-0.94%) ⬇️
src/urdf/write.jl 100% <0%> (ø) ⬆️
src/graphs/directed_graph.jl 100% <0%> (ø) ⬆️
src/joint_types/sin_cos_revolute.jl 100% <0%> (ø) ⬆️
src/joint_types/fixed.jl 100% <0%> (ø) ⬆️
src/joint_types/quaternion_floating.jl 100% <0%> (ø) ⬆️
src/util.jl 100% <0%> (ø) ⬆️
src/joint_types/planar.jl 100% <0%> (ø) ⬆️
... and 26 more

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 94b14f7...73e97b6. Read the comment docs.

Copy link
Collaborator

@rdeits rdeits left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, looks good!

@tkoolen
Copy link
Collaborator Author

tkoolen commented Dec 10, 2018

Great, thanks!

@tkoolen tkoolen merged commit 4ef56cb into master Dec 10, 2018
@tkoolen tkoolen deleted the tk/inertia-updates branch December 10, 2018 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants