Description
I found that many functions have already been completed.
Please feel free to let me know if I missed any.
The functions that have been checked are:
| Method Name |
Documentation Status |
Notes |
apply_cswap_gate() |
❌ Missing Docs |
Implemented in all backends |
apply_u_gate() |
❌ Missing Docs |
Implemented in all backends |
swap_test() |
❌ Missing Docs |
Has complete tests |
measure_overlap() |
❌ Missing Docs |
Has complete tests |
bind_parameters() |
❌ Missing Docs |
Required for parameterized circuits |
execute_circuit() |
⚠️ Partial docs |
Has basic description, missing result format docs |
apply_rx_gate() |
⚠️ Partial docs |
Has basic description, missing detailed examples |
apply_ry_gate() |
⚠️ Partial docs |
Has basic description, missing detailed examples |
apply_rz_gate() |
⚠️ Partial docs |
Has basic description, missing detailed examples |
draw() |
⚠️ Partial docs |
Docs say pass through, but actually implemented |
get_final_state_vector() |
❌ Missing Docs |
Marked as for testing |
calculate_prob_zero() |
❌ Missing Docs |
Backend-specific method |
__init__() |
⚠️ Partial docs |
Has basic description, missing detailed config examples |
create_empty_circuit() |
✅ Has docs |
Documentation complete |
apply_not_gate() |
✅ Has docs |
In basic_gates.md |
apply_hadamard_gate() |
✅ Has docs |
In basic_gates.md |
apply_cnot_gate() |
✅ Has docs |
In basic_gates.md |
apply_toffoli_gate() |
✅ Has docs |
In basic_gates.md |
apply_swap_gate() |
✅ Has docs |
In basic_gates.md |
apply_pauli_x_gate() |
✅ Has docs |
In basic_gates.md |
apply_pauli_y_gate() |
✅ Has docs |
In basic_gates.md |
apply_pauli_z_gate() |
✅ Has docs |
In basic_gates.md |
_ensure_circuit_initialized() |
❌ Internal method |
Optional documentation |
Location of the Issue
Suggested Improvement
We should add documents for them.
Additional Context
Description
I found that many functions have already been completed.
Please feel free to let me know if I missed any.
The functions that have been checked are:
apply_cswap_gate()apply_u_gate()swap_test()measure_overlap()bind_parameters()execute_circuit()apply_rx_gate()apply_ry_gate()apply_rz_gate()draw()get_final_state_vector()calculate_prob_zero()__init__()create_empty_circuit()apply_not_gate()apply_hadamard_gate()apply_cnot_gate()apply_toffoli_gate()apply_swap_gate()apply_pauli_x_gate()apply_pauli_y_gate()apply_pauli_z_gate()_ensure_circuit_initialized()Location of the Issue
Suggested Improvement
We should add documents for them.
Additional Context