pyquil.quilatom module¶

Bases: BinaryExp

associates: ClassVar[str] = 'both'¶

static fn(a: Expression | int | float | complex, b: Expression | int | float | complex) → Add | int | float | complex[source]¶

operator: ClassVar[str] = ' + '¶

precedence: ClassVar[int] = 1¶

Bases: Expression

associates: ClassVar[str]¶

static fn(a: Expression | int | float | complex, b: Expression | int | float | complex) → BinaryExp | int | float | complex[source]¶

operator: ClassVar[str]¶

precedence: ClassVar[int]¶

Bases: BinaryExp

associates: ClassVar[str] = 'left'¶

static fn(a: Expression | int | float | complex, b: Expression | int | float | complex) → Div | int | float | complex[source]¶

operator: ClassVar[str] = '/'¶

precedence: ClassVar[int] = 2¶

class pyquil.quilatom.Expression[source]¶

Bases: object

Expression involving some unbound parameters. Parameters in Quil are represented as a label like ‘%x’ for the parameter named ‘x’. An example expression therefore may be ‘%x*(%y/4)’.

Expressions may also have function calls, supported functions in Quil are sin, cos, sqrt, exp, and cis.

This class overrides all the Python operators that are supported by Quil.

class pyquil.quilatom.FormalArgument(name: str)[source]¶

Bases: QuilAtom

Representation of a formal argument associated with a DEFCIRCUIT or DEFGATE … AS PAULI-SUM or DEFCAL form.

property index: NoReturn¶

out() → str[source]¶

class pyquil.quilatom.Frame(qubits: Sequence[Qubit | QubitPlaceholder | FormalArgument | int], name: str)[source]¶

Bases: FrameIdentifier

Representation of a frame descriptor.

out() → str[source]¶

property qubits: Tuple[Qubit | QubitPlaceholder | FormalArgument | int, ...]¶

Bases: Expression

Supported functions in Quil are sin, cos, sqrt, exp, and cis

class pyquil.quilatom.Label(label_name: str)[source]¶

Bases: QuilAtom

Representation of a label.

Parameters:: label_name – The label name.

property name: str¶

out() → str[source]¶

class pyquil.quilatom.LabelPlaceholder(prefix: str = 'L', *, placeholder: TargetPlaceholder | None = None)[source]¶

Bases: QuilAtom

out() → str[source]¶

property prefix: str¶

class pyquil.quilatom.MemoryReference(name: str, offset: int = 0, declared_size: int | None = None)[source]¶

Bases: QuilAtom, Expression

Representation of a reference to a classical memory address.

Parameters:

name – The name of the variable
offset – Everything in Quil is a C-style array, so every memory reference has an offset.
declared_size – The optional size of the named declaration. This can be used for bounds checking, but isn’t. It is used for pretty-printing to quil by deciding whether to output memory references with offset 0 as either e.g. ro[0] or beta depending on whether the declared variable is of length >1 or 1, resp.

out() → str[source]¶

Bases: BinaryExp

associates: ClassVar[str] = 'both'¶

static fn(a: Expression | int | float | complex, b: Expression | int | float | complex) → Mul | int | float | complex[source]¶

operator: ClassVar[str] = '*'¶

precedence: ClassVar[int] = 2¶

class pyquil.quilatom.Parameter(name: str)[source]¶

Bases: QuilAtom, Expression

Parameters in Quil are represented as a label like ‘%x’ for the parameter named ‘x’.

out() → str[source]¶

Bases: BinaryExp

associates: ClassVar[str] = 'right'¶

static fn(a: Expression | int | float | complex, b: Expression | int | float | complex) → Pow | int | float | complex[source]¶

operator: ClassVar[str] = '^'¶

precedence: ClassVar[int] = 3¶

class pyquil.quilatom.Qubit(index: int)[source]¶

Bases: QuilAtom

Representation of a qubit.

Parameters:: index – Index of the qubit.

out() → str[source]¶

class pyquil.quilatom.QubitPlaceholder(placeholder: QubitPlaceholder | None = None)[source]¶

Bases: QuilAtom

property index: NoReturn¶

out() → str[source]¶

static register(n: int) → List[QubitPlaceholder][source]¶

Return a ‘register’ of n QubitPlaceholders.

>>> from pyquil import Program
>>> from pyquil.gates import H
>>> from pyquil.quil import address_qubits
>>> from pyquil.quilatom import QubitPlaceholder
>>> qs = QubitPlaceholder.register(8) # a qubyte
>>> prog = Program(H(q) for q in qs)
>>> address_qubits(prog).out()
'H 0\nH 1\nH 2\nH 3\nH 4\nH 5\nH 6\nH 7\n'
>>>

