qml.estimator

This module contains tools for logical resource estimation.

Resource Estimation Functions:

estimate(workflow[, gate_set, zeroed, ...])

Estimate the quantum resources required by a circuit or operator with respect to a given gateset.

resource_rep(resource_op[, resource_params])

Produce a compressed representation of the resource operator to be used when tracking resources.

Resource Estimation Base Classes:

Resources(zeroed[, any_state, algo_wires, ...])

A container for the resources used throughout a quantum circuit.

ResourceOperator(*args[, wires])

Base class to represent quantum operators according to the fundamental set of information required for resource estimation.

CompressedResourceOp(op_type, num_wires[, ...])

Defines a lightweight class corresponding to the operator type and its parameters.

GateCount(gate[, count])

A class to represent a gate and its number of occurrences in a circuit or decomposition.

ResourceConfig()

A container to track the configuration for precisions and custom decompositions for the resource estimation pipeline.

Qubit Management Classes:

Allocate(num_wires)

Allows allocation of work wires through WireResourceManager.

Deallocate(num_wires)

Allows freeing any_state work wires through WireResourceManager.

WireResourceManager(zeroed[, any_state, ...])

Manages and tracks the auxiliary and algorithmic wires used in a quantum circuit.

Resource Operators:

Adjoint(base_op)

Resource class for the symbolic Adjoint operation.

CCZ([wires])

Resource class for the CCZ gate.

CH([wires])

Resource class for the CH gate.

CNOT([wires])

Resource class for the CNOT gate.

CRX([precision, wires])

Resource class for the CRX gate.

CRY([precision, wires])

Resource class for the CRY gate.

CRZ([precision, wires])

Resource class for the CRZ gate.

CRot([precision, wires])

Resource class for the CRot gate.

CSWAP([wires])

Resource class for the CSWAP gate.

CY([wires])

Resource class for the CY gate.

CZ([wires])

Resource class for the CZ gate.

ChangeOpBasis(compute_op, target_op[, ...])

Change of Basis resource operator.

Controlled(base_op, num_ctrl_wires, ...[, wires])

Resource class for the symbolic Controlled operation.

ControlledPhaseShift([precision, wires])

Resource class for the ControlledPhaseShift gate.

GlobalPhase([wires])

Resource class for the GlobalPhase gate.

Hadamard([wires])

Resource class for the Hadamard gate.

Identity([wires])

Resource class for the Identity gate.

MultiControlledX(num_ctrl_wires, num_zero_ctrl)

Resource class for the MultiControlledX gate.

MultiRZ(num_wires[, precision, wires])

Resource class for the MultiRZ gate.

PauliRot(pauli_string[, precision, wires])

Resource class for the PauliRot gate.

PhaseShift([precision, wires])

Resource class for the PhaseShift gate.

Pow(base_op, pow_z)

Resource class for the symbolic Pow operation.

Prod(res_ops[, wires])

Resource class for the symbolic Prod operation.

RX([precision, wires])

Resource class for the RX gate.

RY([precision, wires])

Resource class for the RY gate.

RZ([precision, wires])

Resource class for the RZ gate.

Rot([precision, wires])

Resource class for the Rot gate.

S([wires])

Resource class for the S-gate.

SWAP([wires])

Resource class for the SWAP gate.

SingleExcitation([precision, wires])

Resource class for the SingleExcitation gate.

T([wires])

Resource class for the T-gate.

TemporaryAND([wires])

Resource class representing a TemporaryAND gate.

Toffoli([elbow, wires])

Resource class for the Toffoli gate.

X([wires])

Resource class for the X-gate.

Y([wires])

Resource class for the Y-gate.

Z([wires])

Resource class for the Z-gate.

Contents

Using PennyLane

Release news

Development

API

Internals