File: pgr_biconnectedComponents.rst

package info (click to toggle)
pgrouting 3.4.2-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 16,520 kB
  • sloc: sql: 38,763; cpp: 21,049; ansic: 13,171; perl: 1,781; sh: 804; xml: 182; makefile: 48
file content (150 lines) | stat: -rw-r--r-- 4,330 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
..
   ****************************************************************************
    pgRouting Manual
    Copyright(c) pgRouting Contributors

    This documentation is licensed under a Creative Commons Attribution-Share
    Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
   ****************************************************************************

|

* **Supported versions:**
  `Latest <https://docs.pgrouting.org/latest/en/pgr_biconnectedComponents.html>`__
  (`3.4 <https://docs.pgrouting.org/3.4/en/pgr_biconnectedComponents.html>`__)
  `3.3 <https://docs.pgrouting.org/3.3/en/pgr_biconnectedComponents.html>`__
  `3.2 <https://docs.pgrouting.org/3.2/en/pgr_biconnectedComponents.html>`__
  `3.1 <https://docs.pgrouting.org/3.1/en/pgr_biconnectedComponents.html>`__
  `3.0 <https://docs.pgrouting.org/3.0/en/pgr_biconnectedComponents.html>`__
* **Unsupported versions:**
  `2.6 <https://docs.pgrouting.org/2.6/en/pgr_biconnectedComponents.html>`__
  `2.5 <https://docs.pgrouting.org/2.5/en/pgr_biconnectedComponents.html>`__


``pgr_biconnectedComponents``
===============================================================================

``pgr_biconnectedComponents`` — Biconnected components of an undirected graph.

.. figure:: images/boost-inside.jpeg
   :target: https://www.boost.org/libs/graph/doc/biconnected_components.html

   Boost Graph Inside

.. rubric:: Availability

* Version 3.0.0

  * Return columns change:

    *  ``n_seq`` is removed
    * ``seq`` changed type to ``BIGINT``

  * **Official** function

* Version 2.5.0

  * New **experimental** function


Description
-------------------------------------------------------------------------------

The biconnected components of an undirected graph are the maximal subsets of
vertices such that the removal of a vertex from particular component will not
disconnect the component.
Unlike connected components, vertices may belong to multiple biconnected
components.
Vertices can be present in multiple biconnected components, but each edge can
only be contained in a single biconnected component.

**The main characteristics are:**

- Works for **undirected** graphs.
- Components are described by edges.
- The returned values are ordered:

  - ``component`` ascending.
  - ``edge`` ascending.

- Running time: :math:`O(V + E)`

.. index::
    single: biconnectedComponents

Signatures
-------------------------------------------------------------------------------

.. admonition:: \ \
   :class: signatures

   | pgr_biconnectedComponents(`Edges SQL`_)

   | RETURNS SET OF |result-component-E|
   | OR EMPTY SET

:Example: The biconnected components of the graph

.. literalinclude:: doc-pgr_biconnectedComponents.queries
   :start-after: -- q1
   :end-before: -- q2

.. figure:: /images/bcc_sampledata.png
   :scale: 25%

Parameters
-------------------------------------------------------------------------------

.. include:: pgRouting-concepts.rst
   :start-after: only_edge_param_start
   :end-before: only_edge_param_end

Inner Queries
-------------------------------------------------------------------------------

Edges SQL
...............................................................................

.. include:: pgRouting-concepts.rst
    :start-after: basic_edges_sql_start
    :end-before: basic_edges_sql_end

Result Columns
-------------------------------------------------------------------------------

Returns set of |result-component-E|

.. list-table::
   :width: 81
   :widths: auto
   :header-rows: 1

   * - Column
     - Type
     - Description
   * - ``seq``
     - ``BIGINT``
     - Sequential value starting from **1**.
   * - ``component``
     - ``BIGINT``
     - Component identifier.

       * Has the value of the minimum edge identifier in the component.
   * - ``edge``
     - ``BIGINT``
     - Identifier of the edge that belongs to the ``component``.

See Also
-------------------------------------------------------------------------------

* :doc:`components-family`
* The queries use the :doc:`sampledata` network.
* Boost: `Biconnected components
  <https://www.boost.org/libs/graph/doc/biconnected_components.html>`__
* wikipedia: `Biconnected component
  <https://en.wikipedia.org/wiki/Biconnected_component>`__

.. rubric:: Indices and tables

* :ref:`genindex`
* :ref:`search`