addon-utils 0.4.0 new API docs

docs/api/qiskit-addon-utils/0.3/_package.json

@@ -0,0 +1,4 @@
+{
+  "name": "qiskit-addon-utils",
+  "version": "0.3.1"
+}

docs/api/qiskit-addon-utils/0.3/_toc.json

@@ -0,0 +1,93 @@
+{
+  "title": "Qiskit addon utilities",
+  "children": [
+    {
+      "title": "API index",
+      "url": "/docs/api/qiskit-addon-utils/0.3"
+    },
+    {
+      "title": "Release notes",
+      "useDivider": true,
+      "url": "/docs/api/qiskit-addon-utils/release-notes"
+    },
+    {
+      "title": "qiskit_addon_utils.coloring",
+      "url": "/docs/api/qiskit-addon-utils/0.3/coloring",
+      "untranslatable": true
+    },
+    {
+      "title": "qiskit_addon_utils.exp_vals",
+      "url": "/docs/api/qiskit-addon-utils/0.3/exp-vals",
+      "untranslatable": true
+    },
+    {
+      "title": "qiskit_addon_utils.noise_management",
+      "url": "/docs/api/qiskit-addon-utils/0.3/noise-management",
+      "untranslatable": true
+    },
+    {
+      "title": "qiskit_addon_utils.noise_management.post_selection.transpiler.passes",
+      "untranslatable": true,
+      "children": [
+        {
+          "title": "Module overview",
+          "url": "/docs/api/qiskit-addon-utils/0.3/noise-management-post-selection-transpiler-passes"
+        },
+        {
+          "title": "AddPostSelectionMeasures",
+          "url": "/docs/api/qiskit-addon-utils/0.3/noise-management-post-selection-transpiler-passes-add-post-selection-measures",
+          "untranslatable": true
+        },
+        {
+          "title": "AddSpectatorMeasures",
+          "url": "/docs/api/qiskit-addon-utils/0.3/noise-management-post-selection-transpiler-passes-add-spectator-measures",
+          "untranslatable": true
+        },
+        {
+          "title": "XSlowGate",
+          "url": "/docs/api/qiskit-addon-utils/0.3/noise-management-post-selection-transpiler-passes-x-slow-gate",
+          "untranslatable": true
+        }
+      ]
+    },
+    {
+      "title": "qiskit_addon_utils.problem_generators",
+      "url": "/docs/api/qiskit-addon-utils/0.3/problem-generators",
+      "untranslatable": true
+    },
+    {
+      "title": "qiskit_addon_utils.slicing",
+      "url": "/docs/api/qiskit-addon-utils/0.3/slicing",
+      "untranslatable": true
+    },
+    {
+      "title": "qiskit_addon_utils.slicing.transpiler.passes",
+      "untranslatable": true,
+      "children": [
+        {
+          "title": "Module overview",
+          "url": "/docs/api/qiskit-addon-utils/0.3/slicing-transpiler-passes"
+        },
+        {
+          "title": "CollectOpColor",
+          "url": "/docs/api/qiskit-addon-utils/0.3/slicing-transpiler-passes-collect-op-color",
+          "untranslatable": true
+        },
+        {
+          "title": "CollectOpSize",
+          "url": "/docs/api/qiskit-addon-utils/0.3/slicing-transpiler-passes-collect-op-size",
+          "untranslatable": true
+        },
+        {
+          "title": "CollectOpType",
+          "url": "/docs/api/qiskit-addon-utils/0.3/slicing-transpiler-passes-collect-op-type",
+          "untranslatable": true
+        }
+      ]
+    }
+  ],
+  "collapsed": true,
+  "untranslatable": true,
+  "parentUrl": "/docs/addons/qiskit-addon-utils",
+  "parentLabel": "Qiskit addon utilities"
+}

docs/api/qiskit-addon-utils/0.3/coloring.mdx

@@ -0,0 +1,56 @@
+---
+title: coloring (v0.3)
+description: API reference for qiskit_addon_utils.coloring in qiskit-addon-utils v0.3
+in_page_toc_min_heading_level: 2
+python_api_type: module
+python_api_name: qiskit_addon_utils.coloring
+---
+
+<span id="module-qiskit_addon_utils.coloring" />
+
+<span id="coloring-qiskit-addon-utils-coloring" />
+
+# coloring
+
+`qiskit_addon_utils.coloring`
+
+Utility methods for coloring.
+
+### auto\_color\_edges
+
+<Function id="qiskit_addon_utils.coloring.auto_color_edges" github="https://github.com/Qiskit/qiskit-addon-utils/tree/stable/0.3/qiskit_addon_utils/coloring/automatic_coloring.py#L22-L42" signature="auto_color_edges(edges)">
+  Color the input edges of an undirected graph such that no two incident edges share a color.
+
+  **Parameters**
+
+  **edges** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*,* [*int*](https://docs.python.org/3/library/functions.html#int)*]]*) – The edges describing an undirected graph.
+
+  **Returns**
+
+  A dictionary mapping each edge to an integer representation of a color.
+
+  **Return type**
+
+  [dict](https://docs.python.org/3/library/stdtypes.html#dict)\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[int](https://docs.python.org/3/library/functions.html#int), [int](https://docs.python.org/3/library/functions.html#int)], [int](https://docs.python.org/3/library/functions.html#int)]
+</Function>
+
+### is\_valid\_edge\_coloring
+
+<Function id="qiskit_addon_utils.coloring.is_valid_edge_coloring" github="https://github.com/Qiskit/qiskit-addon-utils/tree/stable/0.3/qiskit_addon_utils/coloring/validation.py#L20-L38" signature="is_valid_edge_coloring(coloring)">
+  Check whether an edge coloring scheme is valid.
+
+  An edge coloring is valid if no two edges of the same color share a node.
+
+  **Parameters**
+
+  **coloring** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict)*\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*,* [*int*](https://docs.python.org/3/library/functions.html#int)*],* [*int*](https://docs.python.org/3/library/functions.html#int)*]*) – A mapping from edges to integer representations of colors.
+
+  **Returns**
+
+  A boolean indicating whether the input coloring is valid.
+
+  **Return type**
+
+  [bool](https://docs.python.org/3/library/functions.html#bool)
+</Function>
+