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

added coordinate_compression #9317

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

added coordinate_compression #9317

wants to merge 5 commits into from

Conversation

om-ashish-soni
Copy link

@om-ashish-soni om-ashish-soni commented Oct 1, 2023 •
edited
Loading

Describe your change:

This pull request adds the CoordinateCompressor class, enabling efficient compression and decompression of comparable values, a technique essential for algorithms and data processing tasks, ultimately reducing memory usage.

  • 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 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".

@algorithms-keeper algorithms-keeper bot added require tests Tests [doctest/unittest/pytest] are required require type hints https://docs.python.org/3/library/typing.html labels Oct 1, 2023
algorithms-keeper[bot]
algorithms-keeper bot reviewed Oct 1, 2023
View reviewed changes
Copy link

@algorithms-keeper algorithms-keeper bot 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.

@algorithms-keeper algorithms-keeper bot added the awaiting reviews This PR is ready to be reviewed label Oct 1, 2023
@algorithms-keeper algorithms-keeper bot removed the require type hints https://docs.python.org/3/library/typing.html label Oct 2, 2023
algorithms-keeper[bot]
algorithms-keeper bot reviewed Oct 2, 2023
View reviewed changes
Copy link

@algorithms-keeper algorithms-keeper bot 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.

@algorithms-keeper algorithms-keeper bot removed the require tests Tests [doctest/unittest/pytest] are required label Oct 2, 2023
cclauss
cclauss reviewed Oct 2, 2023
View reviewed changes
other/coordinate_compression.py
Comment on lines +51 to +60

"""

self.coordinate_map: dict[
int | float | str, int
] = {} # A dictionary to store compressed coordinates

self.reverse_map: list[int | float | str] = [-1] * (
len(arr)
) # A list to store reverse mapping
Copy link
Member

Choose a reason for hiding this comment

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

Please do not wrap lines for a comment.

Suggested change
"""
self.coordinate_map: dict[
int | float | str, int
] = {} # A dictionary to store compressed coordinates
self.reverse_map: list[int | float | str] = [-1] * (
len(arr)
) # A list to store reverse mapping
"""
# A dictionary to store compressed coordinates
self.coordinate_map: dict[int | float | str, int] = {}
# A list to store reverse mapping
self.reverse_map: list[int | float | str] = [-1] * len(arr)

other/coordinate_compression.py
-1
>>> cc.reverse_map[2] # Value not in the original list
83

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

other/coordinate_compression.py
3
>>> cc.compress(7) # Value not in the original list
-1

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

other/coordinate_compression.py
Initialize the CoordinateCompressor with a list.

Args:
arr (list): The list of values to be compressed.
Copy link
Member

Choose a reason for hiding this comment

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

Mypy can check the data types in the function signature but not in the comments.

Please do not repeat the data types in both places because readers will be confused if one changes but the other does not.

Suggested change
arr (list): The list of values to be compressed.
arr: The list of values to be compressed.

other/coordinate_compression.py
Compress a single value.

Args:
original (int | float | str) : The value to compress.
Copy link
Member

Choose a reason for hiding this comment

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

Mypy can check the data types in the function signature but not in the comments.

Please do not repeat the data types in both places because readers will be confused if one changes but the other does not.

Suggested change
original (int | float | str) : The value to compress.
original: The value to compress.

other/coordinate_compression.py
Decompress a single integer.

Args:
num (int): The compressed integer to decompress.
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
num (int): The compressed integer to decompress.
num: The compressed integer to decompress.

other/coordinate_compression.py
num (int): The compressed integer to decompress.

Returns:
original value (int | float | str) : The original value.
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
original value (int | float | str) : The original value.
The original value.

other/coordinate_compression.py
10
>>> cc.decompress(5) # Compressed coordinate out of range
-1

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

other/coordinate_compression.py
Original: 10, Compressed: 0
Original: 52, Compressed: 1
Original: 83, Compressed: 2
Original: 100, Compressed: 3
Copy link
Member

Choose a reason for hiding this comment

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

Just a thought... If this is ints on the left and ints on the right, how is a one-to-one mapping compressing anything? Would a dict be as efficient as a dict in this use case?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss cclauss left review comments

@algorithms-keeper algorithms-keeper[bot] algorithms-keeper[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
awaiting reviews This PR is ready to be reviewed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@om-ashish-soni @cclauss