Refactoring of vector #415

Mingun · 2020-03-29T16:18:36Z

Some refactoring of Vector2D and Vector3D. Summary of changes:

Add all missing documentation (deny(missing_docs) is not a problem for vectors now)
Implement missing *Assign operators
Implement Round/Floor/Ceil/Zero
Add some more tests
Reorder methods thus documentation looks more organic and mostly all methods have only necessary bounds


        Vector: group impl blocks for type together


        Vector: reorder operator implementations (splitted for 3 commits for …

…better diffs - 1)


        Vector: reorder operator implementations (splitted for 3 commits for …

…better diffs - 2)


        Vector: reorder operator implementations (splitted for 3 commits for …

…better diffs - 3)


        Vector: do not restrict operators only to the same type, as wrapped


        Vector: implement *= and /= by Scale


        Vector: implement Round/Floor/Ceil for Vectors and add doctests for that


        Vector: implement Zero


        Vector: simplify trait bounds: Float already assumes all other used t…

…raits


        Vector: move length(), normalize() and robust_normalize() into Float …

…impl block


        Vector: move to_3d() into Copy impl block


        Vector: move angle_from_x_axis() into Copy impl block


        Vector: merge angle_to() into another impl blocks


        Vector: merge dot() and cross() into another impl blocks


        Vector: merge abs() into another impl blocks


        Vector: add missing documentation


        Vector: move trait bounds - thus the documentation looks more organic


        Vector: group PartialOrd trait impls together - thus the documentatio…

…n looks more organic

nical

Lots of very good stuff in here, thanks!

Just a small change in the abs comments and this is good to go.

src/vector.rs

Mingun · 2020-03-30T11:49:32Z

Done. I've replace incorrect notice with examples of current behavior

nical · 2020-03-30T12:24:46Z

src/vector.rs

+    ///
+    /// Method panics if `abs()` of underlying type panics:
+    ///
+    /// ```rust,should_panic


This only panics debug builds, you are adding a test that implies that abs always panics with . Please just remove this section, it is too specific and describes something that is outside of euclid. If you really want to be explicit about the behavior of abs, you can write "The behavior for each component follows the scalar type's implementation of num_traits::Signed::abs."


        Vector: replace incorrect notice about abs() behavior with examples

nical · 2020-03-30T12:58:31Z

Thanks! @bors-servo r+

bors-servo · 2020-03-30T12:58:32Z

📌 Commit df6539a has been approved by nical

bors-servo · 2020-03-30T12:58:36Z

⌛ Testing commit df6539a with merge eb32d41...

bors-servo · 2020-03-30T14:14:13Z

☀️ Test successful - checks-travis
Approved by: nical
Pushing eb32d41 to master...

Mingun added 18 commits Mar 15, 2020

Vector: group impl blocks for type together

0e18a53

Vector: reorder operator implementations (splitted for 3 commits for …

6b1df52

…better diffs - 1)

Vector: reorder operator implementations (splitted for 3 commits for …

a7a7f08

…better diffs - 2)

Vector: reorder operator implementations (splitted for 3 commits for …

2f47dce

…better diffs - 3)

Vector: do not restrict operators only to the same type, as wrapped

071311e

Vector: implement *= and /= by Scale

f4b46ea

Vector: implement Round/Floor/Ceil for Vectors and add doctests for that

c1009c0

Vector: implement Zero

3bbe28c

Vector: simplify trait bounds: Float already assumes all other used t…

f2f9f48

…raits

Vector: move length(), normalize() and robust_normalize() into Float …

3837d07

…impl block

Vector: move to_3d() into Copy impl block

2cf11fe

Vector: move angle_from_x_axis() into Copy impl block

55e82d7

Vector: merge angle_to() into another impl blocks

b865de2

Vector: merge dot() and cross() into another impl blocks

ff0b1ea

Vector: merge abs() into another impl blocks

c601796

Vector: add missing documentation

5d41816

Vector: move trait bounds - thus the documentation looks more organic

0c92f18

Vector: group PartialOrd trait impls together - thus the documentatio…

Loading status checks…

a6c898c

…n looks more organic

nical reviewed Mar 30, 2020

View changes

src/vector.rs Outdated Show resolved Hide resolved

src/vector.rs Outdated Show resolved Hide resolved

nical reviewed Mar 30, 2020

View changes

Vector: replace incorrect notice about abs() behavior with examples

Loading status checks…

df6539a

Mingun force-pushed the Mingun:vector branch from b6081b6 to df6539a Mar 30, 2020

bors-servo merged commit eb32d41 into servo:master Mar 30, 2020
2 checks passed

2 checks passed

Travis CI - Pull Request Build Passed
Details

homu Test successful
Details

Mingun deleted the Mingun:vector branch Mar 30, 2020

servo / euclid

Refactoring of vector #415

Refactoring of vector #415

Mingun commented Mar 29, 2020

nical left a comment

Mingun commented Mar 30, 2020

This comment has been minimized.

This comment has been minimized.

nical commented Mar 30, 2020

bors-servo commented Mar 30, 2020

bors-servo commented Mar 30, 2020

bors-servo commented Mar 30, 2020

servo / euclid

Join GitHub today

Refactoring of vector #415

Refactoring of vector #415

Conversation

Mingun commented Mar 29, 2020

nical left a comment

Mingun commented Mar 30, 2020

This comment has been minimized.

nical Mar 30, 2020

This comment has been minimized.

Mingun Mar 30, 2020

nical commented Mar 30, 2020

bors-servo commented Mar 30, 2020

bors-servo commented Mar 30, 2020

bors-servo commented Mar 30, 2020