The returned register is a Python list of QubitPlaceholder objects, so all normal list semantics apply.

Parameters:: n – The number of qubits in the register

class pyquil.quilatom.QuilAtom[source]¶

Bases: object

Abstract class for atomic elements of Quil.

out() → str[source]¶

Bases: BinaryExp

associates: ClassVar[str] = 'left'¶

static fn(a: Expression | int | float | complex, b: Expression | int | float | complex) → Sub | int | float | complex[source]¶

operator: ClassVar[str] = ' - '¶

precedence: ClassVar[int] = 1¶

Bases: WaveformInvocation, QuilAtom

NAME: ClassVar[str]¶

property duration: Expression | MemoryReference | int | float | complex | number | None¶

get_parameter(name: str) → Expression | MemoryReference | int | float | complex | number | None[source]¶

num_samples(rate: float) → int[source]¶

The number of samples in the reference implementation of the waveform.

Note: this does not include any hardware-enforced alignment (cf. documentation for samples).

Parameters:: rate – The sample rate, in Hz.
Returns:: The number of samples.

out() → str[source]¶

samples(rate: float) → ndarray[source]¶

A reference implementation of waveform sample generation.

Note: this is close but not always exactly equivalent to the actual IQ values produced by the waveform generators on Rigetti hardware. The actual ADC process imposes some alignment constraints on the waveform duration (in particular, it must be compatible with the clock rate).

Parameters:: rate – The sample rate, in Hz.
Returns:: An array of complex samples.

set_parameter(name: str, value: Expression | MemoryReference | int | float | complex | number | None) → None[source]¶

Bases: WaveformInvocation, QuilAtom

out() → str[source]¶

property parameters: Dict[str, Expression | MemoryReference | int | float | complex | number]¶

class pyquil.quilatom.WaveformReference(*args, **kwargs)[source]¶

Bases: WaveformInvocation

Representation of a Waveform reference.

Deprecated since version 4.0: The WaveformReference class will be removed, consider using WaveformInvocation instead.

Formats a particular parameter. Essentially the same as built-in formatting except using ‘i’ instead of ‘j’ for the imaginary number.

Parameters:: element – The parameter to format for Quil output.

Deprecated since version 4.0: This function has been superseded by the quil package and will be removed soon.

pyquil.quilatom.qubit_index(qubit: Qubit | QubitPlaceholder | FormalArgument | int) → int[source]¶

Get the index of a QubitDesignator.

Parameters:: qubit – the qubit designator.
Returns:: An int that is the qubit index.

pyquil.quilatom.quil_cis(expression: Expression | int | float | complex) → Function[source]¶

pyquil.quilatom.quil_cos(expression: Expression | int | float | complex) → Function[source]¶

pyquil.quilatom.quil_exp(expression: Expression | int | float | complex) → Function[source]¶

pyquil.quilatom.quil_sin(expression: Expression | int | float | complex) → Function[source]¶

pyquil.quilatom.quil_sqrt(expression: Expression | int | float | complex) → Function[source]¶

Using a dictionary of substitutions d, try and explicitly evaluate as much of expr as possible. This supports substitution of both parameters and memory references. Each memory reference must be individually assigned a value at each memory offset to be substituted.

Parameters:

expr – The expression whose parameters or memory references are to be substituted.
d – Numerical substitutions for parameters or memory references.

Returns:

A partially simplified Expression, or a number.

pyquil.quilatom.substitute_array(a: Sequence[Expression] | ndarray, d: Mapping[Parameter | MemoryReference, int | float | complex]) → ndarray[source]¶

Apply substitute to all elements of an array a and return the resulting array.

Parameters:

a – The array of expressions whose parameters or memory references are to be substituted.
d – Numerical substitutions for parameters or memory references, for all array elements.

Returns:

An array of partially substituted Expressions, or numbers.

pyquil.quilatom.unpack_classical_reg(c: MemoryReference | MemoryReference | Tuple[str, int] | List[Any] | str) → MemoryReference[source]¶

Get the address for a classical register.

Parameters:: c – A list of length 2, a pair, a string (to be interpreted as name[0]), or a MemoryReference.
Returns:: The address as a MemoryReference.

Get a qubit from an object.

Parameters:: qubit – the qubit designator to unpack.
Returns:: A Qubit or QubitPlaceholder instance