cirq.NamedQubit

A qubit identified by name.

Inherits From: Qid

cirq.NamedQubit(
    name: str
) -> None

Used in the notebooks

Used in the tutorials

By default, NamedQubit has a lexicographic order. However, numbers within the name are handled correctly. So, for example, if you print a circuit containing cirq.NamedQubit('qubit22') and cirq.NamedQubit('qubit3'), the wire for 'qubit3' will correctly come before 'qubit22'.

dimension Returns the dimension or the number of quantum levels this qid has. E.g. 2 for a qubit, 3 for a qutrit, etc.
name

Methods

range

View source

@staticmethod
range(
    *args, prefix: str
) -> List['NamedQubit']

Returns a range of cirq.NamedQubits.

The range returned starts with the prefix, and followed by a qubit for each number in the range, e.g.:

<pre class="devsite-click-to-copy prettyprint lang-py">
<code class="devsite-terminal" data-terminal-prefix="&gt;&gt;&gt;">cirq.NamedQubit.range(3, prefix=&#x27;a&#x27;)</code>
<code class="devsite-terminal" data-terminal-prefix="..."># doctest: +NORMALIZE_WHITESPACE</code>
<code class="no-select nocode">    [cirq.NamedQubit(&#x27;a0&#x27;), cirq.NamedQubit(&#x27;a1&#x27;),</code>
<code class="no-select nocode">        cirq.NamedQubit(&#x27;a2&#x27;)]</code>
<code class="devsite-terminal" data-terminal-prefix="&gt;&gt;&gt;">cirq.NamedQubit.range(2, 4, prefix=&#x27;a&#x27;)</code>
<code class="no-select nocode">    [cirq.NamedQubit(&#x27;a2&#x27;), cirq.NamedQubit(&#x27;a3&#x27;)]</code>
<code class="no-select nocode">    </code>
</pre>

Args
*args Args to be passed to Python's standard range function.
prefix A prefix for constructed NamedQubits.

Returns
A list of NamedQubit\s.

validate_dimension

View source

@staticmethod
validate_dimension(
    dimension: int
) -> None

Raises an exception if dimension is not positive.

Raises
ValueError dimension is not positive.

with_dimension

View source

with_dimension(
    dimension: int
) -> 'NamedQid'

Returns a new qid with a different dimension.

Child classes can override. Wraps the qubit object by default.

Args
dimension The new dimension or number of levels.

__eq__

View source

__eq__(
    other
)

Return self==value.

__ge__

View source

__ge__(
    other
)

Return self>=value.

__gt__

View source

__gt__(
    other
)

Return self>value.

__le__

View source

__le__(
    other
)

Return self<=value.

__lt__

View source

__lt__(
    other
)

Return self<value.

__ne__

View source

__ne__(
    other
)

Return self!=value.