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 a matrix equalization algorithm #11360

Merged
merged 3 commits into from May 1, 2024

Conversation

meg-1
Copy link
Contributor

@meg-1 meg-1 commented Apr 11, 2024

Describe your change:

Adding a matrix equalization algorithm, which equalizes all elements of the input vector to a common value, by making the minimal number of "updates" under the constraint of a step size (k).

This algorithm has practical use in scenarios where you need to achieve uniformity across elements of an array under specific constraints and with minimal changes. For example:

  • resource allocation (this algorithm provides a way to complete the task efficiently)
  • game theory (this algorithm may help in devising fair strategies using minimal moves)
  • signal processing (the algorithm might be applied where signal adjustments are constrained by step size).
  • 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
Contributor

@imSanko imSanko left a comment

Choose a reason for hiding this comment

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

Nice Add On!

@meg-1
Copy link
Contributor Author

meg-1 commented Apr 24, 2024

Nice Add On!

Thank you, Sanko! @cclauss, if possible, could you please check this pr out and approve a merge? Would be much appreciated :))

@cclauss
Copy link
Member

cclauss commented Apr 24, 2024

Please add a URL to a Wikipedia article or other source that explains what the algorithm does and why it is useful.

@meg-1
Copy link
Contributor Author

meg-1 commented Apr 24, 2024

Please add a URL to a Wikipedia article or other source that explains what the algorithm does and why it is useful.

Thank you, @cclauss, just did that!

@cclauss
Copy link
Member

cclauss commented Apr 24, 2024

OK... Now that I know what the algorithm does, why would anyone ever want to use it?

import sys


def array_equalization(vector: list[int], k: int) -> int:
Copy link
Member

Choose a reason for hiding this comment

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

Self-documenting variable names, please.

Suggested change
def array_equalization(vector: list[int], k: int) -> int:
def array_equalization(vector: list[int], step_size: int) -> int:

0
>>> array_equalization([22, 22, 22, 33, 33, 33], 2)
2

Copy link
Member

@cclauss cclauss Apr 24, 2024

Choose a reason for hiding this comment

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

We need tests that have the same vector but different values for step-size including -1, 0, 1.3, and maxsize.

@@ -0,0 +1,47 @@
import sys
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
import sys
from sys import maxsize

@meg-1
Copy link
Contributor Author

meg-1 commented May 1, 2024

OK... Now that I know what the algorithm does, why would anyone ever want to use it?

Just added an explanation in the description of this commit:

This algorithm has practical use in scenarios where you need to achieve uniformity across elements of an array under specific constraints and with minimal changes. For example:

resource allocation (this algorithm provides a way to complete the task efficiently)
game theory (this algorithm may help in devising fair strategies using minimal moves)
signal processing (the algorithm might be applied where signal adjustments are constrained by step size).

And thank you very much for the review, @cclauss , just implemented all recommendations suggested :))

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.

With https://en.wikipedia.org/wiki/Single_instruction,_multiple_data and vectorization techniques being so prevalent these daze I doubt this would ever be used but here we go...

@cclauss cclauss merged commit c026b19 into TheAlgorithms:master May 1, 2024
3 checks passed
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.

None yet

3 participants