Improve Vector Operations, Normalization and Capitalization #180
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ChristopherRabotin
requested changes
Jun 10, 2023
src/utils.rs
Outdated
| if big_a < f64::EPSILON { | ||
| Vector3::zeros() | ||
| } else if big_b < f64::EPSILON { | ||
| *a | ||
| } else { | ||
| let a_scl = a / big_a; | ||
| let b_scl = b / big_b; | ||
| let a_scl = a.scale(1.0 / big_a); |
There was a problem hiding this comment.
I prefer using the operator overload instead of .scale() because it's immediately understandable. (Same for the two other uses below)
| pub fn perpv(a: &Vector3<f64>, b: &Vector3<f64>) -> Vector3<f64> { | ||
| let big_a = a[0].abs().max(a[1].abs().max(a[2].abs())); | ||
| let big_b = b[0].abs().max(b[1].abs().max(b[2].abs())); | ||
| let big_a = a.amax(); |
There was a problem hiding this comment.
Mindblown! https://docs.rs/nalgebra/latest/nalgebra/base/struct.Matrix.html#method.amax I didn't know this was a thing!
There was a problem hiding this comment.
Fiercely efficient!
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## master #180 +/- ##
==========================================
+ Coverage 66.33% 66.59% +0.25%
==========================================
Files 127 127
Lines 32445 32506 +61
==========================================
+ Hits 21524 21648 +124
+ Misses 10921 10858 -63
☔ View full report in Codecov by Sentry. |
ChristopherRabotin
approved these changes
Jun 11, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces several improvements to the vector operations, normalization and capitalization functions.
The changes are intended to make the code more idiomatic Rust, improve readability, and enhance the robustness of the code.
Refactored the
rotv,perpv, andprojvfunctions to use more idiomatic Rust. This includes using thenormalize,scale,cross,dot,amax,sub, andnorm_squaredmethods from theVector3struct.Refactored the
normalize,denormalize, andcapitalizefunctions.Improved the documentation for these functions. Each function now has a detailed docstring that describes its purpose, its arguments, and its return value. This will make it easier for other developers to understand and use these functions.
Added comprehensive unit tests for these functions. These tests cover various edge cases and ensure that the functions work as expected.
These changes should not affect the functionality of the code, but they will make it easier to read, understand, and maintain. The unit tests will help us catch any potential issues or regressions in the future.
Please review these changes and let me know if you have any feedback or questions.