Skip to content

Deprecating pgr AlphaShape #2832

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cvvergara merged 2 commits into from
Apr 8, 2025
Merged

Deprecating pgr AlphaShape #2832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f05142
Deprecating pgr AlphaShape
cvvergara Apr 8, 2025
690e82c
Update locale: commit 7f05142aa3
github-actions[bot] Apr 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ milestone for 3.8.0

**Deprecation of functions.**

* [#2749](https://github.com/pgRouting/pgrouting/issues/2749):
pgr_alphaShape
* [#2754](https://github.com/pgRouting/pgrouting/issues/2754):
pgr_analyzeOneWay
* [#2753](https://github.com/pgRouting/pgrouting/issues/2753):
Expand Down
2 changes: 1 addition & 1 deletion doc/_static/page_history.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ var filesArr = [
]),
new createInfo('pgr_alphaShape', '2.0', [
{ v: '2.1', n: 'src/driving_distance/doc/dd_alphashape'},
{ v: '2.3', n: 'src/alpha_shape/doc/pgr_alphaShape'}
{ v: '2.3', n: 'src/alpha_shape/doc/pgr_alphaShape'}, 3.8
]),

];
Expand Down
9 changes: 8 additions & 1 deletion doc/alpha_shape/pgr_alphaShape.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@

.. rubric:: Availability

* Version 3.8.0

* Deprecated function.

* Version 3.0.0

* Breaking change on signature
Expand All @@ -39,7 +43,10 @@
* New official function.
* Renamed from version 1.x

.. rubric:: Support

.. include:: migration.rst
:start-after: migrate_pgr_alphaShape_start
:end-before: migrate_pgr_alphaShape_end

Description
-------------------------------------------------------------------------------
Expand Down
1 change: 0 additions & 1 deletion doc/driving_distance/pgr_drivingDistance.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,6 @@ Additional Examples
See Also
-------------------------------------------------------------------------------

* :doc:`pgr_alphaShape` - Alpha shape computation
* :doc:`sampledata`

.. rubric:: Indices and tables
Expand Down
30 changes: 30 additions & 0 deletions doc/src/migration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,36 @@ Results can be different because of the changes.
.. contents:: Contents
:depth: 2

.. migrate_pgr_alphaShape_start

Migration of ``pgr_alphaShape``
-------------------------------------------------------------------------------

Starting from `v3.8.0 <https://docs.pgrouting.org/3.8/en/migration.html>`__

**Before Deprecation:** The following was calculated:

* An alphaShape was calculated

**After Deprecation:**

PostGIS has two ways of generating alphaShape.

If you have SFCGAL, which you can install using

::

CREATE EXTENSION postgis_sfcgal

* Since PostGIS 3.5+ use `CG_AlphaShape <https://postgis.net/docs/CG_AlphaShape.html>`__
* For PostGIS 3.5+ use the old name ``ST_AlphaShape``

Other PostGIS options are
* `ST_ConvexHull <https://postgis.net/docs/ST_ConvexHull.html>`__
* `ST_ConcaveHull <https://postgis.net/docs/ST_ConcaveHull.html>`__

.. migrate_pgr_alphaShape_end

.. migrate_pgr_createTopology_start

Migration of ``pgr_createTopology``
Expand Down
2 changes: 2 additions & 0 deletions doc/src/release_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ milestone for 3.8.0

.. rubric:: Deprecation of functions.

* `#2749 <https://github.com/pgRouting/pgrouting/issues/2749>`__:
pgr_alphaShape
* `#2754 <https://github.com/pgRouting/pgrouting/issues/2754>`__:
pgr_analyzeOneWay
* `#2753 <https://github.com/pgRouting/pgrouting/issues/2753>`__:
Expand Down
1 change: 0 additions & 1 deletion doc/withPoints/pgr_withPointsDD.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,6 @@ See Also
-------------------------------------------------------------------------------

* :doc:`pgr_drivingDistance`
* :doc:`pgr_alphaShape`
* :doc:`sampledata`

.. rubric:: Indices and tables
Expand Down
1 change: 1 addition & 0 deletions docqueries/alpha_shape/alphashape.result
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ SET
/* -- q1 */
SELECT ST_Area(pgr_alphaShape((SELECT ST_Collect(geom)
FROM vertices), 1.5));
WARNING: pgr_alphashape(geometry,double precision) deprecated function on v3.8.0
st_area
---------
9.75
Expand Down
59 changes: 45 additions & 14 deletions locale/en/LC_MESSAGES/pgrouting_doc_strings.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: pgRouting v3.8\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-04-08 17:43+0000\n"
"POT-Creation-Date: 2025-04-08 19:58+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
Expand Down Expand Up @@ -3959,6 +3959,11 @@ msgstr ""
msgid "Deprecation of functions."
msgstr ""

msgid ""
"`#2749 <https://github.com/pgRouting/pgrouting/issues/2749>`__: "
"pgr_alphaShape"
msgstr ""

msgid ""
"`#2754 <https://github.com/pgRouting/pgrouting/issues/2754>`__: "
"pgr_analyzeOneWay"
Expand Down Expand Up @@ -4057,7 +4062,7 @@ msgstr ""
msgid "All deprecated functions will be removed on next major version 4.0.0"
msgstr ""

msgid "Migration of ``pgr_createTopology``"
msgid "Migration of ``pgr_alphaShape``"
msgstr ""

msgid ""
Expand All @@ -4068,6 +4073,35 @@ msgstr ""
msgid "**Before Deprecation:** The following was calculated:"
msgstr ""

msgid "An alphaShape was calculated"
msgstr ""

msgid "**After Deprecation:**"
msgstr ""

msgid "PostGIS has two ways of generating alphaShape."
msgstr ""

msgid "If you have SFCGAL, which you can install using"
msgstr ""

msgid ""
"Since PostGIS 3.5+ use `CG_AlphaShape "
"<https://postgis.net/docs/CG_AlphaShape.html>`__"
msgstr ""

msgid "For PostGIS 3.5+ use the old name ``ST_AlphaShape``"
msgstr ""

msgid ""
"Other PostGIS options are * `ST_ConvexHull "
"<https://postgis.net/docs/ST_ConvexHull.html>`__ * `ST_ConcaveHull "
"<https://postgis.net/docs/ST_ConcaveHull.html>`__"
msgstr ""

msgid "Migration of ``pgr_createTopology``"
msgstr ""

msgid "A table with `<edges>_vertices_pgr` was created."
msgstr ""

Expand Down Expand Up @@ -7828,6 +7862,12 @@ msgstr ""
msgid "``pgr_alphaShape`` — Polygon part of an alpha shape."
msgstr ""

msgid "Version 3.8.0"
msgstr ""

msgid "Deprecated function."
msgstr ""

msgid "Breaking change on signature"
msgstr ""

Expand All @@ -7849,9 +7889,6 @@ msgstr ""
msgid "Renamed from version 1.x"
msgstr ""

msgid "Support"
msgstr ""

msgid "Returns the polygon part of an alpha shape."
msgstr ""

Expand Down Expand Up @@ -7928,12 +7965,6 @@ msgstr ""
msgid "``pgr_analyzeGraph`` — Analyzes the network topology."
msgstr ""

msgid "Version 3.8.0"
msgstr ""

msgid "Deprecated function."
msgstr ""

msgid "The function returns:"
msgstr ""

Expand Down Expand Up @@ -15123,9 +15154,6 @@ msgid ""
"driving side, with details."
msgstr ""

msgid ":doc:`pgr_alphaShape`"
msgstr ""

msgid "``pgr_withPointsKSP`` - Proposed"
msgstr ""

Expand Down Expand Up @@ -15485,6 +15513,9 @@ msgid ""
"<https://github.com/pgRouting/pgrouting/issues?utf8=%E2%9C%93&q=milestone%3A%22Release%203.7.0%22>`__"
msgstr ""

msgid "Support"
msgstr ""

msgid ""
"`#2656 <https://github.com/pgRouting/pgrouting/pull/2656>`__ Stop support"
" of PostgreSQL12 on pgrouting v3.7"
Expand Down
52 changes: 38 additions & 14 deletions locale/pot/pgrouting_doc_strings.pot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: pgRouting v3.8\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-04-08 17:43+0000\n"
"POT-Creation-Date: 2025-04-08 19:58+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
Expand Down Expand Up @@ -3550,6 +3550,9 @@ msgstr ""
msgid "Deprecation of functions."
msgstr ""

msgid "`#2749 <https://github.com/pgRouting/pgrouting/issues/2749>`__: pgr_alphaShape"
msgstr ""

msgid "`#2754 <https://github.com/pgRouting/pgrouting/issues/2754>`__: pgr_analyzeOneWay"
msgstr ""

Expand Down Expand Up @@ -3625,7 +3628,7 @@ msgstr ""
msgid "All deprecated functions will be removed on next major version 4.0.0"
msgstr ""

msgid "Migration of ``pgr_createTopology``"
msgid "Migration of ``pgr_alphaShape``"
msgstr ""

msgid "Starting from `v3.8.0 <https://docs.pgrouting.org/3.8/en/migration.html>`__"
Expand All @@ -3634,6 +3637,30 @@ msgstr ""
msgid "**Before Deprecation:** The following was calculated:"
msgstr ""

msgid "An alphaShape was calculated"
msgstr ""

msgid "**After Deprecation:**"
msgstr ""

msgid "PostGIS has two ways of generating alphaShape."
msgstr ""

msgid "If you have SFCGAL, which you can install using"
msgstr ""

msgid "Since PostGIS 3.5+ use `CG_AlphaShape <https://postgis.net/docs/CG_AlphaShape.html>`__"
msgstr ""

msgid "For PostGIS 3.5+ use the old name ``ST_AlphaShape``"
msgstr ""

msgid "Other PostGIS options are * `ST_ConvexHull <https://postgis.net/docs/ST_ConvexHull.html>`__ * `ST_ConcaveHull <https://postgis.net/docs/ST_ConcaveHull.html>`__"
msgstr ""

msgid "Migration of ``pgr_createTopology``"
msgstr ""

msgid "A table with `<edges>_vertices_pgr` was created."
msgstr ""

Expand Down Expand Up @@ -6799,6 +6826,12 @@ msgstr ""
msgid "``pgr_alphaShape`` — Polygon part of an alpha shape."
msgstr ""

msgid "Version 3.8.0"
msgstr ""

msgid "Deprecated function."
msgstr ""

msgid "Breaking change on signature"
msgstr ""

Expand All @@ -6820,9 +6853,6 @@ msgstr ""
msgid "Renamed from version 1.x"
msgstr ""

msgid "Support"
msgstr ""

msgid "Returns the polygon part of an alpha shape."
msgstr ""

Expand Down Expand Up @@ -6895,12 +6925,6 @@ msgstr ""
msgid "``pgr_analyzeGraph`` — Analyzes the network topology."
msgstr ""

msgid "Version 3.8.0"
msgstr ""

msgid "Deprecated function."
msgstr ""

msgid "The function returns:"
msgstr ""

Expand Down Expand Up @@ -12769,9 +12793,6 @@ msgstr ""
msgid "From point :math:`1` within a distance of :math:`3.3`, does not matter driving side, with details."
msgstr ""

msgid ":doc:`pgr_alphaShape`"
msgstr ""

msgid "``pgr_withPointsKSP`` - Proposed"
msgstr ""

Expand Down Expand Up @@ -13033,6 +13054,9 @@ msgstr ""
msgid "To see all issues & pull requests closed by this release see the `Git closed milestone for 3.7.0 <https://github.com/pgRouting/pgrouting/issues?utf8=%E2%9C%93&q=milestone%3A%22Release%203.7.0%22>`__"
msgstr ""

msgid "Support"
msgstr ""

msgid "`#2656 <https://github.com/pgRouting/pgrouting/pull/2656>`__ Stop support of PostgreSQL12 on pgrouting v3.7"
msgstr ""

Expand Down
10 changes: 2 additions & 8 deletions sql/alpha_shape/alphaShape.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ geom geometry;
delauny_query TEXT;

BEGIN
RAISE WARNING 'pgr_alphashape(geometry,double precision) deprecated function on v3.8.0';
delauny_query = format($$
WITH
original AS (
Expand Down Expand Up @@ -83,11 +84,4 @@ LANGUAGE plpgsql VOLATILE STRICT
COST 100;

COMMENT ON FUNCTION pgr_alphashape(geometry, FLOAT)
IS 'pgr_alphaShape
- Parameters
- An SQL with columns: geom
- Optional Parameters
- alpha := 0
- Documentation:
- ${PROJECT_DOC_LINK}/pgr_alphaShape.html
';
IS 'pgr_alphaShape deprecated function on v3.8.0';