CustomF2QLayout

class CustomF2QLayout

Bases: AnalysisPass

Sets the user-provided F2QLayout in the transpiler.

This pass simply populates the f2q_layout field of the property_set, with the value of layout.

Note

It is the user’s responsibility to ensure that subsequently used transpilation passes (and plugins) are configured to adhere to this F2QLayout correctly.

Attributes

layout: F2QLayout

The user-provided mapping of FermionRegister to QuantumRegister.

Inherited Attributes

is_analysis_pass

Check if the pass is an analysis pass.

If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass.

is_transformation_pass

Check if the pass is a transformation pass.

If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read).

Methods

run(dag)

Runs this analysis pass.

Parameters:

dag (DAGCircuit) – the DAG circuit representation of a FermionCircuit.

Return type:

None

Inherited Methods

execute(passmanager_ir, state, callback=None)

Execute optimization task for input Qiskit IR.

Parameters:

  • passmanager_ir (Any) – Qiskit IR to optimize.

  • state (PassManagerState) – State associated with workflow execution by the pass manager itself.

  • callback (Callable | None) – A callback function which is called per execution of optimization task.

Returns:

Optimized Qiskit IR and state of the workflow.

Return type:

tuple[Any, PassManagerState]

name()

Name of the pass.

Return type:

str

update_status(state, run_state)

Update workflow status.

Parameters:

  • state (PassManagerState) – Pass manager state to update.

  • run_state (RunState) – Completion status of current task.

Returns:

Updated pass manager state.

Return type:

PassManagerState