Skip to content
This repository was archived by the owner on Sep 9, 2025. It is now read-only.

[m3] Add performance notes to Keccak lookedup implementation#812

Open
HiddenAndBound wants to merge 1 commit intomainfrom
improve_keccak_lookups_docs
Open

[m3] Add performance notes to Keccak lookedup implementation#812
HiddenAndBound wants to merge 1 commit intomainfrom
improve_keccak_lookups_docs

Conversation

@HiddenAndBound
Copy link
Contributor

@HiddenAndBound HiddenAndBound commented Jun 18, 2025

TL;DR

Add documentation to clarify that the lookedup Keccak implementation is primarily for benchmarking purposes, not for production use.

What changed?

  • Added a note at the module level indicating that the lookedup implementation serves primarily as a proxy to measure lookup performance characteristics
  • Added a performance note to the Keccakf struct documentation recommending the stacked version for production use
  • Added detailed comments to the Chi step implementation explaining how the AND operation works with lookups and how the merged values are used for lookup tables

How to test?

No functional changes were made, so no testing is required. The documentation can be verified by reviewing the updated comments in the code.

Why make this change?

This change helps users understand the intended purpose of the lookedup Keccak implementation and guides them toward using the more performant stacked version for production use cases. The additional comments also make the code more maintainable by explaining the purpose of the lookup-based AND operation and how the merged values are constructed for the lookup table.

@HiddenAndBound HiddenAndBound changed the title improved keccak lookups docs [m3] Add performance notes to Keccak lookedup implementation Jun 18, 2025
Copy link
Contributor Author


How to use the Graphite Merge Queue

Add the label merge-ready to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@HiddenAndBound HiddenAndBound marked this pull request as ready for review June 18, 2025 10:52
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants