Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Typo in docstring #283

Merged
merged 2 commits into from
Oct 17, 2023
Merged

Fix: Typo in docstring #283

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2b473e
Fix docstrings for cost_1q_angles, cost_2q_angles and mixer_1q_angles…
madhubanimayank Sep 13, 2023
0315a66
Merge remote-tracking branch 'origin/dev' into pr/283
KilianPoirier Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 10 additions & 11 deletions src/openqaoa-core/openqaoa/qaoa_components/variational_parameters/variational_baseparams.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,36 +62,35 @@ def __str__(self):
def mixer_1q_angles(self) -> np.ndarray:
"""2D array with the X-rotation angles.

1st index goes over p and the 2nd index over the qubits to
apply X-rotations on.
1st index goes over p and the 2nd index over the qubits,
to apply X-rotations on.
"""
raise NotImplementedError()

@property
def mixer_2q_angles(self) -> np.ndarray:
"""2D array with the X-rotation angles.
"""2D array with the XX and YY-rotation angles.

1st index goes over p and the 2nd index over the qubits to
apply X-rotations on.
1st index goes over p and the 2nd index over the qubit pairs,
to apply XX and YY-rotations on.
"""
raise NotImplementedError()

@property
def cost_1q_angles(self) -> np.ndarray:
"""2D array with the ZZ-rotation angles.
"""2D array with the Z-rotation angles.

1st index goes over the p and the 2nd index over the qubit
pairs, to apply ZZ-rotations on.
1st index goes over the p and the 2nd index over the qubits,
to apply Z-rotations on.
"""
raise NotImplementedError()

@property
def cost_2q_angles(self) -> np.ndarray:
"""2D array with Z-rotation angles.
"""2D array with ZZ-rotation angles.

1st index goes over the p and the 2nd index over the qubit
pairs, to apply Z-rotations on. These are needed by
``qaoa.cost_function.make_qaoa_memory_map``
pairs, to apply ZZ-rotations on.
"""
raise NotImplementedError()

Expand Down