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

Missing implementation descriptions in readme #379

Open
e-shreve-ti opened this issue Feb 7, 2025 · 1 comment
Open

Missing implementation descriptions in readme #379

e-shreve-ti opened this issue Feb 7, 2025 · 1 comment

Comments

@e-shreve-ti
Copy link

The README.md for the project doesn't describe the following implementations:

  • mf4speed
  • mf4stack
  • m4speed
  • m4stack
  • mem_opt

The first four are somewhat self-explanatory (I'm assuming 'speed' is optimized for speed and 'stack' for RAM usage), but it would be nice to have references/information on what optimizations have been done.

@mkannwischer
Copy link
Contributor

the last one is a memory optimized C implementation. Feel free to open a PR to the README to clarify.

We commonly document implementations through pull request descriptions. Those usually include links to papers, but I agree that it can be tedious to trace through the long chain of papers. A text file per implementation containing the relevant references would be nice. I won't have time to create that any time soon unfortunately.

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

No branches or pull requests

2 participants