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.

Sign up for GitHub

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

Jump to bottom

Add points are collinear in 3d algorithm to /maths #5983

Merged
merged 4 commits into from
Feb 13, 2022
Merged

Add points are collinear in 3d algorithm to /maths #5983

merged 4 commits into from
Feb 13, 2022

Conversation

zefr0x
Copy link
Contributor

@zefr0x zefr0x commented Feb 7, 2022

I'm not sure if /maths directory is suitable for this algorithm so if there is a better place for it please let me know in the comments.

Describe your change:

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

@zefr0x zefr0x requested a review from Kush1101 as a code owner February 7, 2022 03:31
@ghost ghost added the require descriptive names This PR needs descriptive function and/or variable names label Feb 7, 2022
ghost
ghost reviewed Feb 7, 2022
View reviewed changes
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

  • @algorithms-keeper review to trigger the checks for only added pull request files
  • @algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

maths/points_are_collinear_3d.py Outdated
https://math.stackexchange.com/a/1951650
"""

Vector = tuple[float, float, float]
Copy link

Choose a reason for hiding this comment

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

Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: Vector

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a type-aliase.

Read More:
https://docs.python.org/3/library/typing.html#type-aliases

Copy link
Member

Choose a reason for hiding this comment

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

@dhruvmanila Is this a problem with @algorithms-keeper logic?

maths/points_are_collinear_3d.py Outdated
"""

Vector = tuple[float, float, float]
Point = tuple[float, float, float]
Copy link

Choose a reason for hiding this comment

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

Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: Point

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a type-aliase.

Read More:
https://docs.python.org/3/library/typing.html#type-aliases

Copy link
Member

Choose a reason for hiding this comment

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

Would Vector3d and Point3d be more self-documenting names? Points are usually just x, y.
Would it be a good idea to create a Triangle3d instead of passing around three points?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Would Vector3d and Point3d be more self-documenting names? Points are usually just x, y.

Thanks for letting me know about this.

Would it be a good idea to create a Triangle3d instead of passing around three points?

The algorithm uses the idea of the triangle area to solve the problem, but it is actually to check for a relationship between three separate points, so I don't feel it's a good idea to use Triangle3d.
I know it's ugly to have three points and then an integer to determine the accuracy of the calculation. Should I make the accuracy variable a global one? Do you suggest any other ideas?

maths/points_are_collinear_3d.py Outdated
return False


def are_collinear(a: Point, b: Point, c: Point, accuracy: int = 10) -> bool:
Copy link

Choose a reason for hiding this comment

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

Please provide descriptive name for the parameter: a

Please provide descriptive name for the parameter: b

Please provide descriptive name for the parameter: c

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe thet the type hint did the work.

@ghost ghost added the awaiting reviews This PR is ready to be reviewed label Feb 7, 2022
cclauss
cclauss requested changes Feb 13, 2022
View reviewed changes
Copy link
Member

@cclauss cclauss left a comment •
edited
Loading

Choose a reason for hiding this comment

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

This looks interesting!

Maybe we should create a geometry directory because many algorithms in the maths directory could be moved there as well.

maths/points_are_collinear_3d.py Outdated
"""

Vector = tuple[float, float, float]
Point = tuple[float, float, float]
Copy link
Member

Choose a reason for hiding this comment

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

Would Vector3d and Point3d be more self-documenting names? Points are usually just x, y.
Would it be a good idea to create a Triangle3d instead of passing around three points?

@ghost ghost added awaiting changes A maintainer has requested changes to this PR and removed awaiting reviews This PR is ready to be reviewed labels Feb 13, 2022
@zefr0x @cclauss
Apply suggestions from code review in points_are_collinear_3d.py
ed10286 
Thanks to cclauss.

Co-authored-by: Christian Clauss <cclauss@me.com>
@ghost ghost removed the awaiting changes A maintainer has requested changes to this PR label Feb 13, 2022
ghost
ghost reviewed Feb 13, 2022
View reviewed changes
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

  • @algorithms-keeper review to trigger the checks for only added pull request files
  • @algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

@ghost ghost added the awaiting reviews This PR is ready to be reviewed label Feb 13, 2022
ghost
ghost reviewed Feb 13, 2022
View reviewed changes
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

  • @algorithms-keeper review to trigger the checks for only added pull request files
  • @algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

ghost
ghost reviewed Feb 13, 2022
View reviewed changes
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

  • @algorithms-keeper review to trigger the checks for only added pull request files
  • @algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

cclauss
cclauss approved these changes Feb 13, 2022
View reviewed changes
Copy link
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

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

Thanks!

@ghost ghost removed the awaiting reviews This PR is ready to be reviewed label Feb 13, 2022
@cclauss cclauss merged commit 637cf10 into TheAlgorithms:master Feb 13, 2022
@zefr0x zefr0x deleted the are_collinear_algorithm branch February 13, 2022 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss cclauss approved these changes

@Kush1101 Kush1101 Awaiting requested review from Kush1101

Assignees
No one assigned
Labels
require descriptive names This PR needs descriptive function and/or variable names
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@zefr0x @cclauss