Added edge_lengths property
#196
Merged
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
janbridley
requested review from
a team and
DomFijan
and removed request for
a team
Codecov Report
@@ Coverage Diff @@
## master #196 +/- ##
==========================================
- Coverage 54.88% 54.87% -0.01%
==========================================
Files 24 25 +1
Lines 2551 2582 +31
==========================================
+ Hits 1400 1417 +17
- Misses 1151 1165 +14
|
DomFijan
requested changes
Sep 19, 2023
coxeter/shapes/polyhedron.py
Outdated
| @@ -390,6 +390,11 @@ def edge_vectors(self): | |||
| """:class:`numpy.ndarray`: Get the polyhedron's edges as vectors.""" | |||
| return self.vertices[self.edges[:, 1]] - self.vertices[self.edges[:, 0]] | |||
|
|
|||
| @property | |||
| def edge_lengths(self): | |||
| """:class:`numpy.ndarray`: Get the length of each edge of the polyhedron.""" | |||
There was a problem hiding this comment.
Suggested change
| """:class:`numpy.ndarray`: Get the length of each edge of the polyhedron.""" | |
| """:class:`numpy.ndarray`: Get the length of each edge of the polyhedron in the same order as order of edges in :meth:`edge_vectors` .""" |
There was a problem hiding this comment.
Should we add this ordering specification to edge_vectors as well? Both use the same ordering as :meth:edges which is the primary sorted array
There was a problem hiding this comment.
Maybe. Is it super obvious what this is? If it is maybe this needs not be in the docstring, but if it is not then it should be for sure.
DomFijan
approved these changes
Sep 27, 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.
Description
Added edge_lengths property to the Polyhedron class.
Motivation and Context
Although this is a single line of code, I use it extremely frequently (as it has additional value in helping to determine the degree of uniformity of a solid). This should be a quick PR, and if it seems unnecessary I am happy to continue manually implementing this function.
Types of Changes
1The change breaks (or has the potential to break) existing functionality.
Checklist: