96 lines
5.7 KiB
Plaintext
96 lines
5.7 KiB
Plaintext
---
|
||
title: CSPLayout
|
||
description: API reference for qiskit.transpiler.passes.CSPLayout
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.transpiler.passes.CSPLayout
|
||
---
|
||
|
||
# qiskit.transpiler.passes.CSPLayout
|
||
|
||
<Class id="qiskit.transpiler.passes.CSPLayout" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/transpiler/passes/layout/csp_layout.py" signature="CSPLayout(*args, **kwargs)" modifiers="class">
|
||
If possible, chooses a Layout as a CSP, using backtracking.
|
||
|
||
If possible, chooses a Layout as a CSP, using backtracking.
|
||
|
||
If not possible, does not set the layout property. In all the cases, the property CSPLayout\_stop\_reason will be added with one of the following values:
|
||
|
||
* solution found: If a perfect layout was found.
|
||
* nonexistent solution: If no perfect layout was found and every combination was checked.
|
||
* call limit reached: If no perfect layout was found and the call limit was reached.
|
||
* time limit reached: If no perfect layout was found and the time limit was reached.
|
||
|
||
**Parameters**
|
||
|
||
* **coupling\_map** (*Coupling*) – Directed graph representing a coupling map.
|
||
* **strict\_direction** (*bool*) – If True, considers the direction of the coupling map. Default is False.
|
||
* **seed** (*int*) – Sets the seed of the PRNG.
|
||
* **call\_limit** (*int*) – Amount of times that `constraint.RecursiveBacktrackingSolver.recursiveBacktracking` will be called. None means no call limit. Default: 1000.
|
||
* **time\_limit** (*int*) – Amount of seconds that the pass will try to find a solution. None means no time limit. Default: 10 seconds.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.transpiler.passes.CSPLayout.__init__" signature="__init__(coupling_map, strict_direction=False, seed=None, call_limit=1000, time_limit=10)">
|
||
If possible, chooses a Layout as a CSP, using backtracking.
|
||
|
||
If not possible, does not set the layout property. In all the cases, the property CSPLayout\_stop\_reason will be added with one of the following values:
|
||
|
||
* solution found: If a perfect layout was found.
|
||
* nonexistent solution: If no perfect layout was found and every combination was checked.
|
||
* call limit reached: If no perfect layout was found and the call limit was reached.
|
||
* time limit reached: If no perfect layout was found and the time limit was reached.
|
||
|
||
**Parameters**
|
||
|
||
* **coupling\_map** (*Coupling*) – Directed graph representing a coupling map.
|
||
* **strict\_direction** (*bool*) – If True, considers the direction of the coupling map. Default is False.
|
||
* **seed** (*int*) – Sets the seed of the PRNG.
|
||
* **call\_limit** (*int*) – Amount of times that `constraint.RecursiveBacktrackingSolver.recursiveBacktracking` will be called. None means no call limit. Default: 1000.
|
||
* **time\_limit** (*int*) – Amount of seconds that the pass will try to find a solution. None means no time limit. Default: 10 seconds.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
|
||
| [`__init__`](#qiskit.transpiler.passes.CSPLayout.__init__ "qiskit.transpiler.passes.CSPLayout.__init__")(coupling\_map\[, strict\_direction, …]) | If possible, chooses a Layout as a CSP, using backtracking. |
|
||
| [`name`](#qiskit.transpiler.passes.CSPLayout.name "qiskit.transpiler.passes.CSPLayout.name")() | Return the name of the pass. |
|
||
| [`run`](#qiskit.transpiler.passes.CSPLayout.run "qiskit.transpiler.passes.CSPLayout.run")(dag) | run the layout method |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
|
||
| [`is_analysis_pass`](#qiskit.transpiler.passes.CSPLayout.is_analysis_pass "qiskit.transpiler.passes.CSPLayout.is_analysis_pass") | Check if the pass is an analysis pass. |
|
||
| [`is_transformation_pass`](#qiskit.transpiler.passes.CSPLayout.is_transformation_pass "qiskit.transpiler.passes.CSPLayout.is_transformation_pass") | Check if the pass is a transformation pass. |
|
||
|
||
### is\_analysis\_pass
|
||
|
||
<Attribute id="qiskit.transpiler.passes.CSPLayout.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.
|
||
</Attribute>
|
||
|
||
### is\_transformation\_pass
|
||
|
||
<Attribute id="qiskit.transpiler.passes.CSPLayout.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).
|
||
</Attribute>
|
||
|
||
### name
|
||
|
||
<Function id="qiskit.transpiler.passes.CSPLayout.name" signature="name()">
|
||
Return the name of the pass.
|
||
</Function>
|
||
|
||
### run
|
||
|
||
<Function id="qiskit.transpiler.passes.CSPLayout.run" signature="run(dag)">
|
||
run the layout method
|
||
</Function>
|
||
</Class>
|
||
|