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

adding new physics algorithm: center of mass #10743

Merged
merged 5 commits into from
Oct 21, 2023

Conversation

santiditomas
Copy link
Contributor

Describe your change:

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • 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 include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

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.

This looks super cool! Nice addition. Please consider adding either namedtuples or dataclasses for Particle and Coord3D (please change those names to suit your use case). This would make the function signature:

def center_of_mass(particles: list[Particle]) -> Coord3D:

Here is a bit of code for creating and using namedtuples:

>>> from collections import namedtuple
>>> Particle = namedtuple("Particle", "x y z mass")
>>> p = Particle(1, 2, 3, 4)
>>> p
Particle(x=1, y=2, z=3, mass=4)
>>> p.mass
4

>>> total_mass = sum(particle.mass for particle in particles)

>>> Coord3D =  namedtuple("Coord3D",  "x y z")
>>> Coord3D(6, 7, 8)
Coord3D(x=6, y=7, z=8)

@cclauss cclauss self-assigned this Oct 21, 2023
@cclauss cclauss added the awaiting changes A maintainer has requested changes to this PR label Oct 21, 2023
@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed tests are failing Do not merge until tests pass and removed awaiting changes A maintainer has requested changes to this PR labels Oct 21, 2023
@algorithms-keeper algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Oct 21, 2023
@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 21, 2023
@cclauss
Copy link
Member

cclauss commented Oct 21, 2023

I went back to collections.namedtuple(). Thanks for doing this.

@cclauss cclauss merged commit d73a4c2 into TheAlgorithms:master Oct 21, 2023
2 checks passed
@santiditomas santiditomas deleted the center_of_mass branch October 22, 2023 00:01
sedatguzelsemme pushed a commit to sedatguzelsemme/Python that referenced this pull request Sep 15, 2024
* adding new physics algorithm: center of mass

* Add changes requested by the reviewer

* Add changes requested by the reviewer

* Update center_of_mass.py

* Update center_of_mass.py

---------

Co-authored-by: Christian Clauss <cclauss@me.com>
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.

2 participants