Python icon indicating copy to clipboard operation
Python copied to clipboard

Adding multibit-manipulation algorithm implemented with bitwise operations

Open billbreit opened this issue 1 year ago • 1 comments

Describe your change:

  • [x ] 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:

  • [ x] I have read CONTRIBUTING.md.
  • [x ] This pull request is all my own work -- I have not plagiarized.
  • [x ] I know that pull requests will not be merged if they fail the automated tests.
  • [ x] This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • [x ] All new Python files are placed inside an existing directory.
  • [x ] All filenames are in all lowercase characters with no spaces or dashes.
  • [ x] All functions and variable names follow Python naming conventions.
  • [x ] All function parameters and return values are annotated with Python type hints.
  • [ x] All functions have doctests that pass the automated testing.
  • [x ] 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".

billbreit avatar May 28 '24 23:05 billbreit

I think I have multibit-manipulation.py debugged and ready for review. Do you have any suggestions ? Does the module name really describe what it does ? Are the comments unclear or too long ?

All the parenthesis in the multi-bit functions are complicated, but they run measurably faster on a Raspberry Pi Pico as a single statement. No garbage collection of course ( especially in 264K ), but Python seems to optimize these constructions beyond just saving memory and reference scavenging. After working with them, I find them readable in a straightforward left-right manner. Kind of harking back to the bit buffers of yesteryear, except they implemented it with hardware.

I had a problem with Ruff on my client workstation. There were many validation it didn't check. Is there a TOML configuration file I can use to match my Ruff to yours ?

  • Bill

billbreit avatar Jun 01 '24 17:06 billbreit