Skip to content

[API docs] line_qubit api format. #5501

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

Merged
merged 2 commits into from
Jun 13, 2022
Merged

[API docs] line_qubit api format. #5501

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
565471d
[API docs] line_qubit api format.
MichaelBroughton Jun 13, 2022
4b36d02
Merge branch 'master' into line_qid
CirqBot Jun 13, 2022
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
30 changes: 19 additions & 11 deletions cirq-core/cirq/devices/line_qubit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,13 @@ def with_dimension(self, dimension: int) -> 'LineQid':
return LineQid(self.x, dimension)

def is_adjacent(self, other: 'cirq.Qid') -> bool:
"""Determines if two qubits are adjacent line qubits."""
"""Determines if two qubits are adjacent line qubits.

Args:
other: `cirq.Qid` to test for adjacency.

Returns: True iff other and self are adjacent.
"""
return isinstance(other, _BaseLineQid) and abs(self.x - other.x) == 1

def neighbors(self, qids: Optional[Iterable[ops.Qid]] = None) -> Set['_BaseLineQid']:
Expand Down Expand Up @@ -115,13 +121,14 @@ class LineQid(_BaseLineQid):
identifies the qids location on the line. `LineQid`s are ordered by
this integer.

One can construct new `LineQid`s by adding or subtracting integers:
One can construct new `cirq.LineQid`s by adding or subtracting integers:

>>> cirq.LineQid(1, dimension=2) + 3
cirq.LineQid(4, dimension=2)

>>> cirq.LineQid(1, dimension=2) + 3
cirq.LineQid(4, dimension=2)
>>> cirq.LineQid(2, dimension=3) - 1
cirq.LineQid(1, dimension=3)

>>> cirq.LineQid(2, dimension=3) - 1
cirq.LineQid(1, dimension=3)
"""

def __init__(self, x: int, dimension: int) -> None:
Expand Down Expand Up @@ -208,13 +215,14 @@ class LineQubit(_BaseLineQid):
identifies the qubits location on the line. LineQubits are ordered by
this integer.

One can construct new LineQubits by adding or subtracting integers:
One can construct new `cirq.LineQubit`s by adding or subtracting integers:

>>> cirq.LineQubit(1) + 3
cirq.LineQubit(4)

>>> cirq.LineQubit(1) + 3
cirq.LineQubit(4)
>>> cirq.LineQubit(2) - 1
cirq.LineQubit(1)

>>> cirq.LineQubit(2) - 1
cirq.LineQubit(1)
"""

@property
Expand Down