shiavm006 opened a new issue, #682: URL: https://github.com/apache/mahout/issues/682
Several useful `QuMat` methods exist in `qumat/qumat.py` but are not mentioned in `docs/api.md`, so users reading the API docs won’t discover them. Examples: `swap_test`, `measure_overlap`, `get_final_state_vector`, `apply_u_gate`, `apply_cswap_gate`. ### Steps to Reproduce 1. Open `docs/api.md` and look at the list of documented `QuMat` methods (init, basic gates, rotation gates, `execute_circuit`, `bind_parameters`, `_handle_parameter`, etc.). 2. Open `qumat/qumat.py` and scroll through the `QuMat` class. 3. Notice that methods like `swap_test`, `measure_overlap`, `get_final_state_vector`, `apply_u_gate`, `apply_cswap_gate` are implemented but never mentioned in `docs/api.md`. ### Expected Behavior The main API docs should list and briefly explain all important public `QuMat` methods, especially higher-level ones like: - `get_final_state_vector(self)` - `apply_u_gate(self, qubit_index, theta, phi, lambd)` - `apply_cswap_gate(self, ...)` - `swap_test(self, ancilla_qubit, qubit1, qubit2)` - `measure_overlap(self, qubit1, qubit2, ancilla_qubit=0)` ### Actual Behavior These methods are available in code (and used in tests), but they are missing from `docs/api.md`, making them easy to miss for users relying on the documentation. ### Screenshots or Logs Not required; the gap is visible by comparing `docs/api.md` with `qumat/qumat.py`. ### Environment - **OS:** Any - **Python Version:** 3.10+ - **Mahout/Qumat Version:** main - **Files:** `docs/api.md`, `qumat/qumat.py` ### Additional Context These are some of the most interesting features of Qumat (overlap, swap test, U-gate, state vector), so documenting them would make the library much more discoverable for new users. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
