Clarify Qubit state descriptions and aliases#174
Clarify Qubit state descriptions and aliases#174sotashimozono wants to merge 8 commits intoITensor:mainfrom
Conversation
Key changes: Fixed incorrect eigenvalues for $\sigma_x$ and $\sigma_y$ eigenvectors. Added a code example for state to match the format of the "Operator" section. Clarified that "0" and "1" states are eigenvectors of $\sigma_z$ for consistency.
|
Just a trivial Documentation Issue. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #174 +/- ##
=======================================
Coverage 90.31% 90.31%
=======================================
Files 54 54
Lines 3605 3605
=======================================
Hits 3256 3256
Misses 349 349
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Thanks for catching the issue and for the suggested changes. I think the changes mostly look good, except for one which I commented on above. |
|
thanks, let me think about the changes. |
Added general usage examples for site types and clarified the creation of site indices, states, and operators. Removed redundant examples for Qubit states.
|
Thanks for the feedback! I've added the general examples for siteind, state, and op at the beginning of the file so we don't have to repeat them everywhere. For the individual sections, what do you think about the existing code snippets? I'm happy to delete them to avoid duplication, though I'd prefer to keep the scope of this PR manageable unless you feel strongly about a full cleanup. Let me know your thoughts. |
Key changes:
Description
While reviewing the documentation, I noticed that some eigenvalues for the "Qubit" states were inverted, so I have corrected them.$\sigma_z$ to align with the descriptions of the other bases.Please feel free to adjust or remove any parts you find redundant.
To improve consistency with the "Operator" section and make the guide more practical, I have added a brief code example showing how to prepare states using the state function. Additionally, I explicitly mentioned that the "0" and "1" states are eigenvectors of
How Has This Been Tested?
I checked each alias itself works consistently, and documents had mistakes.
So, I only fixed markdown file.
Checklist:
using JuliaFormatter; format(".")in the base directory of the repository (~/.julia/dev/ITensorMPS) to format your code according to our style guidelines.