docs: add MPS simulator documentation (fixes #1048)#1064
Open
Hadar01 wants to merge 5 commits intoquantumlib:mainfrom
Open
docs: add MPS simulator documentation (fixes #1048)#1064Hadar01 wants to merge 5 commits intoquantumlib:mainfrom
Hadar01 wants to merge 5 commits intoquantumlib:mainfrom
Conversation
- Add docs/mps.md: covers what MPS is, MPSStateSpace and MPSSimulator C++ APIs, current limitations, and a comparison table vs qsim/qsimh - Update docs/overview.md: mention MPS as a third simulator alongside qsim and qsimh, add it to the operations list - Update docs/_book.yaml: register mps.md in the Guides nav section Fixes quantumlib#1048
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request adds documentation for the Matrix Product State (MPS) simulator, including a new guide and updates to the navigation and overview files. The review feedback identifies that the C++ code examples in the documentation are missing required template arguments for the MPSStateSpace and MPSSimulator classes, which would cause compilation errors. Additionally, a potential buffer overflow was identified in the reduced density matrix example if double precision is used.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds docs/mps.md documenting the MPS simulator in lib/mps_simulator.h
and lib/mps_statespace.h, which had no documentation. Also updates
overview.md and _book.yaml to include it.
Fixes #1048