Using PennyLane

Release news

Development

API

Internals

  1. Docs
  2. qml.labs
  3. qml.labs.resource_estimation
  4. qml.labs.resource_estimation.ResourceOutOfPlaceSquare

qml.labs.resource_estimation.ResourceOutOfPlaceSquare

class ResourceOutOfPlaceSquare(register_size, wires=None)[source]

Bases: ResourceOperator

Resource class for the OutofPlaceSquare gate.

This operation takes two quantum registers. The input register is of size register_size and the output register of size 2 * register_size. The number encoded in the input is squared and returned in the output register.

Parameters:

  • register_size (int) – the size of the input register

  • wires (Sequence[int], optional) – the wires the operation acts on

Resources:

The resources are obtained from appendix G, lemma 7 in PRX Quantum, 2, 040332 (2021). Specifically, the resources are given as \((n - 1)^2\) Toffoli gates, and \(n\) CNOT gates.

Example

The resources for this operation are computed using:

>>> out_square = plre.ResourceOutOfPlaceSquare(register_size=3)
>>> print(plre.estimate_resources(out_square))
--- Resources: ---
Total qubits: 9
Total gates : 7
Qubit breakdown:
 clean qubits: 0, dirty qubits: 0, algorithmic qubits: 9
Gate breakdown:
 {'Toffoli': 4, 'CNOT': 3}

num_wires

resource_keys

resource_params

Returns a dictionary containing the minimal information needed to compute the resources.
num_wires = 0
resource_keys = {'register_size'}
resource_params

Returns a dictionary containing the minimal information needed to compute the resources.

Returns:

A dictionary containing the resource parameters:

  • register_size (int): the size of the input register

Return type:

dict

adjoint_resource_decomp(*args, **kwargs)

Returns a list of actions that define the resources of the operator.

controlled_resource_decomp(...)

Returns a list representing the resources for a controlled version of the operator.

default_adjoint_resource_decomp(*args, **kwargs)

Returns a list representing the resources for the adjoint of the operator.

default_controlled_resource_decomp(...)

Returns a list representing the resources for a controlled version of the operator.

default_pow_resource_decomp(pow_z, *args, ...)

Returns a list representing the resources for an operator raised to a power.

default_resource_decomp(register_size, **kwargs)

Returns a dictionary representing the resources of the operator.

dequeue(op_to_remove[, context])

Remove the given resource operator(s) from the Operator queue.

pow_resource_decomp(pow_z, *args, **kwargs)

Returns a list representing the resources for an operator raised to a power.

queue([context])

Append the operator to the Operator queue.

resource_decomp(*args, **kwargs)

Returns a list of actions that define the resources of the operator.

resource_rep(register_size)

Returns a compressed representation containing only the parameters of the Operator that are needed to compute a resource estimation.

resource_rep_from_op()

Returns a compressed representation directly from the operator

set_resources(new_func[, override_type])

Set a custom function to override the default resource decomposition.

tracking_name(*args, **kwargs)

Returns a name used to track the operator during resource estimation.

tracking_name_from_op()

Returns the tracking name built with the operator's parameters.
classmethod adjoint_resource_decomp(*args, **kwargs)

Returns a list of actions that define the resources of the operator.

classmethod controlled_resource_decomp(ctrl_num_ctrl_wires, ctrl_num_ctrl_values, *args, **kwargs)

Returns a list representing the resources for a controlled version of the operator.

Parameters:

  • ctrl_num_ctrl_wires (int) – the number of qubits the operation is controlled on

  • ctrl_num_ctrl_values (int) – the number of control qubits, that are controlled when in the \(|0\rangle\) state

classmethod default_adjoint_resource_decomp(*args, **kwargs)

Returns a list representing the resources for the adjoint of the operator.

classmethod default_controlled_resource_decomp(ctrl_num_ctrl_wires, ctrl_num_ctrl_values, *args, **kwargs)

Returns a list representing the resources for a controlled version of the operator.

Parameters:

  • ctrl_num_ctrl_wires (int) – the number of qubits the operation is controlled on

  • ctrl_num_ctrl_values (int) – the number of control qubits, that are controlled when in the \(|0\rangle\) state

classmethod default_pow_resource_decomp(pow_z, *args, **kwargs)

Returns a list representing the resources for an operator raised to a power.

Parameters:

pow_z (int) – exponent that the operator is being raised to

classmethod default_resource_decomp(register_size, **kwargs)[source]

Returns a dictionary representing the resources of the operator. The keys are the operators and the associated values are the counts.

Parameters:

register_size (int) – the size of the input register

Resources:

The resources are obtained from appendix G, lemma 7 in PRX Quantum, 2, 040332 (2021). Specifically, the resources are given as \((n - 1)^2\) Toffoli gates, and \(n\) CNOT gates.

Returns:

A list of GateCount objects, where each object represents a specific quantum gate and the number of times it appears in the decomposition.

Return type:

list[GateCount]

static dequeue(op_to_remove, context=<class 'pennylane.queuing.QueuingManager'>)

Remove the given resource operator(s) from the Operator queue.

classmethod pow_resource_decomp(pow_z, *args, **kwargs)

Returns a list representing the resources for an operator raised to a power.

Parameters:

pow_z (int) – exponent that the operator is being raised to

queue(context=<class 'pennylane.queuing.QueuingManager'>)

Append the operator to the Operator queue.

classmethod resource_decomp(*args, **kwargs)

Returns a list of actions that define the resources of the operator.

classmethod resource_rep(register_size)[source]

Returns a compressed representation containing only the parameters of the Operator that are needed to compute a resource estimation.

Parameters:

register_size (int) – the size of the input register

Returns:

the operator in a compressed representation

Return type:

CompressedResourceOp

resource_rep_from_op()

Returns a compressed representation directly from the operator

classmethod set_resources(new_func, override_type='base')

Set a custom function to override the default resource decomposition.

This method allows users to replace any of the resource_decomp, adjoint_resource_decomp, ctrl_resource_decomp, or pow_resource_decomp methods globally for every instance of the class.

classmethod tracking_name(*args, **kwargs)

Returns a name used to track the operator during resource estimation.

tracking_name_from_op()

Returns the tracking name built with the operator’s parameters.

Previous
Next