qml.labs.resource_estimation.ResourceSemiAdder

class ResourceSemiAdder(max_register_size, wires=None)

Bases: ResourceOperator

Resource class for the SemiOutAdder gate.

Parameters:

• max_register_size (int) – the size of the larger of the two registers being added together

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

Resources:

The resources are obtained from figures 1 and 2 in Gidney (2018).

See also

SemiAdder

Example

The resources for this operation are computed using:

>>> semi_add = plre.ResourceSemiAdder(max_register_size=4)
>>> print(plre.estimate_resources(semi_add))
--- Resources: ---
Total qubits: 11
Total gates : 30
Qubit breakdown:
 clean qubits: 3, dirty qubits: 0, algorithmic qubits: 8
Gate breakdown:
 {'CNOT': 18, 'Toffoli': 3, 'Hadamard': 9}

Attributes

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

num_wires = 0

resource_keys = {'max_register_size'}

resource_params

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

Returns:

A dictionary containing the resource parameters:

• max_register_size (int): the size of the larger of the two registers being added together

Return type:

dict

Methods

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 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(max_register_size, ...)	Returns a dictionary representing the resources of the operator.
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(max_register_size)	Returns a compressed representation containing only the parameters of the Operator that are needed to compute the resources.
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, max_register_size, **kwargs)

Returns a list representing the resources of the operator. Each object in the list represents a gate and the number of times it occurs in the circuit.

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

• max_register_size (int) – the size of the larger of the two registers being added together

Resources:

The resources are obtained from figure 4a in Gidney (2018).

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]

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(max_register_size, **kwargs)

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

Parameters:

max_register_size (int) – the size of the larger of the two registers being added together

Resources:

The resources are obtained from figures 1 and 2 in Gidney (2018).

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]

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(max_register_size)

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

Parameters:

max_register_size (int) – the size of the larger of the two registers being added together

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.

code/api/api/pennylane.labs.resource_estimation.ResourceSemiAdder

 

Download Python script

 

Download Notebook

 

View on GitHub