qml.labs.resource_estimation.ResourceChangeBasisOp¶
- class ResourceChangeBasisOp(compute_op, base_op, uncompute_op=None, wires=None)[source]¶
Bases:
ResourceOperator
Change of Basis resource operator.
A symbolic class used to represent a change of basis operation. This is a special type of operator which can be expressed as \(\hat{U}_{compute} \cdot \hat{V} \cdot \hat{U}_{uncompute}\). If no
uncompute_op
is provided then the adjoint of thecompute_op
is used by default.- Parameters:
compute_op (ResourceOperator) – A resource operator representing the basis change operation.
base_op (ResourceOperator) – A resource operator representing the base operation.
uncompute_op (ResourceOperator, optional) – An optional resource operator representing the inverse of the basis change operation.
wires (Sequence[int], optional) – the wires the operation acts on
- Resources:
This symbolic class represents a product of the three provided operations. The resources are defined trivially as the sum of the costs of each.
See also
Example
Note, each operation in the product must be a valid
ResourceOperator
The change of basis operation can be constructed as follows:>>> compute_u = plre.ResourceS() >>> base_v = plre.ResourceZ() >>> cb_op = plre.ResourceChangeBasisOp(compute_u, base_v) >>> print(plre.estimate_resources(cb_op, gate_set={"Z", "S", "Adjoint(S)"})) --- Resources: --- Total qubits: 1 Total gates : 3 Qubit breakdown: clean qubits: 0, dirty qubits: 0, algorithmic qubits: 1 Gate breakdown: {'S': 1, 'Z': 1, 'Adjoint(S)': 1}
We can also set the
uncompute_op
directly.>>> uncompute_u = plre.ResourceProd([plre.ResourceZ(), plre.ResourceS()]) >>> cb_op = plre.ResourceChangeBasisOp(compute_u, base_v, uncompute_u) >>> print(plre.estimate_resources(cb_op, gate_set={"Z", "S", "Adjoint(S)"})) --- Resources: --- Total qubits: 1 Total gates : 4 Qubit breakdown: clean qubits: 0, dirty qubits: 0, algorithmic qubits: 1 Gate breakdown: {'S': 2, 'Z': 2}
Attributes
Returns a dictionary containing the minimal information needed to compute the resources.
- num_wires = 0¶
- resource_keys = {'cmpr_base_op', 'cmpr_compute_op', 'cmpr_uncompute_op'}¶
- resource_params¶
Returns a dictionary containing the minimal information needed to compute the resources.
- Returns:
A dictionary containing the resource parameters: * cmpr_compute_op (CompressedResourceOp): A compressed resource operator, corresponding to the compute operation. * cmpr_base_op (CompressedResourceOp): A compressed resource operator, corresponding to the base operation. * cmpr_uncompute_op (CompressedResourceOp): A compressed resource operator, corresponding to the uncompute operation.
- Return type:
dict
Methods
adjoint_resource_decomp
(*args, **kwargs)Returns a list of actions that define the resources of the operator.
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.
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
(cmpr_compute_op, ...)Returns a list 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
(ops_to_remove[, 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
(cmpr_compute_op, cmpr_base_op)Returns a compressed representation containing only the parameters of the Operator that are needed to estimate the resources.
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.
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(cmpr_compute_op, cmpr_base_op, cmpr_uncompute_op, **kwargs)[source]¶
Returns a list representing the resources of the operator. Each object represents a quantum gate and the number of times it occurs in the decomposition.
- Parameters:
cmpr_compute_op (CompressedResourceOp) – A compressed resource operator, corresponding to the compute operation.
cmpr_base_op (CompressedResourceOp) – A compressed resource operator, corresponding to the base operation.
cmpr_uncompute_op (CompressedResourceOp) – A compressed resource operator, corresponding to the uncompute operation.
- Resources:
This symbolic class represents a product of the three provided operations. The resources are defined trivially as the sum of the costs of each.
See also
Example
Note, each operation in the product must be a valid
ResourceOperator
The change of basis operation can be constructed as follows:>>> compute_u = plre.ResourceS() >>> base_v = plre.ResourceZ() >>> cb_op = plre.ResourceChangeBasisOp(compute_u, base_v) >>> print(plre.estimate_resources(cb_op, gate_set={"Z", "S", "Adjoint(S)"})) --- Resources: --- Total qubits: 1 Total gates : 3 Qubit breakdown: clean qubits: 0, dirty qubits: 0, algorithmic qubits: 1 Gate breakdown: {'S': 1, 'Z': 1, 'Adjoint(S)': 1}
We can also set the
uncompute_op
directly.>>> uncompute_u = plre.ResourceProd([plre.ResourceZ(), plre.ResourceS()]) >>> cb_op = plre.ResourceChangeBasisOp(compute_u, base_v, uncompute_u) >>> print(plre.estimate_resources(cb_op, gate_set={"Z", "S", "Adjoint(S)"})) --- Resources: --- Total qubits: 1 Total gates : 4 Qubit breakdown: clean qubits: 0, dirty qubits: 0, algorithmic qubits: 1 Gate breakdown: {'S': 2, 'Z': 2}
- 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(ops_to_remove, context=<class 'pennylane.queuing.QueuingManager'>)[source]¶
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(cmpr_compute_op, cmpr_base_op, cmpr_uncompute_op=None)[source]¶
Returns a compressed representation containing only the parameters of the Operator that are needed to estimate the resources.
- Parameters:
cmpr_compute_op (CompressedResourceOp) – A compressed resource operator, corresponding to the compute operation.
cmpr_base_op (CompressedResourceOp) – A compressed resource operator, corresponding to the base operation.
cmpr_uncompute_op (CompressedResourceOp) – A compressed resource operator, corresponding to the uncompute operation.
- Returns:
the operator in a compressed representation
- Return type:
- 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.